【ROS2概念】系列(十三)——ROS2如何创建自定义msg、srv和action文件

一、ROS2创建自定义msg、srv和action文件的思路

ROS2通过自带rosidl_default_generators包来为自定义的msg、srv和action文件生成各个语言的头文件！

ROS2通过在CMakeLists.txt中调用新增的宏rosidl_generate_interfaces来为msg、srv和action文件生成各个语言的头文件！而这个宏的实现定义在rosidl_default_generators包。

二、基本数据类型

利用ROS2的原始基本数据类型和已有的数据类型，可以自定义需要的数据类型。

2.1 ROS2的基本原始数据类型

ROS2目前支持的内置类型：

每种内置类型都可以用来定义数组：

所有比其ROS定义更宽松的类型均由软件强制执行ROS的范围和长度约束。

使用数组和有界类型的消息定义示例：

int32[] unbounded_integer_array
int32[5] five_integers_array
int32[<=5] up_to_five_integers_array

string string_of_unbounded_size
string<=10 up_to_ten_characters_string

string[<=5] up_to_five_unbounded_strings
string<=10[] unbounded_array_of_string_up_to_ten_characters each
string<=10[<=5] up_to_five_strings_up_to_ten_characters_each

2.2 ROS2中的基本msg类型

2.3 ROS2中的基本srv类型

2.4 ROS2中的基本action类型

三、创建自定义的msg、srv和action

3.1 创建功能包

在本文中，将在自己的包中创建自定义的.msg、.srv和.action文件，然后在另外的包中使用它们，这两个包应该在同一个工作空间dev_ws/src目录中,然后运行以下命令创建一个新包。

ros2 pkg create --build-type ament_cmake tutorial_interfaces

tutorial_interfaces是新包的名称。注意，它是一个CMake包，目前还没有办法在纯Python包中生成.msg、.srv和.action文件。但是，可以在CMake包中创建自定义接口，然后在Python节点中使用它。

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

mkdir msg srv action

3.2 创建自定义接口文件

3.2.1 自定义msg文件

在tutorial_interfaces/msg文件夹下，创建一个名为Num.msg的新文件，用一行代码声明它的数据结构：

int64 num

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

3.2.2 自定义srv文件

srv文件和msg文件相似，除了它包含两个部分：请求和响应。这两部分用“---”线分隔。

在tutorial_interfaces/srv文件夹下，创建一个名为AddThreeInts.srv的新文件，并声明他的请求和响应结构：

int64 a
int64 b
int64 c
---
int64 sum

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

3.2.3 自定义action文件

按照以下格式定义.action文件：

Request
---
Result
---
Feedback

动作定义由三个消息定义组成，它们之间用--分隔。

请求（request）消息从动作客户端发送到动作服务器，初始化一个新目标。

当目标完成时，结果（result）消息从动作服务器发送到动作客户端。

反馈（feedback）消息定期从动作服务器发送到动作客户端，其中包含关于目标的更新。

一个动作的实例通常被称为目标（goal）。

假设想要定义一个新的动作“Fibonacci”来计算Fibonacci序列。

在tutorial_interfaces/action目录中，创建一个名为Fibonacci.action的文件，内容如下:

int32 order
---
int32[] sequence
---
int32[] partial_sequence

目标请求是想要计算的斐波那契数列的order，结果是最终的sequence，而反馈是到目前为止计算的partial_sequence。

3.3 编译生成

3.3.1 CMakeLists.txt

要将自定义的接口（interface）转换成基于语言的代码（如C++和Python），以便它们可以在这些语言中使用，请将以下代码添加到CMakeLists.txt中:

find_package(rosidl_default_generators REQUIRED)

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

注意：需要依赖于action_msgs，因为动作定义包括额外的元数据(例如目标id)。

3.3.2 package.xml

因为接口依赖于rosidl_default_generators来生成基于语言的代码，所以需要声明对它的依赖关系。将以下行添加到package.xml中：

<depend>action_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>

3.3.3 编译

在工作空间的根目录(~/dev_ws)中，运行以下命令:

colcon build --packages-select tutorial_interfaces

现在接口将被其他ROS 2包发现。

四、测试

4.1 验证msg、srv和action的创建

打开新终端，在dev_ws下运行：

source install/setup.bash

可以使用ros2 interface show命令确认接口创建工作:

查看msg文件：

ros2 interface show tutorial_interfaces/msg/Num

int64 num

查看srv文件：

ros2 interface show tutorial_interfaces/srv/AddThreeInts

int64 a
int64 b
int64 c
---
int64 sum

查看action文件：

ros2 interface show tutorial_interfaces/srv/AddThreeInts

int32 order
---
int32[] sequence
---
int32[] partial_sequence

4.2 使用pub/sub测试Num.msg

Publisher代码

#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;
}

Subscriber代码

#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

#...

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 dev_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'

4.3 使用service/client测试AddThreeInts.srv

Service

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

Client

#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

#...

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

添加