Skip to content

Commit 62539cf

Browse files
cagueroazeey
andauthored
Tweak ros2_overview tutorial. (gazebosim#531)
* Fix some issues related with composition in the ros2_overview tutorial. Signed-off-by: Carlos Agüero <[email protected]> Co-authored-by: Addisu Z. Taddese <[email protected]>
1 parent 2006f68 commit 62539cf

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

harmonic/ros2_overview.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ ROS container. When this happens, all the nodes within the same ROS container
3939
share the same process and can leverage intraprocess communication.
4040

4141
The parameter `create_own_container` only makes sense when `use_composition` is
42-
set to `True`. This parameter lets you control whether your start a ROS
42+
set to `True`. This parameter lets you control whether you start a ROS
4343
container for your composable nodes or you defer to an external ROS container.
4444

4545
Our recommendation is to always set the `use_composition` parameter to `True`
@@ -57,12 +57,16 @@ ROS nodes will be intraprocess.
5757

5858
This figure illustrates the concept of composition. The left diagram captures
5959
the idea of not using composition. All the three example nodes are standalone
60-
nodes, and they can talk via interprocess communication. The center diagram
61-
represents the scenario where we use composition and we start our own container
62-
from our own launch file. All communication is intraprocess here. The right
63-
diagram is still using composition but the launch file doesn't start the
64-
container directly. This setup by itself will not work until you start an
65-
external ROS container (manually or via a separate launch file).
60+
nodes, and they can talk via interprocess communication using the bridge.
61+
The center diagram represents the scenario where we can use composition with a ROS container created by a `ros_gz` launch file containing both Gazebo and the bridge, and an additional
62+
consumer node outside that we cannot control. All communication between Gazebo
63+
and the bridge is intraprocess and interprocess between the external consumer
64+
node and the bridge.
65+
The diagram on the right side is using composition across all nodes but the
66+
`ros_gz` launch file doesn't start its own container directly. This setup by itself will
67+
not work until you start an external ROS container (manually or via a separate launch file). In this diagram, the external ROS consumer node starts the
68+
container. We're using the Nav2 logo as an example of external ROS 2 consumer
69+
node.
6670

6771
You can learn more about ROS composition in [this tutorial](https://docs.ros.org/en/jazzy/Tutorials/Intermediate/Composition.html).
6872

images/composition_options.png

23.4 KB
Loading

0 commit comments

Comments
 (0)