Skip to content

Commit

Permalink
Add info where the pdf is saved to view_controller_chains (#1094) (#1096
Browse files Browse the repository at this point in the history
)
  • Loading branch information
mergify[bot] authored Aug 7, 2023
1 parent c74fb61 commit 2189b97
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
12 changes: 11 additions & 1 deletion ros2controlcli/doc/userdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,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)
Expand Down

0 comments on commit 2189b97

Please sign in to comment.