rcl/rcl_yaml_param_parser/README.md
brawner 728b8b89bd
Quality Declarations for rcl_action, rcl_lifecycle, yaml_parser (#641)
* READMEs and Quality Declarations for rcl_action, rcl_lifecycle, yaml_parser

Signed-off-by: Stephen Brawner <brawner@gmail.com>

* PR Fixup

Signed-off-by: Stephen Brawner <brawner@gmail.com>

* PR Fixup

Signed-off-by: Stephen Brawner <brawner@gmail.com>

* PR Fixup

Signed-off-by: Stephen Brawner <brawner@gmail.com>
2020-05-07 09:35:41 +02:00

31 lines
924 B
Markdown

**ROS2 rcl YAML paramter parser**
Parse a YAML parameter file and populate the C data structure
The data structure params_st will then be used during node initialization
YAML parameter file should follow the yaml syntax shown below
NOTE: It only supports canonical int and float types
```
<node_namespace_string>: # optional
<node1_name>:
ros__parameters:
<field_name>: <field_value>
<parameter_namespace_string>: # optional
<field1_name>: <field1_value>
<field2_name>: <field2_value>
<node2_name>:
ros__parameters:
<field_name>: <field_value>
<parameter_namespace_string>: # optional
<field1_name>: <field1_value>
<field2_name>: <field2_value>
```
This package depends on C libyaml
## Quality Declaration
This package claims to be in the **Quality Level 4** category, see the [Quality Declaration](./QUALITY_DECLARATION.md) for more details.