ROS2 Jazzy:编写一个简单的服务端和客户端(C++)
目标
使用 C++ 创建并运行服务节点和客户端节点。
背景信息
当节点通过服务进行通信时,发送数据请求的节点称为客户端节点,响应请求的节点称为服务节点。请求和响应的结构由 .srv 文件决定。
这里使用的示例是一个简单的整数加法系统;一个节点请求两个整数的和,另一个节点则返回计算结果。
先决条件
在之前的教程中,你已经学习了如何创建工作空间和软件包。
操作步骤
1. 创建一个软件包
打开一个新的终端并加载你的 ROS2 安装环境,这样 ros2 命令才能正常使用。
创建工作空间 ros2_ws 目录,并在此目录下创建src目录。
进入 ros2_ws/src 目录并创建 cpp_srvcli 软件包:
ros2 pkg create --build-type ament_cmake --license Apache-2.0 cpp_srvcli --dependencies rclcpp example_interfaces
你的终端会返回一条消息,其确认 cpp_srvcli 软件包及其所有必要的文件和文件夹已创建。
参数--dependencies 会自动将必要的依赖项添加到 package.xml 和 CMakeLists.txt 文件中。软件包example_interfaces 包含了编译请求和响应所需的 .srv 文件,其内容如下:
int64 a
int64 b
---
int64 sum
其中前两行是请求的参数,分隔线---以下是响应内容。
1.1 更新package.xml
由于你在创建软件包时使用了 --dependencies 选项,所以这次不需要手动向 package.xml 或 CMakeLists.txt 文件中添加依赖项。
不过,和往常一样,还是需要在 package.xml 中添加描述、维护者的电子邮件和姓名以及许可证信息。
<description>C++ client server tutorial</description>
<maintainer email="you@email.com">Your Name</maintainer>
<license>Apache-2.0</license>
2. 编写服务节点
在 ros2_ws/src/cpp_srvcli/src 目录下,创建一个名为 add_two_ints_server.cpp 的新文件,并将以下代码粘贴进去:
#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"
#include <memory>
void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
std::shared_ptr<example_interfaces::srv::AddTwoInts::Response> response)
{
response->sum = request->a + request->b;
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
request->a, request->b);
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "sending back response: [%ld]", (long int)response->sum);
}
int main(int argc, char **argv)
{
rclcpp::init(argc, argv);
std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_server");
rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");
rclcpp::spin(node);
rclcpp::shutdown();
}
2.1 代码分析
前两个 #include 语句是你的软件包依赖项。
函数add 将请求中的两个整数相加,并将和赋给响应,同时通过日志在控制台打印它的状态。
void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
std::shared_ptr<example_interfaces::srv::AddTwoInts::Response> response)
{
response->sum = request->a + request->b;
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
request->a, request->b);
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "sending back response: [%ld]", (long int)response->sum);
}
而main 函数则逐行完成以下操作:
- 初始化 ROS2 C++ 客户端库:
rclcpp::init(argc, argv);
- 创建一个名为 add_two_ints_server 的节点:
std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_server");
- 为该节点创建一个名为 add_two_ints 的服务,并在网络上自动发布这个带 &add 方法的服务:
rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);
- 准备就绪时打印一条日志消息:
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");
- 启动节点,使服务可用。
rclcpp::spin(node);
2.2 添加可执行文件
将以下代码块添加到 CMakeLists.txt 中,创建一个名为 server 的可执行文件,其中add_executable宏会生成一个可使用 ros2 run 运行的可执行文件。:
add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server rclcpp example_interfaces)
在文件末尾的ament_package() 之前添加以下几行,使得 ros2 run 能够找到这个可执行文件,:
install(TARGETS
server
DESTINATION lib/${PROJECT_NAME})
然后你、就可以构建软件包了,你加载本地设置文件并运行它,不过还是让我们先创建客户端节点,这样你就能看到整个系统的运行情况。
3. 编写客户端节点
在 ros2_ws/src/cpp_srvcli/src 目录下,创建一个名为 add_two_ints_client.cpp 的新文件,并将以下代码粘贴进去:
#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"
#include <chrono>
#include <cstdlib>
#include <memory>
using namespace std::chrono_literals;
int main(int argc, char **argv)
{
rclcpp::init(argc, argv);
if (argc != 3) {
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "usage: add_two_ints_client X Y");
return 1;
}
std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");
auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
request->a = atoll(argv[1]);
request->b = atoll(argv[2]);
while (!client->wait_for_service(1s)) {
if (!rclcpp::ok()) {
RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Interrupted while waiting for the service. Exiting.");
return 0;
}
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "service not available, waiting again...");
}
auto result = client->async_send_request(request);
// 等待结果
if (rclcpp::spin_until_future_complete(node, result) ==
rclcpp::FutureReturnCode::SUCCESS)
{
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Sum: %ld", result.get()->sum);
} else {
RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Failed to call service add_two_ints");
}
rclcpp::shutdown();
return 0;
}
3.1 代码分析
与服务节点类似,以下代码行创建节点,然后为该节点创建客户端:
std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");
接下来,创建请求。其结构由前面提到的 .srv 文件定义。
auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
request->a = atoll(argv[1]);
request->b = atoll(argv[2]);
代码中的while 循环让客户端有 1 秒钟的时间在网络中搜索服务节点。如果找不到,它会继续等待。
RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "service not available, waiting again...");
如果客户端被取消(例如,你在终端中输入 Ctrl+C),它会返回一条错误日志消息,表明在等待服务时被中断。
RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Interrupted while waiting for the service. Exiting.");
然后客户端发送请求,节点持续运行直到收到响应或请求失败。
3.2 添加可执行文件
回到 CMakeLists.txt 文件,为新节点添加可执行文件和目标。删除文件中一些自动生成的不必要的模板代码后,你的 CMakeLists.txt 文件应如下所示:
cmake_minimum_required(VERSION 3.5)
project(cpp_srvcli)
find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(example_interfaces REQUIRED)
add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server rclcpp example_interfaces)
add_executable(client src/add_two_ints_client.cpp)
ament_target_dependencies(client rclcpp example_interfaces)
install(TARGETS
server
client
DESTINATION lib/${PROJECT_NAME})
ament_package()
4. 编译并运行
在编译之前,在工作空间的根目录(ros2_ws)中运行 rosdep 来检查是否缺少依赖项是个好习惯:
rosdep install -i --from-path src --rosdistro jazzy -y
回到工作空间的根目录 ros2_ws,编译你的新软件包:
colcon build --packages-select cpp_srvcli
打开一个新的终端,进入 ros2_ws 目录加载工作空间设置文件:
source install/setup.bash
现在可以运行服务节点了:
ros2 run cpp_srvcli server
终端应该返回以下消息,然后进入等待状态:
[INFO] [rclcpp]: Ready to add two ints.
打开另一个终端,再次在 ros2_ws 目录中加载设置文件并启动客户端节点,并在后面输入任意两个用空格分隔的整数:
ros2 run cpp_srvcli client 2 3
例如,如果你选择了 2 和 3,客户端将收到如下响应:
[INFO] [rclcpp]: Sum: 5
回到运行服务节点的终端。你会看到,服务节点在收到请求、接收到数据以及发送响应时都会发布日志消息:
[INFO] [rclcpp]: Incoming request
a: 2 b: 3
[INFO] [rclcpp]: sending back response: [5]
在服务节点的终端中输入 Ctrl+C 以停止节点运行。
总结
你创建了两个节点,通过服务进行数据请求和响应。你将它们的依赖项和可执行文件添加到软件包配置文件中,以便能够构建和运行它们,并看到一个服务/客户端系统的实际运行情况。
关注【智践行】公众号,发送 【机器人】 获得机器人经典学习资料