Update parameters section (#355) (#356)

Co-authored-by: Alejandro Hernández Cordero <[email protected]> (cherry picked from commit 1dc523b) Co-authored-by: Christoph Fröhlich <[email protected]>
ros-controls · Jul 9, 2024 · 2b96573 · 2b96573
1 parent 6183cdf
commit 2b96573
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/doc/index.rst b/doc/index.rst
@@ -212,8 +212,23 @@ The *gazebo_ros2_control* ``<plugin>`` tag also has the following optional child
 
 * ``<robot_param>``: The location of the ``robot_description`` (URDF) on the parameter server, defaults to ``robot_description``
 * ``<robot_param_node>``: Name of the node where the ``robot_param`` is located, defaults to ``robot_state_publisher``
-* ``<parameters>``: YAML file with the configuration of the controllers
 * ``<hold_joints>``: if set to true (default), it will hold the joints' position if their interface was not claimed, e.g., the controller hasn't been activated yet.
+* ``<parameters>``: A YAML file with the configuration of the controllers. This element can be given multiple times to load multiple files.
+* ``<controller_manager_name>``: Set controller manager name (default: ``controller_manager``)
+
+Additionally, one can specify a namespace and remapping rules, which will be forwarded to the controller_manager and loaded controllers. Add the following ``<ros>`` section:
+
+.. code-block:: xml
+
+  <gazebo>
+    <plugin filename="libgazebo_ros2_control.so" name="gazebo_ros2_control">
+      ...
+      <ros>
+        <namespace>my_namespace</namespace>
+        <remapping>/robot_description:=/robot_description_full</remapping>
+      </ros>
+    </plugin>
+  </gazebo>
 
 Default gazebo_ros2_control Behavior
 -----------------------------------------------------------