This tutorial is created by Robotics Ambassador 023 Enzo

Rosbotics Ambassador Program https://www.theconstruct.ai/rosbotics-ambassador/)
Cours: ROS2 Basics in 5 Days C++: https://app.theconstructsim.com/courses/133

Introduction

Le but de ce tutoriel est d’apprendre à créer et utiliser des bibliothèques dans les packages ROS2 C++. Lors du développement d’un projet, il est essentiel de garder son code structuré pour assurer un développement efficace. L’utilisation de bibliothèque (ou library) est indispensable pour cela car cela permet de regrouper les codes sources en fonction de leurs usages et donc de séparer des fonctionnalités distinctes. La création de bibliothèques est donc essentielle pour rendre votre code plus structuré, modulaire et réutilisable. Nous allons donc voir ensemble comment déclarer et faire appel une library dans les packages ROS2 C++. Nous allons dans un premier temps voir comment simplement utiliser un header dans un package ROS2 puis nous déclarerons la même bibliothèque dans un package indépendant et utiliserons celle ci dans un autre package.

Pré-requis

Pour lancer et tester le code, vous devez lancer la simulation du turtlebot3 sur gazebo. Pour faire cela, entez les commandes suivantes dans le terminal:

# Declare le model de turtlebot3 à simuler
export TURTLEBOT3_MODEL=waffle_pi
# Lance la simulation du turtlebot dans gazebo
ros2 launch turtlebot3_gazebo turtlebot3_world.launch.py

Vous devriez obtenir le résultat suivant:

Si vous voulez effectuer le tutoriel sur votre installation local, vous devez avoir ROS2 installé (https://docs.ros.org/en/humble/Installation.html), avoir configuré un workspace (https://docs.ros.org/en/humble/Tutorials/Beginner-Client-Libraries/Creating-A-Workspace/Creating-A-Workspace.html) et avoir installé le turtlebot3.

# pour installer tous les packages du turtlebot3
# remplacez humble par votre distro ROS2
sudo apt-get install ros-humble-turtlebot3*
# n'oubliez pas d'exporter le modèle de Turtlebot3 que vous souhaitez utiliser
export TURTLEBOT3_MODEL=waffle_pi

Méthode 1: Utiliser un header dans un package ROS2 C++

Nous allons commencer par créer le package C++ qui va contenir le code et le header:

cd ~/ros2_ws/src
ros2 pkg create cpp_header_package --build-type ament_cmake --dependencies rclcpp nav_msgs geometry_msgs

On va créer le fichier header odometry_toolbox.hpp dans le dossier include/cpp_header_package qui va contenir notre class avec les prototypes des méthodes que nous allons importer dans le node:

cd ~/ros2_ws/src/cpp_header_package/include/cpp_header_package
touch odometry_toolbox.hpp

Affichez l’éditeur de code et ouvrez le fichier odometry_toolbox.hpp. Ajouter ensuite le code suivant:

On crée ensuite le fichier source odometry_toolbox.cpp dans le folder src qui va contenir la déclaration des méthodes de la class OdometryToolbox.

cd ~/ros2_ws/src/cpp_header_package/src
touch odometry_toolbox.cpp

Affichez l’éditeur de code et ouvrez le fichier odometry_toolbox.cpp. Ajouter ensuite le code suivant:

Ce code d’exemple déclare une class contenant une méthode permettant de soustraire terme à terme la position d’une odom avec une autre et de retourner le point obtenu. Cela va être utilisé pour appliquée une offset sur l’odometry avec la position initiale lors du lancement du node, la position publiée sur /point_with_offset commencera à (0.0, 0.0, 0.0).

On va ensuite créer le ROS node c++ qui va importer la class OdometryToolbox et va l’utiliser dans le callback du topic /odom.

cd ~/ros2_ws/src/cpp_header_package/src
touch main.cpp

 Ouvrez le fichier main.cpp et ajouter le code suivant:

// main.cpp

#include "cpp_header_package/odometry_toolbox.hpp"

#include "nav_msgs/msg/odometry.hpp"

#include "geometry_msgs/msg/point.hpp"

#include "rclcpp/rclcpp.hpp"

#include <iostream>

​

class OdomRepublisherNode : public rclcpp::Node {

public:

  OdomRepublisherNode() : Node("odom_republisher") {

    // Create a subscriber to the odometry topic

    odom_subscription_ = this->create_subscription<nav_msgs::msg::Odometry>(

        "odom", 10,

        std::bind(&OdomRepublisherNode::odomCallback, this,

                  std::placeholders::_1));

​

    // Create a publisher to republish the odometry

    point_publisher_ = this->create_publisher<geometry_msgs::msg::Point>(

        "point_with_offset", 10);

    is_odom_init = false;

  }

​

private:

  void odomCallback(const nav_msgs::msg::Odometry::SharedPtr msg) {

​

    geometry_msgs::msg::Point point_with_offset;

    // Use the odom message as input and substract it with its initial value

    // at node start and republish it

    if (is_odom_init == false) {

      init_odom = *msg;

      is_odom_init = true;

    }

​

    // Call the function from the imported header

    OdometryToolbox::point_from_odom_offset_init(*msg, init_odom,

                                                 point_with_offset);

​

    // Republish the received odometry message

    point_publisher_->publish(point_with_offset);

  }

​

  rclcpp::Subscription<nav_msgs::msg::Odometry>::SharedPtr odom_subscription_;

  rclcpp::Publisher<geometry_msgs::msg::Point>::SharedPtr point_publisher_;

  bool is_odom_init;

  nav_msgs::msg::Odometry init_odom;

};

​

int main(int argc, char **argv) {

  rclcpp::init(argc, argv);

  auto node = std::make_shared<OdomRepublisherNode>();

  rclcpp::spin(node);

  rclcpp::shutdown();

  return 0;

}

Une fois que tous les fichiers sont créés, votre package devrait ressembler à cela:

Vous devez ensuite mettre à jour le CMakeLists.txt pour créer l’executable et le lié la bibliothèque créée:

cmake_minimum_required(VERSION 3.8)
project(cpp_header_package)

if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  add_compile_options(-Wall -Wextra -Wpedantic)
endif()

# find dependencies
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(nav_msgs REQUIRED)
find_package(geometry_msgs REQUIRED)

# On laisse le compilateur chercher les headers dans le dossier include
include_directories(include)

# Créer l'executable en indiquant le fichier source de la bibliothèque
add_executable(my_node src/main.cpp src/odometry_toolbox.cpp)

# Indique le lien entre l'executable et les libraries requises
ament_target_dependencies(my_node rclcpp nav_msgs geometry_msgs geometry_msgs)

# Installe l'executable
install(TARGETS
my_node
DESTINATION lib/${PROJECT_NAME})

# Install les fichiers header
install(DIRECTORY
  include/
  DESTINATION include/${PROJECT_NAME})

# Install other files
install(FILES
  package.xml
  DESTINATION share/${PROJECT_NAME})

ament_package()

Vous pouvez compiler le package pour tester que tout fonctionne:

cd ~/ros2_ws
colcon build
source install/setup.bash

Methode 2: Utiliser un package indépendant comme bibliothèque

Part 1: Créer un package qui va contenir le source code de la library

Part 2: Créer un package qui va utiliser la library créée précédemment

Step 3: Tester le node

 

Merci d’avoir suivi ce poste.

Ressources

• ROS Ignite Academy
• ROS2 Full course for beginner
• Rosject utilisé pour le poste

Feedback

Cet article vous a plu ? Avez-vous des questions sur ce qui est expliqué ? Quoi qu’il en soit, n’hésitez pas à laisser un commentaire dans la section des commentaires ci-dessous, afin que nous puissions interagir et apprendre les uns des autres.

Si vous souhaitez en savoir plus sur d’autres sujets liés à ROS, faites-le nous savoir dans l’espace commentaires et nous ferons une vidéo ou un article à ce sujet.
Topics: ROS Q&A | ros2

Video Tutorial