UP | HOME

ROS Basics

Introduction

The ROS ecosystem consists of a collection of tools, software, and documentation. These are used to describe, implement, and inspect a ROS program, which consists of multiple processes (called nodes) that run in parallel and communicate with each other using inter-process communication.

Documentation

  • https://docs.ros.org: The main documentation for ROS
  • The official ROS Tutorials. The beginner tutorials are especially worth doing.
  • https://index.ros.org The ROS index tracks ROS packages and links to documentation for them.
    • This page is extremely useful and should be your first stop when trying to learn about a package.
  • https://docs.ros.org/en/iron/p Package-level API documentation (this still seems to be somewhat of a work-in progress).
  • https://wiki.ros.org - The ROS wiki is the main documentation for ROS 1.
    • ROS 2 documentation should be preferred, but for packages in both ROS 1 and ROS 2 the documentation has not yet fully transitioned and the ROS 1 documentation mostly applies.
  • https://robotics.stackexchange.com - The preferred Q & A website for asking ROS questions.
    • ROS deprecated https://answers.ros.org on August 11, 2023 in favor of the robotics stack exchange website. It is still available in read-only mode.
  • ROS Enhancement Proposals (REP) - Documents ROS design decisions and best practices.
  • Built-in documentation: Most ros tools accept a --help or -h argument to display their help.
  • External Documentation: Sometimes the package itself has an external documentation website (often linked on the ROS wiki, often on the repository page).
  • Some of the tools used in ROS are actually maintained separately from ROS and have their own documentation as well.
  • The source code is often the ultimate documentation. Do not be afraid to read the code.
  • Part of this course is about learning how to use the documentation, so not all the answers will be provided in these notes or in lecture!

Packages

Packages are the basic organization unit for ROS components that can be installed and uninstalled as a single unit.

  • Packages are created from source code and data (e.g., python files, C++ files, configuration files, interface descriptions).
  • Packages are distributed either as source code (e.g., as a git repository or a tarball) or as a binary file (e.g., a debian (.deb) file).
  • Some packages rely on other packages to function. If package A depends on packages B and C then packages B and C are dependencies of package A.
  • Many ROS packages depend on packages that are distributed with Ubuntu.
    • Packages distributed with the operating system (e.g., Ubuntu) are called system dependencies.

Installation

There are a few ways to install and use packages in ROS:

  1. ROS provides a central apt repository where packages released for the ROS distribution (e.g., iron) can be downloaded using apt.
    • sudo apt install ros-iron-<package-name>, where <package-name> is the package name where the underscores (_) have been changed to dashes (-).
    • This method is the most common for installing ROS packages and is preferred.
  2. You can download the source code for the package, build it, and use it:
    • This method is used if the binary package is unavailable or you wish to modify a package.
  3. You can use a language-specific package manager (e.g., pip for python).
    • The ROS dependency system is incapable of handling such packages.
    • If you wish to publish a ROS package and have it included in the ROS distribution, you must also package any dependencies that are not available via apt.
  4. The ROS Index provides information on all ROS packages and dependencies, including information about:
    • What versions of ROS the package is released for.
    • The location of the source code.
    • Package documentation.

Metadata

  • Metadata about ROS packages is stored in a manifest file called package.xml (sometimes referred to as the package manifest).
    • Metadata includes dependency information, author information, a package description, etc.
  • You can view the package manifest for any ROS package using ros2 pkg xml <package>, where <package> is the package's name.
    • ros2 pkg --help provides a list of other useful pkg commands.
    • ros2 pkg is part of the ros2cli package, the ROS 2 Command Line Interface.
  • The format for package.xml is specified in REP 0149.
  • In ROS 2, meta information about packages is stored in the location <prefix>/share/ament_index
    • The <prefix> directory is the location where the package is installed (for your main ROS installation it is /opt/ros/iron)
  • The structure of the ament_index directory provides information about the package. Development of this index is ongoing.

rosdep

  • ROS maintains a tool called rosdep which enables ROS packages to specify their dependencies on other ROS packages and on system dependencies.
  • The rosdistro repository maintains a list of system dependencies that ROS packages can use.
  • rosdep is useful if you are installing packages from source code and want to download their dependencies first.

Nodes

  • A Node in ROS executes code and communicates with other nodes.
  • A Node is often its own process, but in ROS 2 multiple nodes may run under a single process (e.g., to reduce communication overhead).

    Details
    • A node needs to be made in a specific way to be composable. A Composable Node is referred to as a component.
    • Composable nodes can currently only be written in C++.
    • Tutorial on Composable Nodes
  • Nodes use ROS client library to connect with other nodes.
    • rclpy is the Python client library.
    • rcl is the C client library, upon which the other client libraries are built.
    • rclcpp is the C++ client library.
  • Each node communicates with other nodes (which may be running in the same process, different processes on the same computer, or on different computers) to form a complete robotic system.
  • In ROS 2 Lifecycles may be used to manage and control when and how a node runs.
    • Lifecycle nodes can currently only be written in C++.
  • Use ros2 node list to list all running nodes.
  • See the Nodes conceptual documentation for more information.

Running Nodes

  • Start a node with ros2 run <package> <node>
  • Nodes can also take command-line arguments
  • In ROS 1, a command rosnode kill nodename existed. There is no equivalent currently in ROS 2.
    • Instead you should kill the proccess running the ndoe
    • Often, you can accomplish this with pkill nodename. You can also ps aux | grep ros to locate ROS nodes

Inter-Node Communication

In ROS, there are a few methods for nodes to exchange information. These modes work whether the nodes are running within the same process, on different processes on the same computer, or on different computers.

Topics

Topics are labeled channels for communication between nodes and are an implementation of a Publish/Subscribe communication pattern.

  • A node can provide information by publishing a message to a topic.
  • A node can receive information by subscribing to a topic.
  • When a node publishes a message to a topic all nodes that have subscribed to that topic receive the message.
  • Topics are a many-to-many communication channel: any number of nodes may publish or subscribe to a given topic.
  • ros2 topic provides commands for investigating topics.
  • rqt_plot (ros2 run rqt_plot rqt_plot) can plot a topic value over time;
    • An rqt plot can also be added to the GUI when running rqt
  • rqt also provides plugins for working with topics.
  • See the Topics conceptual documentation for more information.

Services

Services provide a request/response mechanism for inter-node communication.

  • A node provides a service by creating a service server (sometimes referred to as just a server).
  • A node calls a service by creating a service client (sometimes referred to as just a client).
  • A service client sends a request to a service server and the service server replies by sending a response to the service client.
  • Services are useful for sending infrequent signals to a node or for asking a node to perform a calculation.
  • Each service has exactly one server, but multiple clients can connect to the same server.
  • ros2 service provides commands for investigating topics.

-rqt also provides plugins for working with services.

  • See the Services conceptual documentation for more information.

Actions

Actions enable a client to initiate a long-running task and receive periodic feedback.

  • Actions consist of three parts: a request, a result, and feedback.
  • The action server receives a request from an action client (much like a service) and periodically sends feedback (over a topic) until the action is complete, whereupon it sends a result (like a service response).
  • If the client wants to cancel the action before it is complete, it can send a cancel request to the action server.
  • Actions are implemented, at a lower-level, in terms of services and topics.
    • In ROS 2, these services and topics are hidden by default
    • Passing --include-hidden-topics to ros2 topic and --include-hidden-services to ros2 service provides access to these hidden topics and services
  • ros2 action provides commands for examining actions.
  • rqt also provides plugins for working with actions.
  • Tutorials: Creating Custom Actions and Writing an Action Tutorial
  • See the Actions conceptual documentation for more information.
  • The Actions Design Document also provides useful information

Interfaces

  • Interfaces are a generic name for Topics, Services, and Actions (the interface to a node).
    • Topics have an associated Message Type that determines the layout of the message published to the topic.
    • Services have an associated Service Type that determines the layout of the associated request and response.
    • Actions have an associated Action Type that determines the layout of the request, result, and feedback.
    • An Interface Type generically refers to Message Type, Service Type or Action Type.
    • Sometimes, in conversation we say "Interface", "Message", "Service" or "Action" to mean the associated type: context makes the distinction.
  • ROS Interface Types are specified using the Interface Definition Language (IDL):
    • Message Types are specified in <pkg>/msg/<MessageType>.msg files
    • Service Types are specified in <pkg>/srv/<ServiceType>.srv files
    • Action Types are stored in <pkg>/action/<ActionType>.action files

ROS IDL

  • Each line in an IDL file specifies a field in the data type.
  • Each field contains a type-specifier and the name of the field.
    • The ROS IDL has several built-in types (e.g., bool, uint32, string, and arrays of these types)
    • Messages can also be used as a type (and therefore IDL types can be nested).
    • It is also possible to define constants in the IDL.
  • Service files contain both a request and a response (in that order). They are separated by a single line containing ---.
  • Action files contain a request, a result, and a feedback (in that order). Each of these is separated by a single line containing ---.
  • Interface files are converted into data types in the programming languages ROS targets:
    • rosidl Contains basic IDL functionality, including code to generate interfaces code for C and to C++.
    • rosidl_python contains code to convert interface files to python.
  • Use ros2 interface to get information about interfaces.

ROS Graph

  • All running nodes in a ROS system can be thought of as vertices (aka nodes) in a computation graph.
  • All topics in a ROS system can be thought of as the directed edges in a computation graph.
  • The ROS graph can be visualized in rqt or by using rqt_graph.
  • ROS 2 communication is based on a standard message-passing protocol called Data Distribution Service (DDS)
    • The standard uses Real-Time Publish Subscribe (RTPS) to define a common data-exchange format between DDS vendors.
    • The ROS 2 client libraries provide abstractions around this protocol. via the ROS Middleware (rmw).
    • Multiple vendors provide implementations of DDS, but rmw enables a user to theoretically change DDS implementations without affecting the rest of the code.
    • There are different reasons (both technical and non-technical) for using different DDS implementations, see About different ROS 2 DDS/RTPS vendors for details
    • We will use the default DDS implementation.
  • In ROS 2, nodes are able to discover and connect to each other automatically, but this can also be changed to be more manual.
  • Quality of Service settings determine polices for how data is handled when being exchanged (whether via topics or services):
    • QoS determines what to do various scenarios such as communication over an unreliable connection or when messages are coming in too fast to be processed.
    • Generally nodes must have the same QoS settings to communicate properly.
    • We will be using the default QoS settings.

Differences from ROS 1

  • In ROS 1, all nodes register themselves with a central server called roscore, which must be running at all times
  • ROS 1 uses a custom IPC protocol based on XML, and there is no concept of Quality of Service.

Parameters

ROS Parameters enable storing configuration values for a node.

  • Parameters are used as settings that can be accessed by all ROS nodes and modified by the user to change node behavior.
  • Use ros2 param to perform actions on nodes.
  • Typically, nodes read parameters when they start, however, in ROS 2, a callback can respond to parameter changes.
  • Parameters can store strings, integers, floats, dates, times, and lists.
  • Oftentimes, parameters are set in Launchfiles, to provide each node you are starting with the proper configuration information
  • See the Parameters conceptual documentation for more information.

Yaml Files

  • Parameters are specified using the YAML format
  • YAML files can be stored on disk and loaded by rosparam or a launchfile into the parameter server

Differences from ROS 1

  • In ROS 1 parameters are stored in a central server called the ROS parameter server.
  • The behavior of a central parameter server can be emulated by creating a node that is only used to store parameters.

Launchfiles

Launchfiles enable multiple nodes to be started with a single command.

  • In ROS 2 there are 3 formats for a launch file
    • Python: python scripts that use the ROS 2 launch API to configure and run nodes. The most flexible and powerful but also most complicated.
    • XML: The format as in ROS 1. Directly declares what nodes are running but can perform minimal logic.
    • YAML: Another format for writing what is essentially the same as an XML launchfile (do you like tags or indentation?)
  • ros2 launch lets you run and interact with launchfiles.
  • Strive to have one launchfile completely start your project

Bags

Bags enable you to capture data from ROS topics to a file and play them back in real time.

  • Use ros2 bag to interact with and record bags.
  • Running robotics experiments is often frustrating and difficult. Capturing the data from a run and testing different algorithms and parameters on it is extremely useful.
  • rqt has a plugin called rqt_bag that enables interaction with bagfiles.

Logging

Nodes can log information at different logger levels, indicating the severity of the message.

  • There are five verbosity levels: DEBUG, INFO, WARN, ERROR, FATAL.
  • Log data can also be viewed in real time using rqt_console
  • The RCUTILS_CONSOLE_OUTPUT_FORMAT environment variable controls the formatting of log messages
  • When running a node passing --ros-args --log-level LEVEL sets the logger level
    • To specify a particular node use --ros-args --log-level node_name:=DEBUG
  • Tutorial on Logging
  • Currently, the logger level can only be configured externally after a node is running if the node has enabled logging services, and there are limitations.

Debugging

  • ros2 doctor can help point out problems with your ROS setup

Author: Matthew Elwin