ROS2入门教程—自定义话题及服务消息类型

1 创建功能包
2 创建自定义接口
3 修改CMakeLists.txt
4 修改package.xml
5 编译
6 验证msg和srv创建成功
7 测试自定义接口
- 7.1 测试Num.msg
- 7.2 测试AddThreeInts.srv

在之前的教程中，我们已经使用消息和服务接口来了解话题、服务以及简单的发布者/订阅者节点和服务/客户端节点。在这些情况下，我们使用的接口都是预先定义好的。虽然使用预定义的接口定义是一种很好的做法，但在很多时候，ROS中预定义的接口并不能完全满足我们的需求，接下来我们就学习下如何自定义这些接口。

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节点中使用它，这将在后续文章中介绍。

把自定义的.msg或.srv文件放置在各自的文件夹中是一个很好的习惯，因此可以在功能包dev_ws/src/tutorial_interfaces中创建两个文件夹分别保存自定义文件：

mkdir msg
mkdir srv

2 创建自定义接口

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

int64 num

这就是您自定义的消息，用于传输名为num的单个64位整型数。

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

rosidl_default_generators

rosidl_default_runtime

rosidl_interface_packages

5 编译

回到工作空间的根目录下，开始编译：

colcon build --packages-select tutorial_interfaces

编译成功后，该接口就可以被其他ROS2包调用了。

6 验证msg和srv创建成功

打开一个新终端，进入到工作空间的根目录dev_ws，设置环境变量：

. install/setup.bash

现在可以使用如下命令，查看刚才自定义的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

7 测试自定义接口

为了方便起见，您可以参照之前教程中创建的功能包cpp_pubsub和cpp_srvcli。对节点、CMakeLists和package.xml进行一些简单的修改将允许您使用新的接口。

7.1 测试Num.msg

对功能包cpp_pubsub中的Publisher、Subscriber、CMakeLists和package.xml分别做如下修改：

Publisher:

#include 
#include 

#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("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::SharedPtr publisher_;  // CHANGE
    size_t count_;
};

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

Subscriber:

#include 

#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(       // 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::SharedPtr subscription_;       // CHANGE
};

int main(int argc, char * argv[])
{
    rclcpp::init(argc, argv);
    rclcpp::spin(std::make_shared());
    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:

tutorial_interfaces

完成上述修改之后，重新编译该功能包：

colcon build --packages-select cpp_pubsub

打开一个新终端，进入到工作空间的根目录dev_ws，设置环境变量后，运行发布者：

. install/setup.bash
ros2 run cpp_pubsub talker

运行成功后可以看到终端每隔0.5s打印一次日志信息：

[INFO] [minimal_publisher]: Publishing: '0'
[INFO] [minimal_publisher]: Publishing: '1'
[INFO] [minimal_publisher]: Publishing: '2'
[INFO] [minimal_publisher]: Publishing: '3'
[INFO] [minimal_publisher]: Publishing: '4'
[INFO] [minimal_publisher]: Publishing: '5'
[INFO] [minimal_publisher]: Publishing: '6'

再打开一个新的终端，进入到工作空间的根目录dev_ws，设置环境变量后，运行订阅者：

. install/setup.bash
ros2 run cpp_pubsub listener

订阅者启动后，终端中会显示当前订阅者收到的消息内容：

[INFO] [minimal_subscriber]: I heard: '82'
[INFO] [minimal_subscriber]: I heard: '83'
[INFO] [minimal_subscriber]: I heard: '84'
[INFO] [minimal_subscriber]: I heard: '85'
[INFO] [minimal_subscriber]: I heard: '86'
[INFO] [minimal_subscriber]: I heard: '87'

7.2 测试AddThreeInts.srv

对功能包cpp_srvcli中的Service、Client、CMakeLists和package.xml分别做如下修改：

Service:

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

#include 

void add(const std::shared_ptr request,        // CHANGE
          std::shared_ptr       response)     // CHANGE
{
    response->sum = request->a + request->b + request->c;                                       // CHANGE
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming requestna: %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 node = rclcpp::Node::make_shared("add_three_ints_server");    // CHANGE

    rclcpp::Service::SharedPtr service =                // CHANGE
        node->create_service("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 
#include 
#include 

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 node = rclcpp::Node::make_shared("add_three_ints_client");    // CHANGE
    rclcpp::Client::SharedPtr client =                  // CHANGE
        node->create_client("add_three_ints");          // CHANGE

    auto request = std::make_shared();         // 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_three_ints_server.cpp)
ament_target_dependencies(server
  rclcpp tutorial_interfaces)                      #CHANGE

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

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

ament_package()

package.xml:

tutorial_interfaces

完成上述修改之后，重新编译该功能包：

colcon build --packages-select cpp_srvcli

打开一个新终端，进入到工作空间的根目录dev_ws，设置环境变量后，运行服务端：

. install/setup.bash
ros2 run cpp_srvcli server

运行成功后终端中可以看到提示信息：：

[INFO] [rclcpp]: Ready to add three ints.

再打开一个新的终端，进入到工作空间的根目录dev_ws，设置环境变量后，运行客户端：

. install/setup.bash
ros2 run cpp_srvcli client 2 3 1

客户端发送请求后，将收到如下响应：

[INFO] [rclcpp]: Sum: 6

返回运行服务节点的终端，您将看到有如下日志信息更新：

[INFO] [rclcpp]: Incoming request
a: 2 b: 3 c: 1
[INFO] [rclcpp]: sending back response: [6]

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

ROS2入门教程—自定义话题及服务消息类型

Python相关栏目本月热门文章