簡単なサービスとクライアントの作成 (C++)

目標: C++を使用してサービスとクライアントノードを作成して実行する。

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

所要時間: 20分

背景

ノードがサービスを使用して通信する場合、データの要求を送信するノードはクライアントノードと呼ばれ、要求に応答するノードはサービスノードと呼ばれます。 要求と応答の構造は.srvファイルによって決定されます。

ここで使用される例は、シンプルな整数加算システムです。1つのノードが2つの整数の合計を要求し、もう1つのノードが結果で応答します。

前提条件

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

タスク

1 パッケージの作成

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

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

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

ros2 pkg create --build-type ament_cmake --license Apache-2.0 cpp_srvcli --dependencies rclcpp example_interfaces

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

--dependencies引数は、必要な依存関係行をpackage.xmlとCMakeLists.txtに自動的に追加します。 example_interfacesは、要求と応答の構造化に必要な.srvファイルを含むパッケージです：

int64 a
int64 b
---
int64 sum

最初の2行は要求のパラメータで、ダッシュの下が応答です。

1.1 package.xmlの更新

パッケージ作成時に--dependenciesオプションを使用したため、package.xmlやCMakeLists.txtに手動で依存関係を追加する必要はありません。

ただし、いつものように、package.xmlに説明、メンテナーのメールと名前、ライセンス情報を必ず追加してください：

<description>C++クライアントサーバーチュートリアル</description>
<maintainer email="you@email.com">Your Name</maintainer>
<license>Apache License 2.0</license>

2 サービスノードの作成

ros2_ws/src/cpp_srvcli/srcディレクトリ内で、add_two_ints_server.cppという新しいファイルを作成し、以下のコードを貼り付けます：

#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"

#include <memory>

void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
          std::shared_ptr<example_interfaces::srv::AddTwoInts::Response>      response)
{
  response->sum = request->a + request->b;
  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
                request->a, request->b);
  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_two_ints_server");

  rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
    node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);

  RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");

  rclcpp::spin(node);
  rclcpp::shutdown();
}

2.1 コードの確認

最初の2つの#include文は、パッケージの依存関係です。

add関数は、要求から2つの整数を加算し、その合計を応答に設定し、ログを使用してコンソールにステータスを通知します。

void add(const std::shared_ptr<example_interfaces::srv::AddTwoInts::Request> request,
         std::shared_ptr<example_interfaces::srv::AddTwoInts::Response>      response)
{
    response->sum = request->a + request->b;
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Incoming request\na: %ld" " b: %ld",
        request->a, request->b);
    RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "sending back response: [%ld]", (long int)response->sum);
}

main関数は、以下を行います：

• ROS 2 C++クライアントライブラリを初期化：

rclcpp::init(argc, argv);

• add_two_ints_serverという名前のノードを作成：

std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_server");

• そのノードに対してadd_two_intsという名前のサービスを作成し、&addメソッドでネットワーク上に自動的にアドバタイズ：

rclcpp::Service<example_interfaces::srv::AddTwoInts>::SharedPtr service =
node->create_service<example_interfaces::srv::AddTwoInts>("add_two_ints", &add);

• 準備ができたときにログメッセージを表示：

RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "Ready to add two ints.");

• ノードをスピンして、サービスを利用可能にする：

rclcpp::spin(node);

2.2 実行可能ファイルの追加

add_executableマクロは、ros2 runを使用して実行できる実行可能ファイルを生成します。 依存関係の直下のCMakeLists.txtに以下のコードブロックを追加して、serverという名前の実行可能ファイルを作成します：

add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server rclcpp example_interfaces)

ros2 runが実行可能ファイルを見つけられるように、ファイルの末尾、ament_package()の直前に以下の行を追加します：

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

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

3 クライアントノードの作成

ros2_ws/src/cpp_srvcli/srcディレクトリ内で、add_two_ints_client.cppという新しいファイルを作成し、以下のコードを貼り付けます：

#include "rclcpp/rclcpp.hpp"
#include "example_interfaces/srv/add_two_ints.hpp"

#include <chrono>
#include <cstdlib>
#include <memory>

using namespace std::chrono_literals;

int main(int argc, char **argv)
{
  rclcpp::init(argc, argv);

  if (argc != 3) {
      RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "usage: add_two_ints_client X Y");
      return 1;
  }

  std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
  rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
    node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");

  auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
  request->a = atoll(argv[1]);
  request->b = atoll(argv[2]);

  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);
  // 結果を待機
  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_two_ints");
  }

  rclcpp::shutdown();
  return 0;
}

3.1 コードの確認

サービスノードと同様に、以下のコード行がノードを作成し、そのノードのクライアントを作成します：

std::shared_ptr<rclcpp::Node> node = rclcpp::Node::make_shared("add_two_ints_client");
rclcpp::Client<example_interfaces::srv::AddTwoInts>::SharedPtr client =
  node->create_client<example_interfaces::srv::AddTwoInts>("add_two_ints");

次に、要求が作成されます。 その構造は、前述の.srvファイルによって定義されます。

auto request = std::make_shared<example_interfaces::srv::AddTwoInts::Request>();
request->a = atoll(argv[1]);
request->b = atoll(argv[2]);

whileループは、クライアントにネットワーク内のサービスノードを検索するために1秒間を与えます。 見つからない場合は、待機を続けます。

RCLCPP_INFO(rclcpp::get_logger("rclcpp"), "service not available, waiting again...");

クライアントがキャンセルされた場合（例：ターミナルでCtrl+Cを入力）、中断されたことを示すエラーログメッセージを返します。

RCLCPP_ERROR(rclcpp::get_logger("rclcpp"), "Interrupted while waiting for the service. Exiting.");

その後、クライアントは要求を送信し、応答を受信するか失敗するまでノードをスピンします。

3.2 実行可能ファイルの追加

CMakeLists.txtに戻り、新しいノードの実行可能ファイルとターゲットを追加します。 自動生成されたファイルから不要なボイラープレートを削除した後、CMakeLists.txtは以下のようになるはずです：

cmake_minimum_required(VERSION 3.5)
project(cpp_srvcli)

find_package(ament_cmake REQUIRED)
find_package(rclcpp REQUIRED)
find_package(example_interfaces REQUIRED)

add_executable(server src/add_two_ints_server.cpp)
ament_target_dependencies(server rclcpp example_interfaces)

add_executable(client src/add_two_ints_client.cpp)
ament_target_dependencies(client rclcpp example_interfaces)

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

ament_package()

4 ビルドと実行

ビルド前に、ワークスペースのルート（ros2_ws）でrosdepを実行して、不足している依存関係をチェックするのが良い習慣です：

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

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

colcon build --packages-select cpp_srvcli

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

source install/setup.bash

サービスノードを実行します：

ros2 run cpp_srvcli server

ターミナルは以下のメッセージを返し、その後待機するはずです：

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

別のターミナルを開き、ros2_ws内から再度セットアップファイルをソースします。 クライアントノードを開始し、その後にスペースで区切られた任意の2つの整数を続けます。 例えば2と3を選択した場合、クライアントは以下のような応答を受信します：

ros2 run cpp_srvcli client 2 3

出力：

[INFO] [rclcpp]: Sum: 5

サービスノードが動作しているターミナルに戻ります。 要求とそれが受信したデータ、および送信した応答をログメッセージで公開しているのが見えます：

[INFO] [rclcpp]: Incoming request
a: 2 b: 3
[INFO] [rclcpp]: sending back response: [5]

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

まとめ

サービス上でデータを要求および応答する2つのノードを作成しました。 それらをビルドして実行できるように、パッケージ設定ファイルに依存関係と実行可能ファイルを追加し、サービス/クライアントシステムの動作を確認しました。

次のステップ

最後のいくつかのチュートリアルでは、トピックとサービス間でデータを渡すためにインターフェースを利用してきました。 次に、カスタムインターフェースの作成方法を学びます。

関連コンテンツ

C++でサービスとクライアントを書く方法はいくつかあります。ros2/examplesリポジトリのminimal_serviceとminimal_clientパッケージをチェックしてください。