Skip to content

Commit bf7418c

Browse files
committed
add documentation
1 parent 0e86448 commit bf7418c

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

ros2controlcli/doc/userdoc.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Currently supported commands are
1919
- ros2 control set_hardware_component_state
2020
- ros2 control switch_controllers
2121
- ros2 control unload_controller
22+
- ros2 control unconfigure_controller
2223
- ros2 control view_controller_chains
2324

2425

@@ -344,6 +345,30 @@ unload_controller
344345
Consider hidden nodes as well
345346
--ros-args ... Pass arbitrary arguments to the executable
346347
348+
unconfigure_controller
349+
----------------------
350+
351+
.. code-block:: console
352+
353+
$ ros2 control unconfigure_controller -h
354+
usage: ros2 control unconfigure_controller [-h] [--spin-time SPIN_TIME] [-s] [-c CONTROLLER_MANAGER] [--include-hidden-nodes] [--ros-args ...] controller_name
355+
356+
Unconfigure/Cleanup a controller in a controller manager
357+
358+
positional arguments:
359+
controller_name Name of the controller
360+
361+
options:
362+
-h, --help show this help message and exit
363+
--spin-time SPIN_TIME
364+
Spin time in seconds to wait for discovery (only applies when not using an already running daemon)
365+
-s, --use-sim-time Enable ROS simulation time
366+
-c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER
367+
Name of the controller manager ROS node (default: controller_manager)
368+
--include-hidden-nodes
369+
Consider hidden nodes as well
370+
--ros-args ... Pass arbitrary arguments to the executable
371+
347372
view_controller_chains
348373
----------------------
349374

0 commit comments

Comments
 (0)