You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs_versioned_docs/version-ros2jazzy/ros/config/yaml/platform/extras.mdx
+48-7Lines changed: 48 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,12 @@ Despite all current customization options, we still would like our users to be a
12
12
Extras have the following entries:
13
13
14
14
-**urdf:**
15
-
-**package:** name of the ROS 2 package that contains the extras URDF (optional).
16
15
-**path:** relative path within the package or absolute path to robot extras URDF
17
-
-**launch:**
18
-
-**package:**name of the ROS 2 package that contains the extras launch file (optional).
16
+
-**package:** name of the ROS 2 package that contains the extras URDF (optional)
17
+
-**launch:**a list of objects containing
19
18
-**path:** relative path within the package or absolute path to robot extras launch file
19
+
-**package:** name of the ROS 2 package that contains the extras launch file (optional)
20
+
-**args:** launch arguments to pass to the launch file when it is started (optional)
20
21
-**ros_parameters:** in YAML to pass in parameters to platform nodes. This is useful to change parameters such as the robot's velocity and acceleration.
21
22
22
23
```yaml
@@ -25,8 +26,8 @@ extras:
25
26
package: package_name
26
27
path: relative/path/to/urdf/in/package.urdf.xacro # or can contain /absolute/path/to/urdf.urdf.xacro
@@ -132,8 +133,48 @@ The robot's URDF will now include the antenna, as shown in the image below:
132
133
133
134
## Extras Launch
134
135
135
-
If an `extras.launch` is specified, it is launched as part of the `clearpath-platform-extras.service` job. To check the status
136
-
of the extras launch, run
136
+
The launch files specified in this section are started as part of the `clearpath-platform-extras.service` job. Each launch file can be specified either as an absolute path or as a relative path within a package. Additionally, launch arguments may be specified with the `args` field:
137
+
138
+
```yaml
139
+
platform:
140
+
extras:
141
+
launch:
142
+
- path: /absolute/path/to/some/file.launch.py
143
+
- path: launch/my_launch_file.launch.py
144
+
package: my_package
145
+
- path: launch/my_launch_with_args.launch.py
146
+
package: my_other_package
147
+
args:
148
+
spam: eggs
149
+
foo: bar
150
+
```
151
+
152
+
The three launches above are equivalent to the following command-line invocations:
In `2.7.x` and earlier `extras.launch` only supported a single launch file:
165
+
166
+
```yaml
167
+
platform:
168
+
extras:
169
+
path: launch/my_launch_file.launch.py
170
+
package: my_package
171
+
```
172
+
173
+
If your `robot.yaml` file contains the old format you will see a deprecation notice. We recommend updating your `robot.yaml` to the new format by converting `extras.launch` to a list.
174
+
175
+
:::
176
+
177
+
To check the status of the extras launch, run
137
178
138
179
```bash
139
180
systemctl status clearpath-platform-extras.service
Copy file name to clipboardExpand all lines: docs_versioned_docs/version-ros2jazzy/ros/config/yaml/system.mdx
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,6 +121,30 @@ servers:
121
121
enabled: True
122
122
```
123
123
124
+
## Bash Environment
125
+
126
+
Some ROS nodes may expect additional environment variables to be set. Instead of setting these system-wide, you may instead use the `system.bash` section to define additional environment variables or source additional bash files _before_ any ROS nodes are started by the Clearpath systemd jobs.
127
+
128
+
```yaml
129
+
system:
130
+
bash:
131
+
source:
132
+
- /path/to/some_config.bash
133
+
- /path/to/another_setup.bash
134
+
env:
135
+
ADDITIONAL_ENVAR: spam
136
+
ANOTHER_ENVAR: eggs
137
+
```
138
+
139
+
This example will include the following in the generated `setup.bash` file used by all Clearpath systemd jobs:
0 commit comments