概要:这篇主要介绍编写发布器和侦听器的简单套路(C++)

环境:ubuntu20.04,ros2-foxy,vscode

最后如果没有陈述实操过程中碰到问题的话,则表示该章节都可被本人正常复现.

2.2.3编写一个简单的发布器和侦听器(C++)(原文:https://docs.ros.org/en/foxy/Tutorials/Writing-A-Simple-Cpp-Publisher-And-Subscriber.html

>>教程>>编写一个简单的发布器函数和侦听器函数(C++)

你正阅读的是ros2较老版本(Foxy),但仍然支持的说明文档.想查看最新版本的信息,请看galactic版本链接( https://docs.ros.org/en/galactic/Tutorials.html

编写一个简单的发布者和侦听器(C++)

目标:创建和运行用c++编写的发布器和侦听器

课程等级:初级

时长:20min

目录
1.背景
2.预备知识
3.步骤
3.1创建一个包
3.2编写一个发布器节点
3.3编写一个侦听器节点
3.4编译并运行
4.总结
5.下一步
6.相关概念

1.背景

节点是ros网络沟通的执行(载体).在本教程,节点通过话题传送一串字符.这里案例使用简单的说话者和聆听者系统.一个节点发布数据,其他订阅该话题来接收数据.

案例里面使用的代码在这里(https://github.com/ros2/examples/tree/foxy/rclcpp/topics)可以找到.

2.预备知识

前面课程,你学了如何创建工作空间和包.

3.步骤

3.1创建一个包

新开一个终端,source一下ros2安装位置,保证ros2指令都没问题.

进入前面课程创建的dev_ws(工作空间)目录.

回忆可知,这些包都是创建在src目录下面的,并不是工作空间根目录下面.所以,进入dev_ws/src目录,运行包创建指令:

ros2 pkg create --build-type ament_cmake cpp_pubsub

终端返回信息表明,你的包和相关必要的文件和文件夹都创建完成.

进入dev_ws/src/cpp_pubsub/src目录,回想起,这是cmake型包的目录,放着包含可执行文件的源码

3.2编写一个发布器节点

输入下面指令下载简单说话者的代码:

linux:

wget -O publisher_member_function.cpp https://raw.githubusercontent.com/ros2/examples/foxy/rclcpp/topics/minimal_publisher/member_function.cpp

现在多了一个publisher_member_function.cpp文件.用你喜欢的文本编辑器打开它.

#include <chrono>
#include <functional>
#include <memory>
#include <string>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"

using namespace std::chrono_literals;

/* This example creates a subclass of Node and uses std::bind() to register a
* member function as a callback from the timer. */

class MinimalPublisher : public rclcpp::Node
{
  public:
    MinimalPublisher()
    : Node("minimal_publisher"), count_(0)
    {
      publisher_ = this->create_publisher<std_msgs::msg::String>("topic", 10);
      timer_ = this->create_wall_timer(
      500ms, std::bind(&MinimalPublisher::timer_callback, this));
    }

  private:
    void timer_callback()
    {
      auto message = std_msgs::msg::String();
      message.data = "Hello, world! " + std::to_string(count_++);
      RCLCPP_INFO(this->get_logger(), "Publishing: '%s'", message.data.c_str());
      publisher_->publish(message);
    }
    rclcpp::TimerBase::SharedPtr timer_;
    rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
    size_t count_;
};

int main(int argc, char * argv[])
{
  rclcpp::init(argc, argv);
  rclcpp::spin(std::make_shared<MinimalPublisher>());
  rclcpp::shutdown();
  return 0;
}

3.2.1解析代码

代码顶部放着你要用到的标准c++头文件.标准头文件下面放着的是rclcpp/rclcpp.hpp头文件,其包含了你要使用的大部分ros2模块.最下面是std_msgs/msg/string.hpp头文件,其包含了你要构建用于发布数据的消息类型的模块.

下面几行表示了节点的依赖.想起依赖的要加到package.xmlCMakeLists.txt文件中,下一节课你要做的事情.

#include <chrono>
#include <functional>
#include <memory>
#include <string>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"

using namespace std::chrono_literals;

下一行表示节点类MinimalPublisher是继承rclcpp::Node的,代码中的每个this都指的是节点.

class MinimalPublisher : public rclcpp::Node

公共构造函数命名节点名为minimal_publisher,并且初始化count_为0.来到构造函数内部,发布器初始化了String消息类型,消息话题称为topic,缓冲区消息队列个数进行了限制.接着将timer_初始化了,其会导致回调函数timer_callback每秒执行两次.

public:
  MinimalPublisher()
  : Node("minimal_publisher"), count_(0)
  {
    publisher_ = this->create_publisher<std_msgs::msg::String>("topic", 10);
    timer_ = this->create_wall_timer(
    500ms, std::bind(&MinimalPublisher::timer_callback, this));
  }

timer_callback函数对消息内容进行了设置,然后发布出去.RCLCPP_INFO宏确保发布的每一条消息都打印到控制台上面.

private:
  void timer_callback()
  {
    auto message = std_msgs::msg::String();
    message.data = "Hello, world! " + std::to_string(count_++);
    RCLCPP_INFO(this->get_logger(), "Publishing: '%s'", message.data.c_str());
    publisher_->publish(message);
  }

最后是声明timer, publishercounter变量.

rclcpp::TimerBase::SharedPtr timer_;
rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
size_t count_;

MinimalPublisher类在主函数实例化,(并且)主函数是节点实际被执行的地方.rclcpp::init表示初始化ros2 ,rclcpp::spin开始处理来自节点的消息,包括来自timer的反馈(信息).

int main(int argc, char * argv[])
{
  rclcpp::init(argc, argv);
  rclcpp::spin(std::make_shared<MinimalPublisher>());
  rclcpp::shutdown();
  return 0;
}

3.2.2 添加依赖

进入dev_ws/src/cpp_pubsub目录,里面有你已经创建的CMakeLists.txtpackage.xml文件

文本编辑器内打开package.xml

如同前面课程所说的,保证填写好<description>, <maintainer> <license>标签内容.

<description>Examples of minimal publisher/subscriber using rclcpp</description>
<maintainer email="you@email.com">Your Name</maintainer>
<license>Apache License 2.0</license>

增加一行在ament_cmake编译工具依赖后面,根据节点中所声明来粘贴下面依赖:

<depend>rclcpp</depend>
<depend>std_msgs</depend>

这里声明当代码执行时,包需要rclcppstd_msgs

记得保存文件.

3.2.3CMakeLists.txt

现在打开CMakeLists.txt文件,在find_package(ament_cmake REQUIRED)这行依赖下面,添加这几行:

find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

操作完上面后,添加可执行文件并命名为talker,这样子,你就可以使用ros2 run来运行这个节点了:

add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp std_msgs)

最后,添加install(TARGETS…)部分,这样子,ros2 run就可以找到你的可执行文件:

install(TARGETS
  talker
  DESTINATION lib/${PROJECT_NAME})

你也可以清理CMakeLists.txt里面不必要内容和注释,(操作完后)这文件会长这样子:

cmake_minimum_required(VERSION 3.5)
project(cpp_pubsub)

Default to C++14
if(NOT CMAKE_CXX_STANDARD)
  set(CMAKE_CXX_STANDARD 14)
endif()

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

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp std_msgs)

install(TARGETS
  talker
  DESTINATION lib/${PROJECT_NAME})

ament_package()

现在你可以编译你的包,source一下本地配置文件,并且运行.让我们创建一个侦听器节点,这样子你就可以看到整个系统运行了.

3.3编写一个侦听器节点

返回dev_ws/src/cpp_pubsub/src目录,创建另外一个节点.终端输入下面指令:

wget -O subscriber_member_function.cpp https://raw.githubusercontent.com/ros2/examples/foxy/rclcpp/topics/minimal_subscriber/member_function.cpp

控制台输入ls,会返回信息:

publisher_member_function.cpp  subscriber_member_function.cpp

用你的文本编辑器打开subscriber_member_function.cpp文件:

#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
using std::placeholders::_1;

class MinimalSubscriber : public rclcpp::Node
{
  public:
    MinimalSubscriber()
    : Node("minimal_subscriber")
    {
      subscription_ = this->create_subscription<std_msgs::msg::String>(
      "topic", 10, std::bind(&MinimalSubscriber::topic_callback, this, _1));
    }

  private:
    void topic_callback(const std_msgs::msg::String::SharedPtr msg) const
    {
      RCLCPP_INFO(this->get_logger(), "I heard: '%s'", msg->data.c_str());
    }
    rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;
};

int main(int argc, char * argv[])
{
  rclcpp::init(argc, argv);
  rclcpp::spin(std::make_shared<MinimalSubscriber>());
  rclcpp::shutdown();
  return 0;
}

3.3.1解析代码

侦听器节点代码和发布器代码差不多.现在的节点名字是minimal_subscriber,构造函数使用节点create_subscription类实现回调.

这里没有timer ,因为侦听器是简单响应任何时候topic话题发布(的消息).

public:
  MinimalSubscriber()
  : Node("minimal_subscriber")
  {
    subscription_ = this->create_subscription<std_msgs::msg::String>(
    "topic", 10, std::bind(&MinimalSubscriber::topic_callback, this, _1));
  }

回想之前话题课程,发布器和侦听器两者话题的名称和消息类型一定要一致才能实现两者的通信.

topic_callback函数接受话题发布的字符串信息,并且使用RCLCPP_INFO宏来简单写到控制台上面.

文件中侦听器类唯一描写地方:

private:
  void topic_callback(const std_msgs::msg::String::SharedPtr msg) const
  {
    RCLCPP_INFO(this->get_logger(), "I heard: '%s'", msg->data.c_str());
  }
  rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;

主函数和上面基本相同,除了这里是MinimalSubscriber节点外.对于发布器而言,循环开始表示启动计时器timer,但是侦听器只是简单接受任何时间发送过来的消息(所以没有计时器这玩意).

由于该节点的依赖和发布器节点一样,这里并没有什么再写到package.xml里面了.

3.3.2CMakeLists.txt

重新打开CMakeLists.txt,在发布器部分下面,添加侦听器的executable target内容.

add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp std_msgs)

install(TARGETS
  talker
  listener
  DESTINATION lib/${PROJECT_NAME})

保存文件,然后你的 pub/sub 系统准备可以用了.

3.4编译并运行

安装ros2系统时候,你可能已经安装了rclcppstd_msgs包.编译前,在工作空间(dev_ws)根目录执行rosdep来检查却少的依赖是一个很好的练习.

linux:

rosdep install -i --from-path src --rosdistro <distro> -y

也是在dev_ws工作空间的根目录,编译你的包:

colcon build --packages-select cpp_pubsub

新开终端,进入dev_ws目录,source一下配置文件:

linux:

. install/setup.bash

现在运行talker节点:

ros2 run cpp_pubsub talker

终端会每隔0.5秒发布一次消息.大概这样子:

[INFO] [minimal_publisher]: Publishing: "Hello World: 0"
[INFO] [minimal_publisher]: Publishing: "Hello World: 1"
[INFO] [minimal_publisher]: Publishing: "Hello World: 2"
[INFO] [minimal_publisher]: Publishing: "Hello World: 3"
[INFO] [minimal_publisher]: Publishing: "Hello World: 4"

打开另外一个终端,同样进入dev_ws目录,source一次该空间环境变量,然后运行listener节点:

ros2 run cpp_pubsub listener

无论发布器开始发布多少消息,listener都会开始打印消息到终端上面,大概如:

[INFO] [minimal_subscriber]: I heard: "Hello World: 10"
[INFO] [minimal_subscriber]: I heard: "Hello World: 11"
[INFO] [minimal_subscriber]: I heard: "Hello World: 12"
[INFO] [minimal_subscriber]: I heard: "Hello World: 13"
[INFO] [minimal_subscriber]: I heard: "Hello World: 14"

每个终端输入ctrl+c,终止循环进行的节点.

4.总结

你创建了两个节点去发布和监听话题数据.在编译和执行它们之前,你添加了相应的依赖和可执行资料到它们配置文件.

5.下一步

接下来,你使用服务器或客户端模块编写另外一个简单ros2包.你也是既可以选择c++也可以选择python进行编写.

6.相关概念

c++编写发布器和监听器的方式有多种可供你选择.可以在这里(https://github.com/ros2/examples/tree/foxy/rclcpp/topics)查看minimal_publisherminimal_subscriber包.

其他

个人认为重点:

发布器和监听器的函数语句含义理解,CMakeLists.txt 和 `package.xml相应的依赖内容添加.

这课程是在等毕业证那十几天搞的,室友问,现在在线翻译这么强大,为啥还在这里瞎折腾呢?我说,我的目地是好好认真看一下,了解一下,自己折腾,目前是我想到最好的办法来获得最佳效果,即使这翻译有点别扭,哈哈哈.

#####################
不积硅步,无以至千里
好记性不如烂笔头
感觉有点收获的话,麻烦大大们点赞收藏哈