ROS 2 Iron 教程第二章 Client libraries 第六节创建自己的msg和srv文件

最新推荐文章于 2024-08-20 10:23:16 发布

wilbur_ju

最新推荐文章于 2024-08-20 10:23:16 发布

阅读量40

点赞数

分类专栏： ROS 2 Iron 官方教程翻译文章标签：机器人 ubuntu 笔记

原文链接：https://docs.ros.org/en/iron/Tutorials/Beginner-Client-Libraries/Custom-ROS2-Interfaces.html

版权

ROS 2 Iron 官方教程翻译专栏收录该内容

19 篇文章 0 订阅

订阅专栏

ROS 2 Iron 教程第二章 Client libraries 第六节创建自己的msg和srv文件

前言
背景
先决条件
任务
总结

前言

本系列文章是由笔者翻译自ROS 2 官方教程。笔者水平有限，如有错误，还请读者指正。

背景

在上几节教程中，我们利用消息和服务接口来学习了话题，服务，和简单的发布者、订阅者节点（C++、Python）以及服务端、客户端（C++、Python）节点。在教程中你使用的节点的接口是已经被预定义的。

尽管使用预定义的接口定义是很常用的，你有时也可能会需要定义你自己的消息和服务接口。本节教程将会向你介绍创建自定义消息接口的最简单方法。

先决条件

你需要有一个 ROS 2 工作空间。

本节教程也使用在发布者、订阅者节点（C++、Python）以及服务端、客户端（C++、Python）节点教程中创建的包，我们将会在这上面测试我们自己的消息。

任务

1 Create a new package （创建一个新包）

本节教程中你将会在包中创建自己的.msg和.srv文件，随后在独立的包中使用它们。两个包应该在相同的工作空间中。

既然我们使用上几节教程创建的发布者、订阅者包，服务端、客户端包，确保你的当前目录在与这两个包相同的目录中（ros2_ws/src），随后运行如下命令来创建一个新包：

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中创建目录：

mkdir msg srv

2 Create custom definitions （创建自己的定义）

2.1 msg definition （消息定义）

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

int64 num

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

仍然在tutorial_interfaces/msg目录中，创建一个名为Sphere.msg的新文件，在其中写入如下内容：

geometry_msgs/Point center
float64 radius

这个自定义的消息使用其他消息包中的消息（在此处是 geometry_msgs/Point）。

2.2 srv definition （服务定义）

回到刚才创建的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(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
)

注意：
rosidl_generate_interfaces 的第一个参数必须与${PROJECT_NAME}匹配（详见：GitHub）

4 package.xml

由于接口依赖于rosidl_default_generators来生成特定于语言的代码，所以我们需要声明其依赖的构建工具。rosidl_default_runtime是运行时或执行阶段的依赖项，需要被使能以在随后使用接口。

rosidl_interface_packages是你的包tutorial_interfaces所依赖的包集合，它应该被加入package.xml中，使用<member_of_group>标签声明。

在package.xml的<package>元素中添加如下行：

<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 Bulid the tutorial_interfaces package （构建 tutorial_interfaces 包）

既然你已经完成了自定义包中的所有需要更改的部分，你可以构建这个包。在工作空间的根目录(~/ros2_ws)，运行如下命令（Liunx）：

colcon build --packages-select tutorial_interfaces

现在你自定义包中的接口将会对其他 ROS 2 包可见。

6 Confirm msg and srv creation （确认消息和服务的创建）

在一个新终端中，cd进入你的工作空间，并运行如下代码添加启动文件（Liunx）：

source install/setup.bash

现在你可以通过ros2 interface show命令检查你的接口创建：

ros2 interface show tutorial_interfaces/msg/Num

命令应该返回：

int64 num

随后再次运行ros2 interface show检查另一个接口：

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 Test the new interfaces （测试新接口）

在这个步骤你可以使用上几节教程中创建的包。对于节点的简单编辑，CMakeLists.txt和package.xml文件将会允许你使用你的新接口。

7.1 Testing Num.msg with pub/sub （使用发布者、订阅者节点测试 Num.msg）

通过对过去教程中创建的发布者/订阅者包（C++或 Python）进行一些修改，我们可以看到Num.msg的实际应用。由于我们将标准字符串消息更改为数字消息，因此输出将略有不同。

7.1.1 对于 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;
}

订阅者节点

#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

在文件中加入以下行：

#...

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>

在完成以上的修改并保存后，构建包（Liunx）：

colcon build --packages-select cpp_pubsub

打开两个新终端，添加ros2_ws启动文件，并运行：

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.1.2 对于 Python 包的修改

发布者节点

import rclpy
from rclpy.node import Node

from tutorial_interfaces.msg import Num                            # CHANGE


class MinimalPublisher(Node):

    def __init__(self):
        super().__init__('minimal_publisher')
        self.publisher_ = self.create_publisher(Num, 'topic', 10)  # CHANGE
        timer_period = 0.5
        self.timer = self.create_timer(timer_period, self.timer_callback)
        self.i = 0

    def timer_callback(self):
        msg = Num()                                                # CHANGE
        msg.num = self.i                                           # CHANGE
        self.publisher_.publish(msg)
        self.get_logger().info('Publishing: "%d"' % msg.num)       # CHANGE
        self.i += 1


def main(args=None):
    rclpy.init(args=args)

    minimal_publisher = MinimalPublisher()

    rclpy.spin(minimal_publisher)

    minimal_publisher.destroy_node()
    rclpy.shutdown()


if __name__ == '__main__':
    main()

订阅者节点

import rclpy
from rclpy.node import Node

from tutorial_interfaces.msg import Num                        # CHANGE


class MinimalSubscriber(Node):

    def __init__(self):
        super().__init__('minimal_subscriber')
        self.subscription = self.create_subscription(
            Num,                                               # CHANGE
            'topic',
            self.listener_callback,
            10)
        self.subscription

    def listener_callback(self, msg):
            self.get_logger().info('I heard: "%d"' % msg.num)  # CHANGE


def main(args=None):
    rclpy.init(args=args)

    minimal_subscriber = MinimalSubscriber()

    rclpy.spin(minimal_subscriber)

    minimal_subscriber.destroy_node()
    rclpy.shutdown()


if __name__ == '__main__':
    main()

package.xml

在文件中加入如下行：

<exec_depend>tutorial_interfaces</exec_depend>

在完成以上的修改并保存后，构建包（Liunx）：

colcon build --packages-select py_pubsub

打开两个新终端，添加ros2_ws启动文件，并运行：

ros2 run py_pubsub talker
ros2 run py_pubsub listener

由于Num.msg中的数据类型是整数，发布者节点应该只发布整数值，与之前发布的字符串不同：

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

7.2 Testing AddThreeInts.srv with service/client （使用客户端、服务端测试 AddThreeInts.srv）

通过对过去教程中创建的发布者/订阅者包（C++或 Python）进行一些修改，我们可以看到AddThreeInts.srv的实际应用。由于我们将过去的两个整数请求改为三个整数请求，输出将会略有不同。

7.2.1 对于 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();
}

客户端

#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

在文件中加入以下行：

#...

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>

在完成以上的修改并保存后，构建包（Liunx）：

colcon build --packages-select cpp_srvcli

打开两个新终端，添加ros2_ws启动文件，并运行：

ros2 run cpp_srvcli server
ros2 run cpp_srvcli client 2 3 1

7.2.2 对于 Python 包的修改

服务端

from tutorial_interfaces.srv import AddThreeInts                                                           # CHANGE

import rclpy
from rclpy.node import Node


class MinimalService(Node):

    def __init__(self):
        super().__init__('minimal_service')
        self.srv = self.create_service(AddThreeInts, 'add_three_ints', self.add_three_ints_callback)       # CHANGE

    def add_three_ints_callback(self, request, response):
        response.sum = request.a + request.b + request.c                                                   # CHANGE
        self.get_logger().info('Incoming request\na: %d b: %d c: %d' % (request.a, request.b, request.c))  # CHANGE

        return response

def main(args=None):
    rclpy.init(args=args)

    minimal_service = MinimalService()

    rclpy.spin(minimal_service)

    rclpy.shutdown()

if __name__ == '__main__':
    main()

客户端

from tutorial_interfaces.srv import AddThreeInts                            # CHANGE
import sys
import rclpy
from rclpy.node import Node


class MinimalClientAsync(Node):

    def __init__(self):
        super().__init__('minimal_client_async')
        self.cli = self.create_client(AddThreeInts, 'add_three_ints')       # CHANGE
        while not self.cli.wait_for_service(timeout_sec=1.0):
            self.get_logger().info('service not available, waiting again...')
        self.req = AddThreeInts.Request()                                   # CHANGE

    def send_request(self):
        self.req.a = int(sys.argv[1])
        self.req.b = int(sys.argv[2])
        self.req.c = int(sys.argv[3])                                       # CHANGE
        self.future = self.cli.call_async(self.req)


def main(args=None):
    rclpy.init(args=args)

    minimal_client = MinimalClientAsync()
    minimal_client.send_request()

    while rclpy.ok():
        rclpy.spin_once(minimal_client)
        if minimal_client.future.done():
            try:
                response = minimal_client.future.result()
            except Exception as e:
                minimal_client.get_logger().info(
                    'Service call failed %r' % (e,))
            else:
                minimal_client.get_logger().info(
                    'Result of add_three_ints: for %d + %d + %d = %d' %                                # CHANGE
                    (minimal_client.req.a, minimal_client.req.b, minimal_client.req.c, response.sum))  # CHANGE
            break

    minimal_client.destroy_node()
    rclpy.shutdown()


if __name__ == '__main__':
    main()

package.xml

在文件中加入如下行：

<exec_depend>tutorial_interfaces</exec_depend>

在完成以上的修改并保存后，构建包（Liunx）：

colcon build --packages-select py_srvcli

打开两个新终端，添加ros2_ws启动文件，并运行：

ros2 run py_srvcli service
ros2 run py_srvcli client 2 3 1

总结

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

本教程仅涉及了有关定义自定义接口的基础。你可以在About ROS 2 interfaces中了解更多信息。

wilbur_ju

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
ROS 2 Iron 教程第二章 Client libraries 第六节创建自己的msg和srv文件

ROS 2 Iron 官方教程翻译第二章 Client libraries 第六节创建自己的msg和srv文件
复制链接

扫一扫

专栏目录

ROS 2 Iron 教程 第二章 Client libraries 第六节 创建自己的msg和srv文件

ROS 2 Iron 教程 第二章 Client libraries 第六节 创建自己的msg和srv文件

前言

背景

先决条件

任务

1 Create a new package （创建一个新包）

2 Create custom definitions （创建自己的定义）

2.1 msg definition （消息定义）

2.2 srv definition （服务定义）

3 CMakeLists.txt

4 package.xml

5 Bulid the tutorial_interfaces package （构建 tutorial_interfaces 包）

6 Confirm msg and srv creation （确认消息和服务的创建）

7 Test the new interfaces （测试新接口）

7.1 Testing Num.msg with pub/sub （使用发布者、订阅者节点测试 Num.msg）

7.1.1 对于 C++ 包的修改

7.1.2 对于 Python 包的修改

7.2 Testing AddThreeInts.srv with service/client （使用客户端、服务端测试 AddThreeInts.srv）

7.2.1 对于 C++ 包的修改

7.2.2 对于 Python 包的修改

总结

ROS 2 Iron 教程第二章 Client libraries 第六节创建自己的msg和srv文件

ROS 2 Iron 教程第二章 Client libraries 第六节创建自己的msg和srv文件