ROS2 Jazzy：创建自定义的消息和服务接口（C++）

目标

创建自定义的接口文件（.msg 和 .srv），并在节点中使用它们。

背景信息

在之前的教程中，你使用消息和服务接口学习了话题、服务，以及简单的发布者/订阅者（C++）和服务/客户端节点。在那些案例中，你使用的接口是预先定义好的。

虽然使用预定义的接口定义是一种良好的做法，但有时你可能也需要定义自己的消息和服务。本文将向你介绍创建自定义接口定义的最简单方法。

先决条件

你应该有一个 ROS2 工作空间。

本文还会使用之前在发布者/订阅者以及服务/客户端教程中创建的软件包来测试新的自定义消息。

操作步骤

1. 创建一个新的软件包

在本文中，你将在一个单独的软件包中创建自定义的 .msg 和 .srv 文件，然后在另一个软件包中使用它们。这两个软件包应该位于同一个工作空间中。

由于我们将使用之前教程中创建的发布/订阅和服务/客户端软件包，所以请确保你处于与这些软件包相同的工作空间（ros2_ws/src）中，然后运行以下命令来创建一个新的软件包：

bash 复制代码

ros2 pkg create --build-type ament_cmake --license Apache-2.0 tutorial_interfaces

tutorial_interfaces 是新软件包的名称。请注意，虽然它只能是一个 CMake 软件包，但这并不限制你在何种类型的软件包中使用你的消息和服务。你可以在一个 CMake 软件包中创建自己的自定义接口，然后在 C++ 或 Python 节点中使用它，这将在最后一部分进行介绍。

.msg 和 .srv 文件需要分别放在名为 msg 和 srv 的目录中。在 ros2_ws/src/tutorial_interfaces 中创建这些目录：

bash 复制代码

mkdir msg srv

2. 创建自定义消息和服务

2.1 msg 定义

在你刚刚创建的 tutorial_interfaces/msg 目录中，创建一个名为 Num.msg 的新文件，其中包含一行代码来声明其数据结构：

go 复制代码

int64 num

这是一个自定义消息，用于传输一个名为 num 的 64 位整数。

同样在你刚刚创建的 tutorial_interfaces/msg 目录中，创建一个名为 Sphere.msg 的新文件，内容如下：

go 复制代码

geometry_msgs/Point center
float64 radius

这个自定义消息使用了另一个消息包中的消息（在这种情况下是 geometry_msgs/Point）。

2.2 srv 定义

回到你刚刚创建的 tutorial_interfaces/srv 目录，创建一个名为 AddThreeInts.srv 的新文件，其请求和响应结构如下：

yaml 复制代码

int64 a
int64 b
int64 c
---
int64 sum

这是你的自定义服务，它请求三个名为 a、b 和 c 的整数，并以一个名为 sum 的整数作为响应。

3. `CMakeLists.txt` 文件配置

为了将你定义的接口转换为特定语言的代码（如 C++ 和 Python），以便在这些语言中使用，将以下行添加到 CMakeLists.txt 中：

cmake 复制代码

find_package(geometry_msgs REQUIRED)
find_package(rosidl_default_generators REQUIRED)

rosidl_generate_interfaces(${PROJECT_NAME}
  "msg/Num.msg"
  "msg/Sphere.msg"
  "srv/AddThreeInts.srv"
  DEPENDENCIES geometry_msgs # 添加上述消息所依赖的软件包，在这种情况下，Sphere.msg 依赖于 geometry_msgs
)

注意：rosidl_generate_interfaces 中的第一个参数（库名）必须以软件包的名称开头，例如，简单地使用 ${PROJECT_NAME} 或 ${PROJECT_NAME}_suffix。具体请参阅 github.com/ros2/rosidl...

4. `package.xml` 文件配置

由于接口依赖于 rosidl_default_generators 来生成特定语言的代码，你需要声明对它的编译工具依赖。rosidl_default_runtime 是一个运行时或执行阶段的依赖项，后续使用接口时需要它。你的接口依赖rosidl_interface_packages group，所以你的软件包 tutorial_interfaces 应该使用 <member_of_group> 标签与之关联。

在 package.xml 的 <package> 元素内添加以下行：

xml 复制代码

<depend>geometry_msgs</depend>
<buildtool_depend>rosidl_default_generators</buildtool_depend>
<exec_depend>rosidl_default_runtime</exec_depend>
<member_of_group>rosidl_interface_packages</member_of_group>

5. 编译 `tutorial_interfaces` 软件包

现在，你自定义接口软件包的所有部分都已就位，你可以编译该软件包了。在你的工作空间根目录（~/ros2_ws）中，运行以下命令：

bash 复制代码

colcon build --packages-select tutorial_interfaces

现在，其他 ROS2 软件包就可以发现这些接口了。

6. 确认 msg 和 srv 文件已创建

在一个新的终端中，在你的工作空间（ros2_ws）内运行以下命令来加载环境：

bash 复制代码

source install/setup.bash

现在，你可以使用 ros2 interface show 命令来确认你的接口创建是否成功：

bash 复制代码

ros2 interface show tutorial_interfaces/msg/Num

应该返回：

go 复制代码

int64 num

以及

bash 复制代码

ros2 interface show tutorial_interfaces/msg/Sphere

应该返回：

go 复制代码

geometry_msgs/Point center
        float64 x
        float64 y
        float64 z
float64 radius

还有

bash 复制代码

ros2 interface show tutorial_interfaces/srv/AddThreeInts

应该返回：

yaml 复制代码

int64 a
int64 b
int64 c
---
int64 sum

7. 测试新接口

在这一步，你可以使用在之前教程中创建的软件包。对节点CMakeLists.txt 和 package.xml 文件进行一些简单的修改，就可以使用你的新接口了。

7.1 使用发布/订阅测试 `Num.msg`

对之前教程中创建的发布者/订阅者软件包进行一些修改，你就可以看到 Num.msg 的实际应用了。由于你将把标准的字符串消息改为数值消息，输出会稍有不同。

发布者（C++）

cpp 复制代码

#include <chrono>
#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/msg/num.hpp"  // 新的num msg 头文件

using namespace std::chrono_literals;

class MinimalPublisher : public rclcpp::Node
{
public:
  MinimalPublisher()
  : Node("minimal_publisher"), count_(0)
  {
    publisher_ = this->create_publisher<tutorial_interfaces::msg::Num>("topic", 10);  // 创建num msg发布者

    auto timer_callback = [this](){
      auto message = tutorial_interfaces::msg::Num();                                   // 建num msg
      message.num = this->count_++;                                                     // 增加计数
      RCLCPP_INFO_STREAM(this->get_logger(), "Publishing: '" << message.num << "'");    // 输出message.num日志
      publisher_->publish(message);
    };
    timer_ = this->create_wall_timer(500ms, timer_callback);
  }

private:
  rclcpp::TimerBase::SharedPtr timer_;
  rclcpp::Publisher<tutorial_interfaces::msg::Num>::SharedPtr publisher_;             // 定义num msg发布者
  size_t count_;
};

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

订阅者（C++）

cpp 复制代码

#include <functional>
#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/msg/num.hpp" // 新的num msg 头文件

using std::placeholders::_1;

class MinimalSubscriber : public rclcpp::Node
{
public:
  MinimalSubscriber()
  : Node("minimal_subscriber")
  {
    auto topic_callback = [this](const tutorial_interfaces::msg::Num & msg){     // 创建 num msg 定阅者回回调
      RCLCPP_INFO_STREAM(this->get_logger(), "I heard: '" << msg.num << "'");    // 收到 msg msg 后输出日志
    };
    subscription_ = this->create_subscription<tutorial_interfaces::msg::Num>(    // 创建定阅者
      "topic", 10, topic_callback);
  }

private:
  rclcpp::Subscription<tutorial_interfaces::msg::Num>::SharedPtr subscription_;  // 定义定阅者
};

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

CMakeLists.txt（C++） 添加以下行：

cmake 复制代码

#...

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(tutorial_interfaces REQUIRED)                      # 添加依赖

add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp tutorial_interfaces)    # 增加可执行文件

add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp tutorial_interfaces)  # 增加可执行文件

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

ament_package()

package.xml 添加以下行：

xml 复制代码

<depend>tutorial_interfaces</depend>

进行上述编辑并保存所有更改后，编译软件包：

Linux/macOS：

bash 复制代码

colcon build --packages-select cpp_pubsub

Windows：

bash 复制代码

colcon build --merge-install --packages-select cpp_pubsub

然后打开两个新终端，在每个终端中加载 ros2_ws 环境，然后运行：

bash 复制代码

ros2 run cpp_pubsub talker
ros2 run cpp_pubsub listener

由于 Num.msg 只传递一个整数，发布者应该发布整数值，而不是之前发布的字符串：

csharp 复制代码

[INFO] [minimal_publisher]: Publishing: '0'
[INFO] [minimal_publisher]: Publishing: '1'
[INFO] [minimal_publisher]: Publishing: '2'

7.2 使用服务/客户端测试 `AddThreeInts.srv`

对之前教程中创建的服务/客户端软件包（C++ 或 Python）进行一些修改，你就可以看到 AddThreeInts.srv 的实际应用了。由于你将把原来的两个整数请求服务改为三个整数请求服务，输出会稍有不同。

服务端（C++）

cpp 复制代码

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/srv/add_three_ints.hpp"                                        // 更改

#include <memory>

void add(const std::shared_ptr<tutorial_interfaces::srv::AddThreeInts::Request> request,     // 更改
          std::shared_ptr<tutorial_interfaces::srv::AddThreeInts::Response>       response)  // 更改
{
  response->sum = request->a + request->b + request->c;                                      // 更改
  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld" " c: %ld",  // 更改
                request->a, request->b, request->c);                                         // 更改
  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_three_ints_server");   // 更改

  rclcpp::Service<tutorial_interfaces::srv::AddThreeInts>::SharedPtr service =               // 更改
    node->create_service<tutorial_interfaces::srv::AddThreeInts>("add_three_ints",  &add);   // 更改

  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add three ints.");                     // 更改

  rclcpp::spin(node);
  rclcpp::shutdown();
}

客户端（C++）

cpp 复制代码

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/srv/add_three_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 != 4) { // 更改
      RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "usage: add_three_ints_client X Y Z");      // 更改
      return 1;
  }

  std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_three_ints_client");  // 更改
  rclcpp::Client<tutorial_interfaces::srv::AddThreeInts>::SharedPtr client =                // 更改
    node->create_client<tutorial_interfaces::srv::AddThreeInts>("add_three_ints");          // 更改

  auto request = std::make_shared<tutorial_interfaces::srv::AddThreeInts::Request>();       // 更改
  request->a = atoll(argv[1]);
  request->b = atoll(argv[2]);
  request->c = atoll(argv[3]);                                                              // 更改

  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_three_ints");    // 更改
  }

  rclcpp::shutdown();
  return 0;
}

CMakeLists.txt（C++） 添加以下行：

cmake 复制代码

#...

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(tutorial_interfaces REQUIRED)         # 更改

add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server
  rclcpp tutorial_interfaces)                      # 更改

add_executable(client src/add_two_ints_client.cpp)
ament_target_dependencies(client
  rclcpp tutorial_interfaces)                      # 更改

install(TARGETS
  server
  client
  DESTINATION lib/${PROJECT_NAME})

ament_package()

package.xml 添加以下行：

xml 复制代码

<depend>tutorial_interfaces</depend>

进行上述编辑并保存所有更改后，构建软件包：

Linux/macOS：

bash 复制代码

colcon build --packages-select cpp_srvcli

Windows：

bash 复制代码

colcon build --merge-install --packages-select cpp_srvcli

然后打开两个新终端，在每个终端中加载 ros2_ws 环境，然后运行：

bash 复制代码

ros2 run cpp_srvcli server
ros2 run cpp_srvcli client 2 3 1

总结

在本教程中，你学习了如何在自己的软件包中创建自定义接口，以及如何在其他软件包中使用这些接口。

关注【智践行】公众号，发送【机器人】获得机器人经典学习资料

ROS2 Jazzy：创建自定义的消息和服务接口（C++）

目标

背景信息

先决条件

操作步骤

1. 创建一个新的软件包

2. 创建自定义消息和服务

2.1 msg 定义

2.2 srv 定义

3. CMakeLists.txt 文件配置

4. package.xml 文件配置

5. 编译 tutorial_interfaces 软件包

6. 确认 msg 和 srv 文件已创建

7. 测试新接口

7.1 使用发布/订阅测试 Num.msg

7.2 使用服务/客户端测试 AddThreeInts.srv

总结

3. `CMakeLists.txt` 文件配置

4. `package.xml` 文件配置

5. 编译 `tutorial_interfaces` 软件包

7.1 使用发布/订阅测试 `Num.msg`

7.2 使用服务/客户端测试 `AddThreeInts.srv`