Skip to content

Commit 7302544

Browse files
author
Murilo Marinho
committed
[gazebo] Added information about some vendor packages as examples.
1 parent 608c2a8 commit 7302544

File tree

1 file changed

+64
-2
lines changed

1 file changed

+64
-2
lines changed

docs/source/gazebo/installation.rst

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,70 @@ We can start by choosing the file :file:`ackermann_steering.sdf`
9191
.. _gnupg: https://gnupg.org/download/
9292

9393

94-
:program:`Gazebo` and :program:`rviz2`
95-
--------------------------------------
94+
:program:`Gazebo` and :program:`ROS2` structure
95+
-----------------------------------------------
96+
97+
A :program:`Gazebo`\-related development in :program:`ROS2` will generally have four packages for each robot or system.
98+
One example is shown below, in the official https://github.com/gazebosim/ros_gz_project_template.
99+
100+
.. code-block::
101+
:emphasize-lines: 2,5,10,15
102+
103+
.
104+
|-- ros_gz_example_application
105+
| |-- CMakeLists.txt
106+
| `-- package.xml
107+
|-- ros_gz_example_bringup
108+
| |-- CMakeLists.txt
109+
| |-- config
110+
| |-- launch
111+
| `-- package.xml
112+
|-- ros_gz_example_description
113+
| |-- CMakeLists.txt
114+
| |-- hooks
115+
| |-- models
116+
| `-- package.xml
117+
`-- ros_gz_example_gazebo
118+
|-- CMakeLists.txt
119+
|-- README.md
120+
|-- hooks
121+
|-- include
122+
|-- package.xml
123+
|-- src
124+
`-- worlds
125+
126+
This means that if you were to develop packages for a robot called ``beautiful_bot`` you'd be expected to create the four packages as follows.
127+
128+
.. code-block::
129+
130+
.
131+
|-- beautiful_bot_application
132+
|-- beautiful_bot_bringup
133+
|-- beautiful_bot_description
134+
`-- beautiful_bot_gazebo
135+
136+
According to the developers `here <https://gazebosim.org/docs/harmonic/ros_gz_project_template_guide/>`_ and `here <https://github.com/gazebosim/docs/issues/580>`_, our hypotetical packages would have the following roles.
137+
138+
================================= ==================================
139+
:file:`beautiful_bot_application` :program:`ROS2`\-specific code.
140+
:file:`beautiful_bot_bringup` Project's main launch files and robot configuration.
141+
:file:`beautiful_bot_description` The :file:`.sdf` files for robots and other simulation things.
142+
:file:`beautiful_bot_gazebo` World :file:`.sdf` file and :Program:`Gazebo` configuration.
143+
================================= ==================================
144+
145+
If you explore the :program:`ROS` packages made avialable by vendors, you will notice this structure or part of it. Some examples
146+
147+
- `Denso <https://github.com/DENSORobot/denso_robot_ros2>`_
148+
- `Kawasaki <https://github.com/Kawasaki-Robotics/khi_robot>`_
149+
- `Franka <https://github.com/frankarobotics/franka_ros2>`_
150+
151+
.. important::
152+
153+
Owing to the lifecycle of products and resource allocation (we also suffer from this at Universities), you can always expect the official packages for :program:`ROS2` and
154+
:program:`Gazebo` shipped officially by vendors to considerably lag behind.
155+
156+
:program:`Gazebo` and :program:`ROS2` example
157+
---------------------------------------------
96158

97159
.. note::
98160

0 commit comments

Comments
 (0)