【ROS2指南-14】创建自定义的消息和服务

目标：自定义接口文件（.msg和.srv）并将它们与 Python 和 C++ 节点一起使用。

教程级别：初学者

时间： 20分钟

内容

• 背景

• 先决条件

• 任务

  • 1 创建一个新包

  • 2 创建自定义定义

  • 3个CMakeLists.txt

  • 4个package.xml

  • 5 构建tutorial_interfaces包

  • 6 确认 msg 和 srv 创建

  • 7 测试新接口

• 概括

• 下一步

背景

在之前的教程中，您利用消息和服务接口来了解主题、服务以及简单的发布者/订阅者 ( C++ / Python ) 和服务/客户端 ( C++ / Python ) 节点。在那些情况下，您使用的接口是预定义的。

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

先决条件

您应该有一个ROS 2 工作区。

本教程还使用在发布者/订阅者（ C++和Python）和服务/客户端（C++和Python ）教程中创建的包来尝试新的自定义消息。

任务

1 创建一个新包

对于本教程，您将在自己的包中创建自定义.msg和.srv文件，然后在单独的包中使用它们。这两个包应该在同一个工作区中。

由于我们将使用在早期教程中创建的 pub/sub 和服务/客户端包，请确保您与这些包位于同一工作区 ( dev_ws/src)，然后运行以下命令创建一个新包：

ros2 pkg create --build-type ament_cmake tutorial_interfaces

tutorial_interfaces是新包的名称。请注意，它是一个 CMake 包；目前没有办法在纯 Python 包中生成.msg或文件.srv，您可以在 CMake 包中创建自定义接口，然后在 Python 节点中使用它，这将在最后一节中介绍。

.msg将和.srv文件保存在包中它们自己的目录中是一种很好的做法。在以下位置创建目录dev_ws/src/tutorial_interfaces：

mkdir msg

mkdir srv

2.1 消息定义

在tutorial_interfaces/msg目录中，创建一个新文件：Num.msg，使用一行代码声明其数据结构：

int64 num

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

2.2 srv定义

回到tutorial_interfaces/srv您刚刚创建的目录，创建一个新文件，AddThreeInts.srv使用以下请求和响应结构调用：

int64 a
int64 b
int64 c
---
int64 sum

这是您的自定义服务，它请求三个整数a，b,c的和，响应sum。

3、CMakeLists.txt

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

find_package(rosidl_default_generators REQUIRED)

rosidl_generate_interfaces(${PROJECT_NAME}
  "msg/Num.msg"
  "srv/AddThreeInts.srv"
 )

4、package.xml

因为接口依赖rosidl_default_generators于生成特定于语言的代码，所以您需要声明对它的依赖。将以下行添加到package.xml

<build_depend>rosidl_default_generators</build_depend>

<exec_depend>rosidl_default_runtime</exec_depend>

<member_of_group>rosidl_interface_packages</member_of_group>

5 构建tutorial_interfaces包

现在您的自定义接口包的所有部分都已准备就绪，您可以构建该包。在工作区的根目录中 ~/dev_ws，运行以下命令：

colcon build --packages-select tutorial_interfaces

现在这些接口将可以被其他 ROS 2 包发现。

6 确认 msg 和 srv 创建

在新终端中，从您的工作区 ( ) 中运行以下命令dev_ws以获取它：

. install/setup.bash

现在您可以使用以下命令确认您的界面创建是否有效：ros2 interface show

ros2 msg show tutorial_interfaces/msg/Num

应该返回：

int64 num

和

ros2 srv show tutorial_interfaces/srv/AddThreeInts

应该返回：

int64 a
int64 b
int64 c
---
int64 sum

7 测试新接口

对于此步骤，您可以使用在之前的教程中创建的包。CMakeLists对节点和文件进行一些简单的修改package将允许您使用新界面。

7.1 Num.msg发布/订阅测试

通过对之前教程（C++或Python）中创建的发布者/订阅者包进行一些细微的修改，您可以看到Num.msg实际效果。由于您要将标准字符串 msg 更改为数字字符串，因此输出会略有不同。

发布者：

#include <chrono>
#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/msg/num.hpp"     // CHANGE

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);    // CHANGE
    timer_ = this->create_wall_timer(
      500ms, std::bind(&MinimalPublisher::timer_callback, this));
  }

private:
  void timer_callback()
  {
    auto message = tutorial_interfaces::msg::Num();                               // CHANGE
    message.num = this->count_++;                                        // CHANGE
    RCLCPP_INFO(this->get_logger(), "Publishing: '%d'", message.num);    // CHANGE
    publisher_->publish(message);
  }
  rclcpp::TimerBase::SharedPtr timer_;
  rclcpp::Publisher<tutorial_interfaces::msg::Num>::SharedPtr publisher_;         // CHANGE
  size_t count_;
};

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

订阅者：

#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/msg/num.hpp"     // CHANGE
using std::placeholders::_1;

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

private:
  void topic_callback(const tutorial_interfaces::msg::Num::SharedPtr msg) const       // CHANGE
  {
    RCLCPP_INFO(this->get_logger(), "I heard: '%d'", msg->num);              // CHANGE
  }
  rclcpp::Subscription<tutorial_interfaces::msg::Num>::SharedPtr subscription_;       // CHANGE
};

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

CMakeLists.txt：

添加以下行（仅限 C++）：

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(tutorial_interfaces REQUIRED)                         # CHANGE

add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp tutorial_interfaces)         # CHANGE

add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp tutorial_interfaces)     # CHANGE

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

ament_package()

package.xml：

添加以下行：

<depend>tutorial_interfaces</depend>

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

colcon build --packages-select cpp_pubsub

然后打开两个新终端，在每个终端中source，然后运行：

ros2 run cpp_pubsub talker

ros2 run cpp_pubsub listener

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

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

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

通过对之前教程（C++或Python）中创建的服务/客户端包进行一些细微修改，您可以看到AddThreeInts.srv实际效果。由于您会将原来的两个整数请求 srv 更改为三个整数请求 srv，因此输出会略有不同。

服务端：

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/srv/add_three_ints.hpp"     // CHANGE

#include <memory>

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

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

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

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

客户端：

#include "rclcpp/rclcpp.hpp"
#include "tutorial_interfaces/srv/add_three_ints.hpp"        // CHANGE

#include <chrono>
#include <cstdlib>
#include <memory>

using namespace std::chrono_literals;

int main(int argc, char **argv)
{
  rclcpp::init(argc, argv);

  if (argc != 4) { // CHANGE
      RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "usage: add_three_ints_client X Y Z");      // CHANGE
      return 1;
  }

  std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_three_ints_client"); // CHANGE
  rclcpp::Client<tutorial_interfaces::srv::AddThreeInts>::SharedPtr client =                        // CHANGE
    node->create_client<tutorial_interfaces::srv::AddThreeInts>("add_three_ints");                  // CHANGE
  auto request = std::make_shared<tutorial_interfaces::srv::AddThreeInts::Request>();               // CHANGE
  request->a = atoll(argv[1]);
  request->b = atoll(argv[2]);
  request->c = atoll(argv[3]);               // CHANGE

  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::executor::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");    // CHANGE
  }

  rclcpp::shutdown();
  return 0;
}

CMakeLists.txt：

添加以下行（仅限 C++）：

#...

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(tutorial_interfaces REQUIRED)        # CHANGE

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

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

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

ament_package()

package.xml：

添加以下行：

<depend>tutorial_interfaces</depend>

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

colcon build --packages-select cpp_srvcli

 

然后打开两个新终端，dev_ws在每个终端中输入源代码，然后运行：

ros2 run cpp_srvcli server

ros2 run cpp_srvcli client 2 3 1

概括

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

这是一种创建和使用界面的简单方法。您可以在此处了解有关接口的更多信息。

下一步

下一个教程将介绍更多在 ROS 2 中使用接口的方法。