Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update description of view_controller_chains #1094

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -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)
Expand Down