Skip to content

Commit

Permalink
Update docs on hardware_spawner
Browse files Browse the repository at this point in the history
  • Loading branch information
Timple committed Apr 22, 2024
1 parent b1e82a0 commit 12c9a92
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions controller_manager/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ There are two scripts to interact with controller manager from launch files:

1. ``spawner`` - loads, configures and start a controller on startup.
2. ``unspawner`` - stops and unloads a controller.
3. ``hardware_spawner`` - activates and configures a hardware component.


``spawner``
Expand Down Expand Up @@ -181,6 +182,26 @@ There are two scripts to interact with controller manager from launch files:
-c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER
Name of the controller manager ROS node
``hardware_spawner``
^^^^^^^^^^^^^^

.. code-block:: console
$ ros2 run controller_manager hardware_spawner -h
usage: hardware_spawner [-h] [-c CONTROLLER_MANAGER] (--activate | --configure) hardware_component_name
positional arguments:
hardware_component_name
The name of the hardware component which should be activated.
options:
-h, --help show this help message and exit
-c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER
Name of the controller manager ROS node
--activate Activates the given components. Note: Components are by default configured before activated.
--configure Configures the given components.
Using the Controller Manager in a Process
-----------------------------------------

Expand Down

0 comments on commit 12c9a92

Please sign in to comment.