You are on page 1of 3

ROS Indigo Cheatsheet Logging Tools rostopic

rosbag A tool for displaying information about ROS topics, including


Filesystem Management Tools publishers, subscribers, publishing rate, and messages.
rospack/rosstack A tool inspecting packages. A set of tools for recording and playing back of ROS topics. Commands:
Commands: rostopic bw Display bandwidth used by topic.
rospack profile Fixes path and pluginlib problems.
rosbag record Record a bag file with specified topics. rostopic echo Print messages to screen.
roscd Change directory to a package or stack.
rosbag play Play content of one or more bag files. rostopic find Find topics by type.
rospd/rosd Pushd equivalent for ROS.
rosbag compress Compress one or more bag files. rostopic hz Display publishing rate of topic.
rosls Lists package or stack information.
rosbag decompress Decompress one or more bag files. rostopic info Print information about an active topic.
rosed Open requested ROS file in a text editor.
rosbag filter Filter the contents of the bag. rostopic list List all published topics.
roscp Copy a file from one place to another.
rostopic pub Publish data to topic.
rosdep Installs package system dependencies. Examples: rostopic type Print topic type.
roswtf Displays a errors and warnings about a Record select topics:
running ROS system or launch file. $ rosbag record topic1 topic2 Examples:
roscreate-pkg Creates a new ROS package. Replay all messages without waiting: Publish hello at 10 Hz:
roscreate-stack Creates a new ROS stack. $ rosbag play -a demo log.bag $ rostopic pub -r 10 /topic name std msgs/String hello
rosmake Builds a ROS package. Replay several bag files at once: Clear the screen after each message is published:
rqt dep Displays package structure and depen- $ rosbag play demo1.bag demo2.bag $ rostopic echo -c /topic name
dencies. Display messages that match a given Python expression:
$ rostopic echo --filter "m.data==foo" /topic name
Usage:
$ rospack find [package] Introspection and Command Tools Pipe the output of rostopic to rosmsg to view the msg type:
$ rostopic type /topic name | rosmsg show
$ roscd [package[/subdir]] rosmsg/rossrv
$ rospd [package[/subdir] | +N | -N] rosparam
$ rosd Displays Message/Service (msg/srv) data structure definitions. A tool for getting and setting ROS parameters on the
$ rosls [package[/subdir]] Commands: parameter server using YAML-encoded files.
$ rosed [package] [file] rosmsg show Display the fields in the msg/srv.
rosmsg list Display names of all msg/srv. Commands:
$ roscp [package] [file] [destination] rosparam set Set a parameter.
$ rosdep install [package] rosmsg md5 Display the msg/srv md5 sum. rosparam get Get a parameter.
$ roswtf or roswtf [file] rosmsg package List all the msg/srv in a package. rosparam load Load parameters from a file.
$ roscreate-pkg [package name] rosmsg packages List all packages containing the msg/srv. rosparam dump Dump parameters to a file.
$ rosmake [package] Examples: rosparam delete Delete a parameter.
$ rqt dep [options] Display the Pose msg: rosparam list List parameter names.
Start-up and Process Launch Tools $ rosmsg show Pose Examples:
roscore List the messages in the nav msgs package: List all the parameters in a namespace:
The basis nodes and programs for ROS-based systems. A $ rosmsg package nav msgs $ rosparam list /namespace
roscore must be running for ROS nodes to communicate. List the packages using sensor msgs/CameraInfo: Setting a list with one as a string, integer, and float:
$ rosmsg packages sensor msgs/CameraInfo $ rosparam set /foo "[1, 1, 1.0]"
Usage: Dump only the parameters in a specific namespace to file:
$ roscore rosnode $ rosparam dump dump.yaml /namespace
rosrun Displays debugging information about ROS nodes, including rosservice
Runs a ROS packages executable with minimal typing. publications, subscriptions and connections.
Commands: A tool for listing and querying ROS services.
Usage: Commands:
rosnode ping Test connectivity to node.
$ rosrun package name executable name
rosnode list List active nodes. rosservice list Print information about active services.
Example (runs turtlesim): rosnode info Print information about a node. rosservice node Print name of node providing a service.
$ rosrun turtlesim turtlesim node rosnode machine List nodes running on a machine. rosservice call Call the service with the given args.
rosnode kill Kill a running node. rosservice args List the arguments of a service.
rosservice type Print the service type.
roslaunch Examples: rosservice uri Print the service ROSRPC uri.
Starts a roscore (if needed), local nodes, remote nodes via Kill all nodes: rosservice find Find services by service type.
SSH, and sets parameter server parameters. $ rosnode kill -a Examples:
Examples: List nodes on a machine: Call a service from the command-line:
Launch a file in a package: $ rosnode machine aqy.local $ rosservice call /add two ints 1 2
$ roslaunch package name file name.launch Ping all nodes: Pipe the output of rosservice to rossrv to view the srv type:
Launch on a different port: $ rosnode ping --all $ rosservice type add two ints | rossrv show
$ roslaunch -p 1234 package name file name.launch Display all services of a particular type:
Launch on the local nodes: $ rosservice find rospy tutorials/AddTwoInts
$ roslaunch --local package name file name.launch
ROS Indigo Cheatsheet rqt publisher, and rqt service caller Data Visualization Tools
Tools for publishing messages and calling services. tf echo
Logging Tools Usage:
A tool that prints the information about a particular
rqt console $ rqt
transformation between a source frame and a target frame.
A tool to display and filtering messages published on rosout. Plugin Menu->Topic->Message Publisher
Plugin Menu->Service->Service Caller Usage:
$ rosrun tf tf echo <source frame> <target frame>
rqt graph, and rqt dep
Examples:
Tools for displaying graphs of running ROS nodes with
To echo the transform between /map and /odom:
connecting topics and package dependancies respectively.
$ rosrun tf tf echo /map /odom

view frames
Usage:
A tool for visualizing the full tree of coordinate transforms.
$ rqt console
Usage:
$ rosrun tf2 tools view frames.py
rqt bag $ evince frames.pdf
A tool for visualizing, inspecting, and replaying bag files.
rqt plot
A tool for plotting data from ROS topic fields.

Usage, viewing:
$ rqt bag bag file.bag Usage:
Usage, bagging: $ rqt graph
$ rqt bag *press the big red record button.* $ rqt dep
Examples:
To graph the data in different plots:
rqt logger level rqt top $ rqt plot /topic1/field1 /topic2/field2
Change the logger level of ROS nodes. This will increase or A tool for ROS specific process monitoring. To graph the data all on the same plot:
decrease the information they log to the screen and rqt console. $ rqt plot /topic1/field1,/topic2/field2
Usage:
Usage: $ rqt To graph multiple fields of a message:
viewing $ rqt logger level Plugin Menu->Introspection->Process Monitor $ rqt plot /topic1/field1:field2:field3

Introspection & Command Tools rqt reconfigure rqt image view


rqt topic A tool for dynamically reconfiguring ROS parameters. A tool to display image topics.
A tool for viewing published topics in real time. Usage:
Usage: $ rqt
$ rqt Plugin Menu->Configuration->Dynamic Reconfigure
Plugin Menu->Topic->Topic Monitor
Development Environments
rqt msg, rqt srv, and rqt action
rqt shell, and rqt py console
A tool for viewing available msgs, srvs, and actions.
Two tools for accessing an xterm shell and python console
Usage:
respectively.
$ rqt
Plugin Menu->Topic->Message Type Browser Usage:
Plugin Menu->Service->Service Type Browser $ rqt Usage:
Plugin Menu->Action->Action Type Browser Plugin Menu->Miscellaneous Tools->Shell $ rqt image view
Plugin Menu->Miscellaneous Tools->Python Console
Copyright
c 2015 Open Source Robotics Foundation

Copyright
c 2010 Willow Garage