The Ultimate Guide to the ROS 2 Navigation Stack – Foxy

In the tutorials below, we will cover the ROS 2 Navigation Stack (also known as Nav2) in detail, step-by-step. The ROS 2 Navigation Stack is a collection of software packages that you can use to help your mobile robot move from a starting location to a goal location safely. Here will be our final output:

Navigation in a known environment with a map
Navigation in an unknown environment without a map

Credit to Ramkumar Gandhinathan and Lentin Joseph’s awesome book ROS Robotics Projects Second Edition (Disclosure: As an Amazon Associate I earn from qualifying purchases) for the world file, which comes from their book’s public GitHub page.

Real-World Applications

The ROS 2 Navigation Stack can be used in a number of real-world robotic applications: 

  • Ground Delivery
  • Hospitals and Medical Centers
  • Hotels (Room Service)
  • Offices
  • Restaurants
  • Warehouses
  • And more…

In this project, we will work with a simulated robot in a simulated world. Roboticists like to simulate robots before building them in order to test out different algorithms. You can imagine the cost of making mistakes with a physical robot can be high (e.g. crashing a mobile robot into a wall at high speed means lost money).

Let’s get started!

Prerequisites

  • ROS 2 Foxy Fitzroy installed on Ubuntu Linux 20.04
    • If you are using another ROS 2 distribution, you will need to replace ‘foxy’ with the name of your distribution everywhere I mention ‘foxy’ in this tutorial. 
    • I highly recommend you get the newest version of ROS 2. If you are using a newer version of ROS 2, you can still follow most of the steps in this tutorial. I will point out the areas where you will need to do things differently.
  • You have already created a ROS 2 workspace. The name of our workspace is “dev_ws”, which stands for “development workspace.” 

For future reference, here is a complete package (named ‘two_wheeled_robot‘) I developed that uses both URDF and SDF robot model files with the ROS 2 Navigation Stack. You can use this as a template after you have gone through the tutorials below.

Directions

Complete the following five tutorials in order, step by step. When you are done, you will have a deep understanding of the ROS 2 Navigation Stack and will be ready to confidently use this package in your own robotics projects.

  1. How to Create a Simulated Mobile Robot in ROS 2 Using URDF
  2. Set Up the Odometry for a Simulated Mobile Robot in ROS 2
  3. Sensor Fusion Using the Robot Localization Package – ROS 2
  4. Set Up LIDAR for a Simulated Mobile Robot in ROS 2
  5. Navigation and SLAM Using the ROS 2 Navigation Stack

Enjoy!

Navigation and SLAM Using the ROS 2 Navigation Stack

In this ROS 2 Navigation Stack tutorial, we will use information obtained from LIDAR scans to build a map of the environment and to localize on the map. The purpose of doing this is to enable our robot to navigate autonomously through both known and unknown environments (i.e. SLAM).

As noted in the official documentation, the two most commonly used packages for localization are the nav2_amcl package and the slam_toolbox. Both of these packages publish the map -> odom coordinate transformation which is necessary for a robot to localize on a map.

This tutorial is the fifth tutorial in my Ultimate Guide to the ROS 2 Navigation Stack (also known as Nav2).

You can get the entire code for this project here if you are using ROS Foxy.

If you are using ROS Galactic or newer, you can get the code here.

Let’s get started!

Prerequisites 

You have completed the first four tutorials of this series:

  1. How to Create a Simulated Mobile Robot in ROS 2 Using URDF
  2. Set Up the Odometry for a Simulated Mobile Robot in ROS 2
  3. Sensor Fusion Using the Robot Localization Package – ROS 2
  4. Set Up LIDAR for a Simulated Mobile Robot in ROS 2

Create a Launch File

Open a new terminal window, and move to your launch folder.

colcon_cd basic_mobile_robot
cd launch
gedit basic_mobile_bot_v5.launch.py

Copy and paste this code into the file.

Save the file, and close it.

Add a Static Map

We now need to add a static map of our world so our robot can plan an obstacle-free path between two points. 

I already created a map of the world in a previous tutorial, so we’ll use the yaml and pgm file from that tutorial.

Go to your ~/dev_ws/src/basic_mobile_robot/maps folder.

Place this pgm file and this yaml file inside the folder.

Add Navigation Stack Parameters

Let’s add parameters for the ROS 2 Navigation Stack. The official Configuration Guide has a full breakdown of all the tunable parameters. The parameters enable you to do all sorts of things with the ROS 2 Navigation Stack.

The most important parameters are for the Costmap 2D package. You can learn about this package here and here.

A costmap is a map made up of numerous grid cells. Each grid cell has a “cost”. The cost represents the difficulty a robot would have trying to move through that cell. 

For example, a cell containing an obstacle would have a high cost. A cell that has no obstacle in it would have a low cost.

The ROS Navigation Stack uses two costmaps to store information about obstacles in the world. 

  1. Global costmap: This costmap is used to generate long term plans over the entire environment….for example, to calculate the shortest path from point A to point B on a map.
  2. Local costmap: This costmap is used to generate short term plans over the environment….for example, to avoid obstacles.

We will use the AMCL (Adaptive Monte Carlo Localization) algorithm for localizing the robot in the world and for publishing the coordinate transform from the map to odom frame. 

AMCL localizes the robot in the world using LIDAR scans. It does this by matching real-time scan information to a known map. You can read more about AMCL here and here.

Go to your ~/dev_ws/src/basic_mobile_robot/params folder.

Place this nav2_params.yaml file inside the folder.

If you are using ROS 2 Galactic or newer, your code is here.

Create an RViz Configuration File

Go to your rviz folder.

colcon_cd basic_mobile_robot
cd rviz 

Create a new RViz file.

gedit nav2_config.rviz

Copy and paste this code inside the file.

Save the file, and close it.

Update the Plugin Parameters 

I updated the LIDAR plugin parameters inside model.sdf inside the basic_mobile_robot_description folder. 

I also updated the differential drive plugin to use odometry data from the WORLD as the source rather than ENCODER.

cd ~/dev_ws/src/basic_mobile_robot/models/basic_mobile_bot_description
gedit model.sdf

Make sure you copy and paste this code into the model.sdf file, and then save and close it.

Update the Robot Localization Parameters

Inside my ekf.yaml file, I updated the map_frame since we will be using a map. The robot_localization package will not be using the map, but I still want to update this parameter so that it is there if I need it.

cd ~/dev_ws/src/basic_mobile_robot/config
gedit ekf.yaml

Make sure you copy and paste this code into the ekf.yaml file, and then save and close it.

Build the Package

Now build the package by opening a terminal window, and typing the following command:

cd ~/dev_ws
colcon build

Launch the Robot Without SLAM

Open a new terminal window, and type the following command.

colcon_cd basic_mobile_robot

Launch the robot.

ros2 launch basic_mobile_robot basic_mobile_bot_v5.launch.py
1-launch-basic-mobile-robot-v5

Move the Robot From Point A to Point B

Now go to the RViz screen.

Set the initial pose of the robot by clicking the “2D Pose Estimate” on top of the rviz2 screen (Note: we could have also set the set_initial_pose and initial_pose parameters in the nav2_params.yaml file to True in order to automatically set an initial pose.)

Then click on the map in the estimated position where the robot is in Gazebo.

Set a goal for the robot to move to. Click “Navigation2 Goal” button in RViz, and click on a desired destination. 

You can also request goals through the terminal by using the following command:

ros2 topic pub /goal_pose geometry_msgs/PoseStamped "{header: {stamp: {sec: 0}, frame_id: 'map'}, pose: {position: {x: 5.0, y: -2.0, z: 0.0}, orientation: {w: 1.0}}}"

You will notice that we published the goal to the /goal_pose topic.

The wheeled robot will move to the goal destination.

4-launch-basic-mobile-robot-v5-1

In the bottom left of the screen, you can Pause and Reset.

If the robot does not move at all, press CTRL+C in all windows to close everything down. Then try launching the robot again.

The key to getting good performance with the ROS 2 Navigation Stack is to spend a lot of time (it can take me several days) tweaking the parameters in the nav2_params.yaml file we built earlier. Yes, it is super frustrating, but this is the only way to get navigation to work properly. 

Common things you can try changing are the robot_radius and the inflaition_radius parameters. You can also try changing the expected_planner_frequency, update_frequency, publish_frequency, and width/height of the rolling window in the local_costmap.

Also, you can try modifying the update_rate in the LIDAR sensor inside your robot model.sdf file.

Don’t change too many things all at once. Just change something, build the package, and then launch the robot again to see what happens. Then change another thing, and watch what happens, etc.

Now let’s check out the coordinate frames. Open a new terminal window, and type:

ros2 run tf2_tools view_frames.py

If you are using ROS 2 Galactic or newer, type:

ros2 run tf2_tools view_frames

In the current working directory, you will have a file called frames.pdf. Open that file.

evince frames.pdf

Here is what my coordinate transform (i.e. tf) tree looks like:

5-view-frames-robot

To see an image of the architecture of our ROS system, open a new terminal window, and type the following command:

rqt_graph

Press CTRL + C on all terminal windows to close down the programs.

Move the Robot Through Waypoints

Open a new terminal window, and type the following command.

colcon_cd basic_mobile_robot

Launch the robot.

ros2 launch basic_mobile_robot basic_mobile_bot_v5.launch.py

Now go to the RViz screen.

Set the initial pose of the robot by clicking the “2D Pose Estimate” on top of the rviz2 screen. 

Then click on the map in the estimated position where the robot is in Gazebo.

Now click the Waypoint mode button in the bottom left corner of RViz. Clicking this button puts the system in waypoint follower mode.

6-waypoints

Click “Navigation2 Goal” button, and click on areas of the map where you would like your robot to go (i.e. select your waypoints). Select as many waypoints as you want. 

I chose five waypoints. Each waypoint is labeled wp_#, where # is the number of the waypoint.

7-waypoint-icon

When you’re ready for the robot to follow the waypoints, click the Start Navigation button.

You should see your robot autonomously navigate to all the waypoints. At each waypoint, your robot will stop for 10-20 seconds, and then it will move to the next waypoint.

8-navigate-to-waypoint
9-processing-waypoint0
10-waypoint-succeeded
11-waypoint-succeeded
12-completed-all-waypoint

If your robot does not navigate to the waypoints, relaunch the robot and try again. Try selecting different waypoints. 

The ROS 2 Navigation Stack waypoint follower functionality isn’t perfect. Many times, the robot will skip over waypoints or abandon them completely. The most common error I get when this happens is the following:

[bt_navigator]: Action server failed while executing action callback: “send_goal failed”

[bt_navigator]: [navigate_to_pose] [ActionServer] Aborting handle.

This issue is a known problem in ROS 2 Foxy, and it appears to be fixed in the latest version of ROS 2 (i.e. Galactic). We won’t upgrade ROS right now, but this is something to keep in mind if you are using a version of ROS 2 that is newer than ROS 2 Foxy.

In addition, I like to play around with the parameters in the nav2_params.yaml file located inside the params folder of your package. A complete guide to all the parameters is here.

Finally, let’s check out the active ROS 2 topics.

ros2 topic list
13-ros2-topic-list-1
13-ros2-topic-list-2

Launch the Robot With SLAM

Make sure the SLAM toolbox is installed. Open a terminal window, and type:

sudo apt install ros-foxy-slam-toolbox

The syntax is:

sudo apt install ros-<ros2-distro>-slam-toolbox

Open the model.sdf file inside the basic_mobile_robot/models/basic_mobile_bot_description folder, and change the number of LIDAR samples (inside the <samples></samples> tag) to some high number like 120.

To launch the robot with SLAM (simultaneous localization and mapping), open a terminal window, and run the following command:

ros2 launch basic_mobile_robot basic_mobile_bot_v5.launch.py slam:=True

Use the rqt_robot_steering tool to slowly drive the robot around the room. Open a terminal window, and type: 

rqt_robot_steering

If you are using ROS 2 Galactic or newer, type:

sudo apt-get install ros-galactic-rqt-robot-steering

Where the syntax is:

sudo apt-get install ros-<ros-distribution>-rqt-robot-steering

Then type:

ros2 run rqt_robot_steering rqt_robot_steering --force-discover

The robot will build a map and localize at the same time. You can also use autonomous navigation using the RViz buttons like we did in the last section.

15-slam-map-building
16-making-a-map

Save the Map (ROS Foxy and Older)

If you are using a ROS Distribution that is ROS Foxy and older, you will have to follow these instructions to save the map you have built. These instructions will have to be done before you launch the robot with SLAM. Let’s walk through the process below.

Open a new terminal window, and type:

colcon_cd basic_mobile_robot
cd launch

Add the map_saver.launch.py file.

Now go back to the terminal window, and type the following command:

colcon_cd basic_mobile_robot
cd params

Add the map_saver_params.yaml file.

Go back to the terminal window.

Build the package by typing the following commands:

cd ~/dev_ws
colcon build

Launch the robot again with SLAM from your maps directory.

colcon_cd basic_mobile_robot
cd maps
ros2 launch basic_mobile_robot basic_mobile_bot_v5.launch.py slam:=True

Drive the robot around to create the map. In a new terminal window, you will type the following command to pull up the steering controller:

rqt_robot_steering

Execute the launch file once you’re done mapping the environment. Open a new terminal window, and type:

ros2 launch basic_mobile_robot map_saver.launch.py

Ignore any error messages that appear in the terminal window when you type the command above.

In a separate terminal, call the service to generate your map. We will call the map “my_map”:

ros2 service call /map_saver/save_map nav2_msgs/srv/SaveMap "{map_topic: map, map_url: my_map, image_format: pgm, map_mode: trinary, free_thresh: 0.25, occupied_thresh: 0.65}"
18-save-map

Your my_map.pgm and my_map.yaml file will save to the maps directory of your basic_mobile_robot package.

17-save-map

Save the Map (ROS Galactic and Newer)

If you have ROS Galactic or newer, open a new terminal window, and type:

colcon_cd basic_mobile_robot
cd maps

When you are happy with the map you have built, open a new terminal window, and type the following command to save the map:

ros2 run nav2_map_server map_saver_cli -f my_map

The syntax is:

ros2 run nav2_map_server map_saver_cli -f <map_name>
19-save-map

Your my_map.pgm and my_map.yaml map files will automatically save to the maps directory of your basic_mobile_robot package.

That’s it!

In the next tutorial, we will take a look at how to incorporate GPS data to create better localization. Stay tuned!

Set Up LIDAR for a Simulated Mobile Robot in ROS 2

In this tutorial, we will set up the LIDAR sensor for a simulated mobile robot.

This tutorial is the fourth tutorial in my Ultimate Guide to the ROS 2 Navigation Stack (also known as Nav2).

You can get the entire code for this project here.

If you are using ROS Galactic or newer, you can get the code here.

Let’s get started!

Prerequisites 

You have completed the first three tutorials of this series:

  1. How to Create a Simulated Mobile Robot in ROS 2 Using URDF
  2. Set Up the Odometry for a Simulated Mobile Robot in ROS 2
  3. Sensor Fusion Using the Robot Localization Package – ROS 2

Modify the SDF File for the Robot

Open a new terminal window, and type:

colcon_cd basic_mobile_robot
cd models
cd basic_mobile_bot_description

Type the following command:

gedit model.sdf

Here is my sdf file. You can copy and paste those lines inside your sdf file.

Here is the code for just the LIDAR:

  <!-- ****************************** LIDAR *****************************    -->
  <link name="lidar_link">    
    <inertial>
      <pose>0.215 0 0.13 0 0 0</pose>
      <inertia>
        <ixx>0.001</ixx>
        <ixy>0.000</ixy>
        <ixz>0.000</ixz>
        <iyy>0.001</iyy>
        <iyz>0.000</iyz>
        <izz>0.001</izz>
      </inertia>
      <mass>0.114</mass>
    </inertial>

    <collision name="lidar_collision">
      <pose>0.215 0 0.13 0 0 0</pose>
      <geometry>
        <cylinder>
          <radius>0.0508</radius>
          <length>0.18</length>
        </cylinder>
      </geometry>
    </collision>

    <visual name="lidar_visual">
      <pose>0.215 0 0.13 0 0 0</pose>
      <geometry>
        <cylinder>
          <radius>0.0508</radius>
          <length>0.18</length>
        </cylinder>
      </geometry>
      <material>
        <ambient>0.0 0.0 0.0 1.0</ambient>
        <diffuse>0.0 0.0 0.0 1.0</diffuse>
        <specular>0.0 0.0 0.0 1.0</specular>
        <emissive>0.0 0.0 0.0 1.0</emissive>
      </material>
    </visual>

    <sensor name="lidar" type="ray">
      <pose>0.215 0 0.215 0 0 0</pose>
      <always_on>true</always_on>
      <visualize>true</visualize>
      <update_rate>5</update_rate>
      <ray>
        <scan>
          <horizontal>
            <samples>360</samples>
            <resolution>1.00000</resolution>
            <min_angle>0.000000</min_angle>
            <max_angle>6.280000</max_angle>
          </horizontal>
        </scan>
        <range>
          <min>0.120000</min>
          <max>3.5</max>
          <resolution>0.015000</resolution>
        </range>
        <noise>
          <type>gaussian</type>
          <mean>0.0</mean>
          <stddev>0.01</stddev>
        </noise>
      </ray>
      <plugin name="scan" filename="libgazebo_ros_ray_sensor.so">
        <ros>
          <remapping>~/out:=scan</remapping>
        </ros>
        <output_type>sensor_msgs/LaserScan</output_type>
        <frame_name>lidar_link</frame_name>
      </plugin>
    </sensor>
  </link>

Save the file and close it to return to the terminal.

You’ll notice that we added the LIDAR link, joint, and Gazebo sensor plugin. I also added an inertial section to the front caster wheel.

Make sure that you have this model.config file inside the same folder as your sdf file.

Test Your SDF File

Now let’s run Gazebo so that we can see our model. Open a new terminal window, and type the following command:

gazebo

On the left-hand side, click the “Insert” tab.

On the left panel, find your robot. 

You should see your robot in the empty Gazebo environment. You can place it wherever you want by clicking inside the environment.

1-robot-scan-empty-environment

If you open a new terminal window and check out the ROS topics, you will see our /scan topic.

ros2 topic list
2-ros2-topic-list

To check out this topic, type:

ros2 topic info /scan

You will see this /scan topic has one publisher (i.e. our LIDAR).

3-ros2-topic-info-scan

To see the output of the /scan topic, you type:

ros2 topic echo /scan

You will see that the readings for all 360 beams of the LIDAR is “.inf”, which means infinity. These readings make sense since there are no objects in the environment to detect.

4-infinity-scanner-readings

Once you’re done, press CTRL+C in all windows to close everything down.

Modify the URDF File

Open a new terminal window, and type:

colcon_cd basic_mobile_robot
cd models

Create a new file named basic_mobile_bot_v2.urdf.

gedit basic_mobile_bot_v2.urdf

Inside this file, we will add a link and a joint for the LIDAR. Leave the caster wheel inertial section as-is.

Type this code inside the URDF file.

Save and close the file.

Edit the Launch File

Now that we have our robot with LIDAR, we need to modify the launch file.

colcon_cd basic_mobile_robot
cd launch
gedit basic_mobile_bot_v4.launch.py

Copy and paste this code into the file.

Save the file, and close it.

Build the Package

Now build the package by opening a terminal window, and typing the following command:

cd ~/dev_ws
colcon build

Launch the Robot

Open a new terminal, and launch the robot.

cd ~/dev_ws/
ros2 launch basic_mobile_robot basic_mobile_bot_v4.launch.py

Here is the output for Gazebo:

5-output-for-gazebo-1

Here is the output for RViz.

6-output-for-rviz

Under the TF dropdown in RViz, you should see “Transform OK” for all links.

7-transform-ok

Let’s visualize the sensor readings from the LIDAR. In RViz, make sure the Fixed Frame under Global Options is set to odom.

Click the Add button at the bottom-left part of the RViz window. Then go to the By topic tab, and select the LaserScan option under /scan. Then click OK.

8-laser-scan-topic

Under the Topic dropdown menu under LaserScan in the left panel of RViz, set the Reliability Policy to Best Effort. Set the size to 0.1 m.

9-laser-scan-settings

Now go back to a terminal window, and move the robot forward a bit so that it can start detecting that wall on the front end of the playground in Gazebo.

rqt_robot_steering

If you are using ROS 2 Galactic or newer, type:

sudo apt-get install ros-galactic-rqt-robot-steering

Where the syntax is:

sudo apt-get install ros-<ros-distribution>-rqt-robot-steering

Then type:

ros2 run rqt_robot_steering rqt_robot_steering --force-discover

You can see how the laser scan readings show up in RViz.

That’s it! 

In the next tutorial, we’ll learn how to localize and create a map using this LIDAR in conjunction with the ROS 2 Navigation Stack. Stay tuned!