• diamondback: Only showing information from the released package extracted on Unknown. No API documentation available. Please see this page for information on how to submit your repository to our index.


• electric: Documentation generated on March 02, 2013 at 01:20 PM


• fuerte: Documentation generated on December 28, 2013 at 05:34 PM


• groovy: Documentation generated on October 06, 2014 at 06:54 AM


• hydro: Documentation generated on August 28, 2015 at 12:38 PM (doc job).


• indigo: Documentation generated on June 07, 2019 at 04:13 AM (doc job).


• jade: Documentation generated on March 20, 2016 at 11:28 AM (doc job).


• kinetic: Documentation generated on October 18, 2020 at 01:06 PM (doc job).


• lunar: Documentation generated on June 08, 2019 at 05:55 AM (doc job).


• melodic: Documentation generated on March 01, 2022 at 07:26 AM (doc job).


• noetic: Documentation generated on June 24, 2022 at 10:25 AM (doc job).

Beginner Tutorials

1. Writing a Simple Publisher and Subscriber

   This demo will walk you through creating a ROS package as well as creating two simple rospy nodes. The "talker" node will broadcast a message on topic "chatter", while the "listener" node will receive and print that message.

2. Writing a Simple Service and Client

   This tutorial covers how to write a service and client node in python.

3. Using Parameters in rospy

   This tutorial covers the various ways in which you can get and set Parameters in rospy. Getting, setting and deleting parameters from a rospy Node is fairly simple.

4. Logging with rospy

   Logging messages to rosout is easy with rospy and encouraged. When you are running many nodes, seeing the command-line output of your node gets very difficult. Instead, it is much easier to publish a debugging message to rosout and then view it with rqt_console / rxconsole. *console is "over-console" of ROS and lets you view and filter the logging messages from all ROS nodes.

5. Writing a ROS Python Makefile

   I know what you're saying: "Python... Makefile?" Believe it or not, you do need Makefile (and CMakeLists), even if you just hack Python all day.

6. Setting Up Your PYTHONPATH

   What to do to find other python modules

7. Using numpy with rospy

   This tutorial covers using numpy with rospy, the ROS Python client library. Numpy is a popular scientific computing package for Python. You will often want to consider using Numpy with rospy if you are working with sensor data as it has better performance and many libraries for manipulating arrays of data.

Intermediate Tutorials

1. Publishing messages in rospy

   Writing a simple publisher and subscriber already introduced you to the basics of creating rospy Nodes that publish and receive messages on ROS Topics. As you get more experienced with ROS and rospy, you may wish to learn some advanced syntax for publishing that will save you some typing -- as well as make your code more robust to future changes.

2. Python CompressedImage Subscriber Publisher

   This example subscribes to a ros topic containing sensor_msgs::CompressedImage. It converts the CompressedImage into a numpy.ndarray, then detects and marks features in that image. It finally displays and publishes the new image - again as CompressedImage topic.

Create a new tutorial