Configuring your ROS 2 environment¶
Goal: This tutorial will show you how to prepare your ROS 2 environment.
Tutorial level: Beginner
Time: 5 minutes
ROS 2 relies on the notion of combining workspaces using the shell environment. “Workspace” is a ROS term for the location on your system where you’re developing with ROS 2. The core ROS 2 workspace is called the underlay. Subsequent local workspaces are called overlays. When developing with ROS 2, you will typically have several workspaces active concurrently.
Combining workspaces makes developing against different versions of ROS 2, or against different sets of packages, easier. It also allows the installation of several ROS 2 distributions (or “distros”, e.g. Dashing and Eloquent) on the same computer and switching between them.
This is accomplished by sourcing setup files every time you open a new shell, or by adding the source command to your shell startup script once. Without sourcing the setup files, you won’t be able to access ROS 2 commands, or find or use ROS 2 packages. In other words, you won’t be able to use ROS 2.
Before starting these tutorials, install ROS 2 by following the instructions on the ROS 2 Installation page.
The commands used in this tutorial assume you followed the binary packages installation guide for your operating system (Debian packages for Linux).
You can still follow along if you built from source, but the path to your setup files will likely be different.
You also won’t be able to use the
sudo apt install ros-<distro>-<package> command (used frequently in the beginner level tutorials) if you install from source.
If you are using Linux or macOS, but are not already familiar with the shell, this tutorial will help.
You will need to run this command on every new shell you open to have access to the ROS 2 commands, like so:
The exact command depends on where you installed ROS 2. If you’re having problems, ensure the file path leads to your installation.
If you don’t want to have to source the setup file every time you open a new shell (skipping task 1), then you can add the command to your shell startup script:
To undo this (to change to another distro) in Linux and macOS, locate your system’s shell startup script and remove the appended source command.
colcon_cd allows you to quickly change the current working directory of your shell to the directory of a package.
As an example
colcon_cd some_ros_package would quickly bring you to the directory
Depending to the way you installed
colcon_cd and where your workspace is, the instructions above may vary, please refer to the documentation for more details.
To undo this in Linux and macOS, locate your system’s shell startup script and remove the appended source and export commands.
Sourcing ROS 2 setup files will set several environment variables necessary for operating ROS 2. If you ever have problems finding or using your ROS 2 packages, make sure that your environment is properly setup using the following command:
Check that variables like
ROS_VERSION are set.
For example, if you’re using Foxy, you would see:
ROS_VERSION=2 ROS_PYTHON_VERSION=3 ROS_DISTRO=foxy
If the environment variables are not set correctly, return to the ROS 2 package installation section of the installation guide you followed. If you need more specific help (because environment setup files can come from different places), you can get answers from the community.
If your lab or office has multiple different groups of computers running ROS 2, and you want to avoid cross-talk between the groups, choose a single integer and set it as the environment variable
ROS_DOMAIN_ID on all the computers in a group. Choose a different, unique integer for each subgroup. (For the default RMW on eProsima Fast RTPS, as of ROS 2 Eloquent, this integer must be between 0-232 for the ROS 2 daemon to successfully start.)
The domain ID is used to segment the network in order to avoid interference between different groups of computers running ROS 2 on the same local area network. Machines with different domain IDs will not talk, nor interfere, with each other.
If you run into issues having multiple computers talk to each other check Troubleshooting. Additionally, there are multiple past conversations on our Discourse and Answers sites with more in-depth information.
Once you have determined a unique integer for your group of ROS 2 agents, you can set the environment variable with the following command:
The ROS 2 development environment needs to be correctly configured before use. This can be done in two ways: either sourcing the setup files in every new shell you open, or adding the source command to your startup script.
If you ever face any problems locating or using packages with ROS 2, the first thing you should do is check your environment variables and ensure they are set to the version and distro you intended.