ROS 2 Humble チュートリアル

Appearance

簡単なパブリッシャーとサブスクライバーの作成 (C++) ​

目標: C++を使用してパブリッシャーとサブスクライバーノードを作成して実行する。

チュートリアルレベル: 初心者

所要時間: 20分

背景 ​

ノードは、ROSグラフ上で通信する実行可能プロセスです。 このチュートリアルでは、ノードがトピックを介して文字列メッセージの形で情報を互いに渡します。 ここで使用される例は、シンプルな「talker」と「listener」システムです。一つのノードがデータをパブリッシュし、もう一つのノードがそのデータを受信するためにトピックをサブスクライブします。

これらの例で使用されるコードはこちらで確認できます。

前提条件 ​

前のチュートリアルで、ワークスペースの作成とパッケージの作成方法を学びました。

タスク ​

1 パッケージの作成 ​

新しいターミナルを開き、ROS 2インストールをソースしてros2コマンドが動作するようにします。

前のチュートリアルで作成したros2_wsディレクトリに移動します。

パッケージはワークスペースのルートではなく、srcディレクトリに作成する必要があることを思い出してください。 したがって、ros2_ws/srcに移動し、パッケージ作成コマンドを実行します：

bash
ros2 pkg create --build-type ament_cmake --license Apache-2.0 cpp_pubsub

ターミナルがパッケージcpp_pubsubとそのすべての必要なファイルとフォルダの作成を確認するメッセージを返します。

ros2_ws/src/cpp_pubsub/srcに移動します。 これは、実行可能ファイルを含むソースファイルが属するCMakeパッケージのディレクトリであることを思い出してください。

2 パブリッシャーノードの作成 ​

以下のコマンドを入力して、サンプルのtalkerコードをダウンロードします：

bash
wget -O publisher_member_function.cpp https://raw.githubusercontent.com/ros2/examples/humble/rclcpp/topics/minimal_publisher/member_function.cpp

これでpublisher_member_function.cppという名前の新しいファイルができます。 お好みのテキストエディタでファイルを開きます。

cpp
#include <chrono>
#include <functional>
#include <memory>
#include <string>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"

using namespace std::chrono_literals;

/* この例では、Nodeのサブクラスを作成し、std::bind()を使用して
* メンバー関数をタイマーからのコールバックとして登録します。 */

class MinimalPublisher : public rclcpp::Node
{
  public:
    MinimalPublisher()
    : Node("minimal_publisher"), count_(0)
    {
      publisher_ = this->create_publisher<std_msgs::msg::String>("topic", 10);
      timer_ = this->create_wall_timer(
      500ms, std::bind(&MinimalPublisher::timer_callback, this));
    }

  private:
    void timer_callback()
    {
      auto message = std_msgs::msg::String();
      message.data = "Hello, world! " + std::to_string(count_++);
      RCLCPP_INFO(this->get_logger(), "Publishing: '%s'", message.data.c_str());
      publisher_->publish(message);
    }
    rclcpp::TimerBase::SharedPtr timer_;
    rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
    size_t count_;
};

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

2.1 コードの確認 ​

コードの上部には、使用する標準C++ヘッダーが含まれています。 標準C++ヘッダーの後にrclcpp/rclcpp.hppインクルードがあり、これによりROS 2システムの最も一般的な部分を使用できます。 最後はstd_msgs/msg/string.hppで、データをパブリッシュするために使用する組み込みメッセージタイプを含みます。

cpp
#include <chrono>
#include <functional>
#include <memory>
#include <string>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"

using namespace std::chrono_literals;

これらの行はノードの依存関係を表しています。 依存関係はpackage.xmlとCMakeLists.txtに追加する必要があることを思い出してください。これは次のセクションで行います。

次の行は、rclcpp::Nodeから継承することでノードクラスMinimalPublisherを作成します。 コード内のすべてのthisはノードを参照しています。

cpp
class MinimalPublisher : public rclcpp::Node

パブリックコンストラクタはノードにminimal_publisherという名前を付け、count_を0に初期化します。 コンストラクタ内で、パブリッシャーはStringメッセージタイプ、トピック名topic、およびバックアップの場合にメッセージを制限するために必要なキューサイズで初期化されます。 次に、timer_が初期化され、timer_callback関数が毎秒2回実行されるようになります。

cpp
public:
  MinimalPublisher()
  : Node("minimal_publisher"), count_(0)
  {
    publisher_ = this->create_publisher<std_msgs::msg::String>("topic", 10);
    timer_ = this->create_wall_timer(
    500ms, std::bind(&MinimalPublisher::timer_callback, this));
  }

timer_callback関数は、メッセージデータが設定され、メッセージが実際にパブリッシュされる場所です。 RCLCPP_INFOマクロは、パブリッシュされたすべてのメッセージがコンソールに印刷されることを保証します。

cpp
private:
  void timer_callback()
  {
    auto message = std_msgs::msg::String();
    message.data = "Hello, world! " + std::to_string(count_++);
    RCLCPP_INFO(this->get_logger(), "Publishing: '%s'", message.data.c_str());
    publisher_->publish(message);
  }

最後に、タイマー、パブリッシャー、カウンターフィールドの宣言があります。

cpp
rclcpp::TimerBase::SharedPtr timer_;
rclcpp::Publisher<std_msgs::msg::String>::SharedPtr publisher_;
size_t count_;

MinimalPublisherクラスの後にmainがあり、ここでノードが実際に実行されます。 rclcpp::initはROS 2を初期化し、rclcpp::spinはタイマーからのコールバックを含むノードからのデータ処理を開始します。

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

2.2 依存関係の追加 ​

CMakeLists.txtとpackage.xmlファイルが作成されているros2_ws/src/cpp_pubsubディレクトリに一つ上のレベルに移動します。

お好みのテキストエディタでpackage.xmlを開きます。

前のチュートリアルで述べたように、<description>、<maintainer>、および<license>タグを必ず記入してください：

xml
<description>rclcppを使用した最小限のパブリッシャー/サブスクライバーの例</description>
<maintainer email="you@email.com">Your Name</maintainer>
<license>Apache License 2.0</license>

ament_cmakeビルドツール依存関係の後に新しい行を追加し、ノードのインクルード文に対応する以下の依存関係を貼り付けます：

xml
<depend>rclcpp</depend>
<depend>std_msgs</depend>

これは、パッケージがコードのビルドと実行時にrclcppとstd_msgsを必要とすることを宣言します。

ファイルを保存することを忘れないでください。

2.3 CMakeLists.txt ​

CMakeLists.txtファイルを開きます。 既存の依存関係find_package(ament_cmake REQUIRED)の下に、以下の行を追加します：

cmake
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

その後、実行可能ファイルを追加し、ros2 runを使用してノードを実行できるようにtalkerという名前を付けます：

cmake
add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp std_msgs)

最後に、ros2 runが実行可能ファイルを見つけられるようにinstall(TARGETS...)セクションを追加します：

cmake
install(TARGETS
  talker
  DESTINATION lib/${PROJECT_NAME})

不要なセクションとコメントを削除してCMakeLists.txtをクリーンアップして、このようになるようにできます：

cmake
cmake_minimum_required(VERSION 3.5)
project(cpp_pubsub)

# デフォルトをC++14に設定
if(NOT CMAKE_CXX_STANDARD)
  set(CMAKE_CXX_STANDARD 14)
endif()

if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  add_compile_options(-Wall -Wextra -Wpedantic)
endif()

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(std_msgs REQUIRED)

add_executable(talker src/publisher_member_function.cpp)
ament_target_dependencies(talker rclcpp std_msgs)

install(TARGETS
  talker
  DESTINATION lib/${PROJECT_NAME})

ament_package()

今パッケージをビルドし、ローカルセットアップファイルをソースして実行することもできますが、完全なシステムの動作を確認できるように、まずサブスクライバーノードを作成しましょう。

3 サブスクライバーノードの作成 ​

ros2_ws/src/cpp_pubsub/srcに戻って次のノードを作成します。 ターミナルで以下のコードを入力します：

bash
wget -O subscriber_member_function.cpp https://raw.githubusercontent.com/ros2/examples/humble/rclcpp/topics/minimal_subscriber/member_function.cpp

これらのファイルが存在することを確認してください：

publisher_member_function.cpp  subscriber_member_function.cpp

お好みのテキストエディタでsubscriber_member_function.cppを開きます。

cpp
#include <memory>

#include "rclcpp/rclcpp.hpp"
#include "std_msgs/msg/string.hpp"
using std::placeholders::_1;

class MinimalSubscriber : public rclcpp::Node
{
  public:
    MinimalSubscriber()
    : Node("minimal_subscriber")
    {
      subscription_ = this->create_subscription<std_msgs::msg::String>(
      "topic", 10, std::bind(&MinimalSubscriber::topic_callback, this, _1));
    }

  private:
    void topic_callback(const std_msgs::msg::String & msg) const
    {
      RCLCPP_INFO(this->get_logger(), "I heard: '%s'", msg.data.c_str());
    }
    rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;
};

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

3.1 コードの確認 ​

サブスクライバーノードのコードは、パブリッシャーのコードとほぼ同じです。 今度は、ノードがminimal_subscriberという名前になり、コンストラクタがノードのcreate_subscriptionクラスを使用してコールバックを実行します。

サブスクライバーは単にtopicトピックにデータがパブリッシュされるたびに応答するだけなので、タイマーはありません。

cpp
public:
  MinimalSubscriber()
  : Node("minimal_subscriber")
  {
    subscription_ = this->create_subscription<std_msgs::msg::String>(
    "topic", 10, std::bind(&MinimalSubscriber::topic_callback, this, _1));
  }

トピックチュートリアルから、パブリッシャーとサブスクライバーが通信できるようにするには、使用するトピック名とメッセージタイプが一致する必要があることを思い出してください。

topic_callback関数は、トピック上でパブリッシュされた文字列メッセージデータを受信し、RCLCPP_INFOマクロを使用してコンソールに書き込むだけです。

このクラスで唯一のフィールド宣言はサブスクリプションです。

cpp
private:
  void topic_callback(const std_msgs::msg::String & msg) const
  {
    RCLCPP_INFO(this->get_logger(), "I heard: '%s'", msg.data.c_str());
  }
  rclcpp::Subscription<std_msgs::msg::String>::SharedPtr subscription_;

main関数は今度はMinimalSubscriberノードをスピンすることを除いて全く同じです。 パブリッシャーノードにとって、スピンはタイマーの開始を意味しましたが、サブスクライバーにとってはメッセージが来るたびに受信する準備をすることを意味します。

このノードはパブリッシャーノードと同じ依存関係を持つため、package.xmlに新しく追加するものはありません。

3.2 CMakeLists.txt ​

CMakeLists.txtを再度開き、パブリッシャーのエントリの下にサブスクライバーノード用の実行可能ファイルとターゲットを追加します。

cmake
add_executable(listener src/subscriber_member_function.cpp)
ament_target_dependencies(listener rclcpp std_msgs)

install(TARGETS
  talker
  listener
  DESTINATION lib/${PROJECT_NAME})

ファイルを保存することを忘れずに、これでpub/subシステムの準備ができているはずです。

4 ビルドと実行 ​

おそらくROS 2システムの一部としてrclcppとstd_msgsパッケージがすでにインストールされているでしょう。 ビルド前に、ワークスペースのルート（ros2_ws）でrosdepを実行して、不足している依存関係をチェックするのが良い習慣です：

bash
rosdep install -i --from-path src --rosdistro humble -y

まだワークスペースのルートros2_wsで、新しいパッケージをビルドします：

bash
colcon build --packages-select cpp_pubsub

新しいターミナルを開き、ros2_wsに移動して、セットアップファイルをソースします：

bash
. install/setup.bash

talkerノードを実行します。 ターミナルは以下のように0.5秒ごとに情報メッセージのパブリッシュを開始するはずです：

bash
ros2 run cpp_pubsub talker

出力：

[INFO] [minimal_publisher]: Publishing: "Hello World: 0"
[INFO] [minimal_publisher]: Publishing: "Hello World: 1"
[INFO] [minimal_publisher]: Publishing: "Hello World: 2"
[INFO] [minimal_publisher]: Publishing: "Hello World: 3"
[INFO] [minimal_publisher]: Publishing: "Hello World: 4"

別のターミナルを開き、ros2_ws内から再度セットアップファイルをソースし、listenerノードを起動します。 リスナーは、その時点でパブリッシャーがあるメッセージカウントから始まって、コンソールへのメッセージの印刷を開始します：

bash
ros2 run cpp_pubsub listener

出力：

[INFO] [minimal_subscriber]: I heard: "Hello World: 10"
[INFO] [minimal_subscriber]: I heard: "Hello World: 11"
[INFO] [minimal_subscriber]: I heard: "Hello World: 12"
[INFO] [minimal_subscriber]: I heard: "Hello World: 13"
[INFO] [minimal_subscriber]: I heard: "Hello World: 14"

各ターミナルでCtrl+Cを入力して、ノードのスピンを停止します。

まとめ ​

トピック上でデータをパブリッシュおよびサブスクライブする2つのノードを作成しました。 それらをコンパイルして実行する前に、パッケージ設定ファイルに依存関係と実行可能ファイルを追加しました。

次のステップ ​

次に、サービス/クライアントモデルを使用した別のシンプルなROS 2パッケージを作成します。 再び、C++またはPythonのいずれかで書くことを選択できます。

関連コンテンツ ​

C++でパブリッシャーとサブスクライバーを書く方法はいくつかあります。ros2/examplesリポジトリのminimal_publisherとminimal_subscriberパッケージをチェックしてください。

Released under the MIT License.

Copyright © 2024-present amuratakamitamu