Skip to content

Commit e8533dd

Browse files
authored
ros_gz documentation updates (gazebosim#508)
* Documentation updates including updated bridge parameters, links to other ros_gz tutorials and note about the functionality only available in Rolling. Signed-off-by: Carlos Agüero <[email protected]>
1 parent 92f322a commit e8533dd

File tree

4 files changed

+25
-11
lines changed

4 files changed

+25
-11
lines changed

harmonic/ros2_integration.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ within this tag. Here's an example:
8080

8181
```xml
8282
<launch>
83-
<arg name="name" default="ros_gz_bridge" />
84-
<arg name="config_file" default="" />
83+
<arg name="bridge_name" />
84+
<arg name="config_file" />
8585
<arg name="container_name" default="ros_gz_container" />
8686
<arg name="namespace" default="" />
8787
<arg name="use_composition" default="True" />
8888
<arg name="use_respawn" default="False" />
8989
<arg name="log_level" default="info" />
90-
<ros_gz_bridge
91-
name="$(var name)"
90+
<ros_gz_bridge
91+
bridge_name="$(var bridge_name)"
9292
config_file="$(var config_file)"
9393
container_name="$(var container_name)"
9494
namespace="$(var namespace)"
@@ -97,11 +97,12 @@ within this tag. Here's an example:
9797
log_level="$(var log_level)">
9898
</ros_gz_bridge>
9999
</launch>
100+
100101
```
101102

102103
In this case the `<ros_gz_bridge>` parameters are read from the command line.
103104
That's an option but not strictly necessary as you could decide to hardcode some
104-
of the values.
105+
of the values or not even use all the parameters.
105106

106107
## Publish key strokes to ROS
107108

harmonic/ros2_launch_gazebo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ within this tag. Here's an example for launching Gazebo server:
4949

5050
In this case the `<gz_server>` parameters are read from the command line. That's
5151
an option but not strictly necessary as you could decide to hardcode some of the
52-
values.
52+
values or not even use all the parameters.
5353

5454
### Python
5555
Python launch files provide more low-level customization and logic compared to XML launch files.

harmonic/ros2_overview.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ Please follow the [Install Gazebo and ROS document](ros_installation)
2626
before starting this tutorial. A working installation of ROS 2 and Gazebo is
2727
required to go further.
2828

29+
Important: Most of this functionality is only available in ROS 2 Rolling.
30+
We'll backport it to ROS 2 Jazzy soon.
31+
2932
## Composition
3033

3134
If you inspect the parameters of the launch files mentioned in the next
@@ -41,3 +44,13 @@ launched with the `container_node_name` parameter matching the container name
4144
including Gazebo and the bridge.
4245

4346
You can learn more about ROS composition in [this tutorial](https://docs.ros.org/en/galactic/Tutorials/Intermediate/Composition.html).
47+
48+
## What's next?
49+
50+
Here are the next follow-up tutorials that you can check to learn more about
51+
Gazebo/ROS integration.
52+
53+
* [How to launch Gazebo from ROS 2](ros2_launch_gazebo).
54+
* [How to use ROS 2 to interact with Gazebo](ros2_integration).
55+
* [Example of using ROS 2 to load a model and interact with it in Gazebo](ros2_interop).
56+
* [How to spawn a Gazebo model from ROS 2](ros2_spawn_model).

harmonic/ros2_spawn_model.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ within this tag. Here's an example:
3030
<launch>
3131
<arg name="world" default="" />
3232
<arg name="file" default="" />
33-
<arg name="xml_string" default="" />
33+
<arg name="model_string" default="" />
3434
<arg name="topic" default="" />
35-
<arg name="name" default="" />
35+
<arg name="entity_name" default="" />
3636
<arg name="allow_renaming" default="False" />
3737
<arg name="x" default="" />
3838
<arg name="y" default="" />
@@ -43,9 +43,9 @@ within this tag. Here's an example:
4343
<gz_spawn_model
4444
world="$(var world)"
4545
file="$(var file)"
46-
xml_string="$(var xml_string)"
46+
model_string="$(var model_string)"
4747
topic="$(var topic)"
48-
name="$(var name)"
48+
entity_name="$(var entity_name)"
4949
allow_renaming="$(var allow_renaming)"
5050
x="$(var x)"
5151
y="$(var y)"
@@ -59,4 +59,4 @@ within this tag. Here's an example:
5959

6060
In this case the `<gz_spawn_model>` parameters are read from the command line.
6161
That's an option but not strictly necessary as you could decide to hardcode some
62-
of the values.
62+
of the values or not even use all of the parameters.

0 commit comments

Comments
 (0)