编写简单的服务和客户端(C++)
编写简单的服务和客户端(C++)
目标: 使用 C++ 创建并运行服务节点和客户端节点。
教程关卡: 初学者
时间:20 分钟
Contents 目录
背景
当节点通过服务通信时,发送数据请求的节点称为客户端节点,响应请求的节点称为服务节点。请求和响应的结构由 .srv 文件确定。
这里使用的例子是一个简单的整数加法系统;一个节点请求两个整数的和,另一个节点则以结果回应。
前提条件
1 创建包
打开一个新终端,获取你的 ROS 2 安装源代码,这样 ROS2 命令才能正常工作。
进入之前教程创建的 ros2_ws 目录。
记住,包应该在 src 目录里创建,而不是在工作空间的根目录里。进入 ros2_ws/src 并创建一个新包:
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="[email protected]">Your Name</maintainer> <license>Apache-2.0</license>
在 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 功能逐行完成以下任务:
初始化 ROS 2 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 Add executable
add_executable 宏生成一个可执行文件,你可以用 ros2 run 运行。在依赖下方添加以下代码块 CMakeLists.txt 以创建可执行的命名服务器 :
add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server rclcpp example_interfaces)
为了让 ros2 run 找到可执行文件,在文件末尾 ament_package() 前添加以下几行:
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);
// Wait for the result.
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 Add executable
返回 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 里获取安装文件。启动客户端节点,后接任意两个中间空格的整数。例如,如果你选择了 2 和 3,客户会收到如下回复:
ros2 run cpp_srvcli client 2 3 [INFO] [rclcpp]: Sum: 5
返回服务节点运行的终端。你会看到它在收到请求、收到的数据以及回应时发布了日志消息:
[INFO] [rclcpp]: Incoming request a: 2 b: 3 [INFO] [rclcpp]: sending back response: [5]
在服务器终端输入 Ctrl+C 即可停止节点旋转。
摘要
你创建了两个节点来请求和响应服务中的数据。你把它们的依赖和可执行文件添加到包配置文件中,这样你就能构建和运行它们,并看到服务/客户端系统的工作。