ROS 2 Iron 教程 第二章 Client libraries 第四节 编写一个简单的发布者和订阅者(C++)
前言
本系列文章是由笔者翻译自ROS 2 官方教程。笔者水平有限,如有错误,还请读者指正。
本节教程中部分代码为 Liunx下,请使用其他操作系统的读者前往原文查看。
背景
节点是通过 ROS 图进行通信的可执行进程。在本节教程中,节点将会以字符串消息的形式在话题上传递消息。在教程中的示例是一个简单的“诉说者”和“倾听者”系统;一个节点发布数据,另一个订阅话题来接收数据。
此处 可以找到示例中使用的代码。
先决条件
在过去教程中,你已经学会了如何创建一个工作空间以及一个包。
任务
1 Create a package (创建一个包)
打开一个新终端并添加你的 ROS 2 安装,这样ros2
命令将会工作。
使用cd
进入在过去教程中已经创建的ros2_ws
目录。
请回忆一下,包应该被创建在src
目录中,而不是工作空间的根目录。所以,cd
进入ros2_ws/src
目录,运行以下创建包命令:
ros2 pkg create --build-type ament_cmake --license Apache-2.0 cpp_pubsub
你的终端将会返回信息以证明cpp_pubsub
包的创建以及必要文件和文件夹创建成功。
cd
进入ros2_ws/src/cpp_pubsub/src
目录,回忆一下这个目录在任何Cmake包中存放可执行文件的源代码。
2 Write the publisher node (编写发布者节点)
运行如下名命令下载示例发布者节点源码(Liunx):
wget -O publisher_member_function.cpp https://raw.githubusercontent.com/ros2/examples/iron/rclcpp/topics/minimal_publisher/member_function.cpp
现在在ros2_ws/src/cpp_pubsub/src
目录中有一个新文件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;
}
2.1 Examine the code (分析代码)
代码的开头包含了标准C++头文件,在标准头文件后是rclcpp/rclcpp.hpp
,该头文件允许你使用 ROS 2 基础部分,最后则是std_msgs/msg/string.hpp
,包含了你将会用于发布数据的内建数据类型。
#include <chrono>
#include <functional>
#include <memory>
#include <string>
#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
using namespace std::chrono_literals;
这几行说明了节点的依赖。回忆一下,依赖应该被加入package.xml
和CMakeLists.txt
,你将会在下一部分做这件事。
下一行创建了节点类MinimalPublisher
,继承自rclcpp:Node
。代码中的每一个this
指代节点。
class MinimalPublisher : public rclcpp::Node
public构造函数将节点命名为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);
}
最后是定时器,发布者和计数器字段的声明。
rclcpp::TimerBase::SharedPtr timer_;
rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
size_t count_;
跟随在MinimalPublisher
类后的是main
函数,在main
函数是实际执行节点的位置。rclcpp::init
初始化 ROS 2 ,rclcpp:spin
开始从节点处理数据,包括定时器的回调。
int main(int argc, char * argv[])
{
rclcpp::init(argc, argv);
rclcpp::spin(std::make_shared<MinimalPublisher>());
rclcpp::shutdown();
return 0;
}
2.2 Add dependencies (添加依赖)
返回上一级目录,进入ros2_ws/src/cpp_pubsub
目录,在此,CMakeLists.txt
和package.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>
这声明了本包代码在构建以及执行时需要rclcpp
和srd_msgs
。
确保文件被保存。
2.3 CMakeLists.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()
你可以构建你的包了,随后添加本地启动文件,并运行它,但让我们先创建一个订阅者节点以让你看到整个系统的运行。
3 Write the subscriber node (编写订阅者节点)
cd
回到ros2_ws/src/cpp_pubsub/src
创建下一个节点。在你的终端中运行如下命令(Liunx):
wget -O subscriber_member_function.cpp https://raw.githubusercontent.com/ros2/examples/iron/rclcpp/topics/minimal_subscriber/member_function.cpp
检查如下文件是否存在:
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 & 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.1 Examine the code (分析代码)
订阅者节点的代码与发布者的代码几乎相同。在订阅者节点的源码中,节点被命名为minimal_subscriber
,构造函数使用节点的create_subscription
类来执行回调。
在订阅者中没有定时器,因为订阅者在收到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 & msg) const
{
RCLCPP_INFO(this->get_logger(), "I heard: '%s'", msg.data.c_str());
}
rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;
main
函数几乎与发布者一样,除了在此它启动MinimalSubscriber
节点。对于发布者节点,启动节点的同时定时器也将运行,但对于订阅者节点来说,启动节点仅仅意味着节点随时准备好接收消息。
既然订阅者节点同发布者节点有相同的依赖,package.xml
无需再添加内容。
3.2 CMakeLists.txt
重新打开CMakeLists.txt
并再发布者的内容下方为订阅者节点添加可执行文件和目标。
add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp std_msgs)
install(TARGETS
talker
listener
DESTINATION lib/${PROJECT_NAME})
确保文件被保存,随后你的发布及接收系统就准备就绪了。
4 Build and run (构建并运行)
你的 ROS 2 系统中应该已经有了rclcpp
和std_msgs
包,构建前在工作空间根目录运行rosdep
来查找是否有缺失的包是好的习惯(Liunx):
rosdep install -i --from-path src --rosdistro iron -y
仍然在你工作空间的根目录ros2_ws
,构建你的新包( Liunx):
colcon build --packages-select cpp_pubsub
打开一个新终端,cd
进入ros2_ws
,并添加启动文件:
. install/setup.bash
现在运行发布者节点:
ros2 run cpp_pubsub talker
终端应该开始每隔0.5s发布信息:
[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"
打开另一个终端,再次添加启动文件,随后启动订阅者节点:
ros2 run cpp_pubsub 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
来停止节点运行。
总结
在本节教程中我们创建了两个节点来发布和订阅话题上的数据。在编译和运行它们之前,我们已将其依赖项和可执行文件添加到包配置文件中。