From bda73375343cdfde6bb5feded74439982522c937 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Mon, 7 Aug 2023 12:51:07 +0200 Subject: [PATCH] Add info where the pdf is saved to view_controller_chains (#1094) --- ros2controlcli/doc/userdoc.rst | 12 +++++++++++- .../ros2controlcli/verb/view_controller_chains.py | 2 +- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/ros2controlcli/doc/userdoc.rst b/ros2controlcli/doc/userdoc.rst index dba173cfbf..5880c054cb 100644 --- a/ros2controlcli/doc/userdoc.rst +++ b/ros2controlcli/doc/userdoc.rst @@ -268,4 +268,14 @@ view_controller_chains $ ros2 control view_controller_chains -h usage: ros2 view_controller_chains - Creates a graphviz image from loaded controllers. + Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf + + options: + -h, --help show this help message and exit + --spin-time SPIN_TIME + Spin time in seconds to wait for discovery (only applies when not using an already running daemon) + -s, --use-sim-time Enable ROS simulation time + -c CONTROLLER_MANAGER, --controller-manager CONTROLLER_MANAGER + Name of the controller manager ROS node + --include-hidden-nodes + Consider hidden nodes as well diff --git a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py index fbd999192e..f838a96e1c 100644 --- a/ros2controlcli/ros2controlcli/verb/view_controller_chains.py +++ b/ros2controlcli/ros2controlcli/verb/view_controller_chains.py @@ -195,7 +195,7 @@ def parse_response(list_controllers_response, list_hardware_response, visualize= class ViewControllerChainsVerb(VerbExtension): - """Generates a diagram of the loaded chained controllers.""" + """Generates a diagram of the loaded chained controllers into /tmp/controller_diagram.gv.pdf.""" def add_arguments(self, parser, cli_name): add_arguments(parser)