Skip to content

Commit b08ea89

Browse files
Add documentation for new automatic discovery fields
Document changes from - clearpathrobotics/clearpath_common#262 - clearpathrobotics/clearpath_config#191
1 parent 0fe8cd7 commit b08ea89

File tree

1 file changed

+7
-1
lines changed
  • docs_versioned_docs/version-ros2jazzy/ros/config/yaml

1 file changed

+7
-1
lines changed

docs_versioned_docs/version-ros2jazzy/ros/config/yaml/system.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,23 @@ Currently only the Husky A200 can use `rmw_zenoh_cpp`. Attempting to use Zenoh o
6767

6868
| Key | Value / Datatype | Description |
6969
|:---:| :--------------: | ----------- |
70-
| **implementation** | `rmw_fastrtps_cpp` | Declares the RMW Implementation to use. Currently only supports `rmw_fastrtps_cpp` and `rmw_zenoh_cpp`. |
70+
| **implementation** | string | Declares the RMW Implementation to use. Currently only supports `rmw_fastrtps_cpp` and `rmw_zenoh_cpp`. |
7171
| **discovery** | `simple` or `server` | Select `simple` for simple discovery and `server` for discovery server. (Defaults to `simple`. Ignored if `implementation` is not `rmw_fastrtps_cpp`.) |
7272
| **profile** | string | Advanced feature, allows an optional custom profile to be provided - RMW Implementation / vendor specific. |
7373
| **servers** | list | Provides a list of all discovery servers in the system and whether or not the robot should connect to them. Ignored if `implementation` is not `rmw_fastrtps_cpp`.|
74+
| **automatic_discovery_range** | string | Sets the value for the `ROS_AUTOMATIC_DISCOVERY_RANGE` environment variable. Must be one of `subnet`, `localhost`, `system_default`, or `off`. |
75+
| **static_peers** | list | List of IP addresses or hostnames that ROS should discover nodes on. Sets the value of the `ROS_STATIC_PEERS` environment variable. |
7476

7577
For example:
7678

7779
```yaml
7880
middleware:
7981
implementation: rmw_fastrtps_cpp
8082
discovery: simple
83+
automatic_discovery_range: subnet
84+
static_peers:
85+
- 192.168.131.1
86+
- 192.168.131.2
8187
profile: path/to/profile.xml
8288
servers: # This section is described further below
8389
- hostname: cpr-a200-0000

0 commit comments

Comments
 (0)