ROS2学习笔记15--创建自定义ros2接口文件msg和srv

Posted 2021-08-08 鸿_H

概要：这篇主要介绍如何创建定制型ros2接口文件msg和srv

环境：ubuntu20.04,ros2-foxy,vscode

最后如果没有陈述实操过程中碰到问题的话，则表示该章节都可被本人正常复现．

2.2.7创建自定义ros2消息msg和srv文件（原文：https://docs.ros.org/en/foxy/Tutorials/Custom-ROS2-Interfaces.html）

>>教程>>创建自定义ros2接口文件msg和srv

你正阅读的是ros2较老版本(Foxy)，但仍然支持的说明文档．想查看最新版本的信息，请看galactic版本链接（ https://docs.ros.org/en/galactic/Tutorials.html）

创建自定义ros2接口文件msg和srv

目标：自定义接口文件 (.msg 和.srv) ，并在Python和C++节点里面使用这些文件．

课程等级： 初级

时长：20min

目录

1.背景
2.预备知识
3.步骤
3.1新建一个包
3.2明确定制化内容
3.3CMakeLists.txt
3.4package.xml
3.5创建 tutorial_interfaces包
3.6msg和srv文件的构造确定
3.7测试接口
4.总结
5.下一步

1. 背景

之前课程，在话题，服务，简单的发布器／侦听器 (C++/Python)节点 ， 服务器／客户端(C++/Python)节点课程中都使用了消息和服务的接口．你使用的这些接口都是事先定义好的．

虽然使用预先定义的接口很不错，但有时也可能需要自己定义消息类型和服务的．本节课将要教你定制化接口定义的最简单方法．

2. 预备知识

你需要一个ros2工作空间．

这节课会使用之前发布器／订阅器，服务器／侦听器课程创建的包，测试新定制化信息．

3. 步骤

3.1 新建一个包

这节课，你会在包里面创建定制化的.msg和.srv文件，并且它们可在别的包内使用．所涉及的包应该放到同一工作空间下面．

由于用到之前pub/sub和service/client课程创建的包，保证你跟这些包一样在这个工作空间目录（dev_ws/src）下，然后，运行下面指令来创建一个新包：

ros2 pkg create --build-type ament_cmake tutorial_interfaces

tutorial_interfaces是新包的名字．注意这是一个CMake类型的包；在单纯python包里面，目前是没有办法生成.msg或者.srv文件的．在CMake型包里面，你可以创建定制化接口，然后在python型节点中使用，在上一节课程有涉及（个人没有实操python编写服务器／客户端课程）．

在一个包中，最后是让.msg 和.srv放在各自文件目录比较好．在目录dev_ws/src/tutorial_interfaces创建文件夹：

mkdir msg

mkdir srv

3.2 明确定制化内容

3.2.1 msg定义

在刚刚创建的tutorial_interfaces/msg文件目录，新建一个名字为Num.msg的文件，里面放着声明数据结构的一行代码：

int64 num

将单一的64位整数称为num,这就是你的定制化消息．

3.2.2 srv定义

回到刚刚创建的tutorial_interfaces/srv目录，创建一个名字为AddThreeInts.srv文件，里面的请求和响应结构如同下面样子：

int64 a
int64 b
int64 c
---
int64 sum

这是一个定制的服务，请求部分有三个整数，a,b和c，响应部分有一个整数，sum.

3.3 CMakeLists.txt

为了将你定义的接口转为特定语言代码（如c++和python）,使得这些接口可在这些语言里被使用，(为了达到这个目地你)需要添加以下几行代码到CMakeLists.txt文件里面：

find_package(rosidl_default_generators REQUIRED)

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

3.4package.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>

3.5创建 tutorial_interfaces包

既然你定制化接口包的组成部分都齐了，那可以编译这个包了．在工作空间根目录（~/dev_ws）下，运行下面指令：

linux:

colcon build --packages-select tutorial_interfaces

现在，这些接口可以被ros2包找到了．

3.6msg和srv文件的构造确定

在新终端，dev_ws工作空间运行下面指令来source一下（该空间环境变量）：

linux:

. install/setup.bash

现在使用ros2 interface show指令来确认你的创建的接口可以使用了．

ros2 interface show tutorial_interfaces/msg/Num

应该返回：

int64 num

和

ros2 interface show tutorial_interfaces/srv/AddThreeInts

应该返回：

int64 a
int64 b
int64 c
---
int64 sum

3.7测试接口

这一步，你会用到前面课程创建的包．简单修改这些节点（文件），CMakeLists和package文件就可以让你使用新接口．

3.7.1使用pub/sub（课程包）测试Num.msg

对之前课程创建publisher/subscriber包进行些微修改，你会看到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(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;
}

订阅器：
c++：

#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:

添加下面这行：

c++：

<depend>tutorial_interfaces</depend>

按照上面进行编辑完成并保存，编译该包：

c++：

colcon build --packages-select cpp_pubsub

接着新开两个终端，每个都在dev_ws目录source一下（自己空间环境变量），（分别）运行：

c++：

ros2 run cpp_pubsub talker

ros2 run cpp_pubsub listener

由于Num.msg知识传整数，这个talker应该只是发布整数数值，跟之前发布字符串不同：

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

3.7.2使用service/client包测试AddThreeInts.srv

对之前课程创建service/client包进行些微修改，你会看到AddThreeInts.srv加载进来了．由于你将开始的２个整数请求srv修改为3个整数请求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::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:

增加下面这行：

c++:

<depend>tutorial_interfaces</depend>

按照上面进行编辑完成并保存，编译该包：

c++:

colcon build --packages-select cpp_srvcli

接着新开两个终端，每个都在dev_ws目录source一下（自己空间环境变量），（分别）运行：

c++:

ros2 run cpp_srvcli server

ros2 run cpp_srvcli client 2 3 1

4.总结

在本课程中，你学习了在包里面创建定制化接口，如何在别的包里面使用这些接口．

这是一个简单的接口的创建和使用的方法，你可以在这里（https://docs.ros.org/en/foxy/Concepts/About-ROS-Interfaces.html#interfaceconcept）学习更多关于接口知识．

5.下一步

下一节课，介绍多种方式使用ros2接口．

其他

个人认为重点：

自定义接口文件msg,srv如何创建；别的包如何使用到这些自定义接口

这课程是在等毕业证那十几天搞的，室友问，现在在线翻译这么强大，为啥还在这里瞎折腾呢？我说，我的目地是好好认真看一下，了解一下，自己折腾，目前是我想到最好的办法来获得最佳效果，即使这翻译有点别扭，哈哈哈．

#####################
不积硅步，无以至千里
好记性不如烂笔头
感觉有点收获的话，麻烦大大们点赞收藏哈