创建自定义 msg 和 srv 文件

发布时间：2024年01月08日

背景?

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

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

任务?

1 创建一个新包?

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

由于我们将使用之前教程中创建的 pub/sub 和 service/client 包，因此请确保您与这些包位于同一工作区 (?ros2_ws/src)，然后运行以下命令来创建新包：

ros2 pkg create --build-type ament_cmake tutorial_interfaces

tutorial_interfaces是新包的名称。注意，它是一个CMake包；.srv您可以在 CMake 包中创建自定义接口。

和文件需要分别放置在名为.msg和的目录中。在以下位置创建目录：.srvmsgsrvros2_ws/src/tutorial_interfaces

mkdir msg

mkdir srv

2 创建自定义定义?

2.1 消息定义?

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

int64 num

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

同样在tutorial_interfaces/msg您刚刚创建的目录中，创建一个名为的新文件，Sphere.msg其中包含以下内容：

geometry_msgs/Point center
float64 radius

此自定义消息使用来自另一个消息包的消息（geometry_msgs/Point在本例中）。

2.2 srv定义?

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

int64 a
int64 b
int64 c
---
int64 sum

这是您的自定义服务，它请求三个名为a、b和 整数c，并使用名为 sum?的整数进行响应。

3CMakeLists.txt?

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

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 # Add packages that above messages depend on, in this case geometry_msgs for Sphere.msg
)

4package.xml?

由于接口依赖rosidl_default_generators于生成特定于语言的代码，因此您需要声明对其的依赖关系。该<exec_depend>标签用于指定运行时或执行阶段依赖项，并且是rosidl_interface_packages使用该标签声明的包所属的依赖项组的名称<member_of_group>。

将以下行添加到package.xml

<depend>geometry_msgs</depend>

<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包?

现在自定义接口包的所有部分都已就位，您可以构建该包了。在工作区的根目录 (?~/ros2_ws) 中，运行以下命令：

Linux 
colcon build --packages-select tutorial_interfaces

现在，其他 ROS 2 软件包可以发现这些接口。

6 确认msg和srv创建?

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

Linux 
. install/setup.bash

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

ros2 interface show tutorial_interfaces/msg/Num

应该返回：

int64 num

和

ros2 interface show tutorial_interfaces/msg/Sphere

应该返回：

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

和

ros2 interface show tutorial_interfaces/srv/AddThreeInts

应该返回：

int64 a
int64 b
int64 c
---
int64 sum

7 测试新接口?

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

7.1Num.msg使用 pub/sub进行测试?

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

出版商：

C++ 
#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_STREAM(this->get_logger(), "Publishing: '" << 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;
}


订阅
C++ 
#include <functional>
#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 & msg) const  // CHANGE
  {
    RCLCPP_INFO_STREAM(this->get_logger(), "I heard: '" << 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：

添加以下行：

C++ 
<depend>tutorial_interfaces</depend>

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

C++ 
colcon build --packages-select cpp_pubsub

在 Windows 上：

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

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

C++ 
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.2AddThreeInts.srv使用服务/客户端进行测试?

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

服务：

C++ 
#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();
}

客户：

C++ 
#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::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：

添加以下行：

C++Python 
<depend>tutorial_interfaces</depend>

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

C++ 
colcon build --packages-select cpp_srvcli

在 Windows 上：

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

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

C++ 
ros2 run cpp_srvcli server

ros2 run cpp_srvcli client 2 3 1
文章来源:https://blog.csdn.net/weixin_43841155/article/details/135458570
本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
最新文章