📘

ROS2を理解する上でのポイント

2023/09/03に公開

ROS2

robot

robotics

tech

解説対象

本記事では、ROS2を理解する上で頭にいれておいた方がよい基本概念を説明します。

本記事は下記の「ROS2を深く理解する」の記事群の一部ですが、この記事単独でも理解できるようになっています。

目標

本記事の目標は、ROS2におけるプログラミングスタイルが複数あることを理解することです。

前提

調査はROS2 humble時の実装に基づいていますが、基本的にdistributionに依存しない内容です。
調査はc++側の実装（rclcpp）に基づいていますが、基本的にクライアント言語に依存しない内容です。

公式ドキュメント

Concepts
- かなりあっさりで物足りません

参考情報

ROS2に関する基本情報
- よくまとまっています
駆け抜けるROS2
- ROS2ではROSノードをcomponent形式で開発すべきことが解説されている
ROS 2のAPIの使い方
- ROSノード周りの詳細な解説がありますが、特にexecutorの理解の参考になります
ROS 2のプロセス内（intra-process）通信を理解する
- パフォーマンスを上げるのに理解必須のプロセス内通信についての参考になります
ROS2でプロセス内通信によるゼロコピーを試す
- パフォーマンスを上げるにはゼロコピーの理解も必要

解説

ROS2におけるプログラミングとは

ROS2におけるプログラミングは、カジュアルな（＝ほとんどプログラミングしない）スタイルからゴリゴリの大規模開発スタイルまで、幅広く使える汎用性と拡張性を備えています。カジュアルな順番に開発スタイルを並べてみると下記のような雰囲気です。

スタイル	独自パッケージの開発	独自executableの開発	カスタムノードクラスの開発	説明
既存パッケージ利用のみ	×	×	×	既存パッケージで足りる場合は、パッケージを利用する為の設定である、launchファイル、ノードパラメータ設定ファイル（configファイル）だけをつくれば良いです。作成したlaunchファイル等は必ずしもパッケージ化しなくても構いません
launchパッケージ開発のみ	〇	×	×	ほとんど上記と変わりませんが、launchファイルを誰でも使えるように配布する場合パッケージ化しましょう
独自処理パッケージ開発（シンプル）	〇	〇	×	実際には多くのケースで既存パッケージの利用だけでは望むシステムは作れないので、独自処理を行えるようexecutableを作成します。独自処理を実装するにあたり、ROS2が提供する`Node`クラスや`LifecycleNode`クラスを使うだけでどうにかなる場合はカスタムROSノードクラスを作成する必要はありません。しかし、独自処理が`Node`や`LifecycleNode`の中にカプセル化されずexecutable上に実装されることになるため、複雑なシステムには向きません
独自処理パッケージ開発（カスタムノードクラスあり）	〇	〇	〇	複雑なシステムをつくる場合、ROS2が提供する`Node`や`LifecycleNode`を直接使うのでなく、それらを継承したカスタムROSノードクラスを実装し使用したくなります。カスタムROSノードクラスを作れば独自処理を中に埋め込め、オブジェクト指向で機能を実装でき、見通しが良くなります。カスタムROSノードクラスは直接executable上に定義せずlibraryに分離して定義するのが推奨です

以下では上記を理解する為の概念を説明していきます

ROS2を理解する上でのポイント

概念として、配布単位（package）、プログラム実行単位（executable/library）、論理処理単位（ROSノード）をちゃんと区別して把握することが重要です。

通常ROS2を用いたロボットシステムは、複数のpackageに含まれる複数のexecutableを実行することで複数のROSノードを生成し動作します。

ソフトウェアは、ファイル群としての存在であるpackageを単位として配布されます
- packageは、機能を実現する為の一連のプログラム（executable/library）ファイルや各種リソースファイル一式を提供します
ソフトウェアは、実行可能ファイルとしての存在であるexecutableを単位として実行します
- executableは、直接実行可能なプログラムです。基本的にはROSノードを生成し動作させる役目を果たします
- libraryは、他のexecutableから読み込まれて間接的に実行されるプログラムです。libraryは他のexecutableにロードされ実行されます。例えばlibraryで定義しているROSノードクラスは、libraryをロードしたexecutable上で使用できるようになります
ソフトウェアは、論理的な存在であるROSノードを単位として処理を行います
- ROSノードは、情報を所定のルールに従って入力・処理・出力します

下記で重要なポイントに絞って説明していきます。

ROSノードとは

ROSノードは、ROS1やROS2上で実行する処理を担うオブジェクト（論理処理単位）です
- ROSノードを単にノードと呼ぶことも多いですが、〇〇ノードという他の種類のノードも文脈によっては存在しうる為、区別するためにはROSノードと呼びます（例えば、移動ロボットのナビゲーションを行う文脈では、BTノードというノードが登場しますが、BTノードはROSノードではありません）
- ROSノードは、executable上でROSノードクラスをインスタンス化して生成します
標準ROSノードクラスとカスタムROSノードクラス
- ROS2には、標準ROSノードクラス（NodeクラスもしくはLifecycleNodeクラス）が定義されています。独自の処理を持ったROSノードを作るためにこれら標準ROSノードクラスをそのまま使用してもよいですが、標準ROSノードクラスを継承したクラス（＝カスタムROSノードノード）を作成して使用してもよいです
- 使い分け
  - 独自処理のコードをカプセル化したいならカスタムROSノードクラスを作成します
  - ライフサイクルイベントのハンドリングをする場合は、カスタムROSノードクラスを作成します
  - どちらも不要であれば、標準ROSノードクラスを直接用います
    - ただしこの場合独自処理（例えば、ROSノードにserviceサーバーを追加しserviceがコールされた時の処理を実装する）は、ROSノードクラス外（例えばexecutableで実行される関数中）に記述することになり、オブジェクト指向の考え方からすると全容を捉えにくい構成になることに注意が必要です
- カスタムROSノードクラスを作成する場合のベストプラクティス
  - カスタムROSノードクラスの定義は、executable中で定義することもlibrary中で定義することもどちらも可能であるが、下記が推奨です
    - library中でcomponent形式で定義する
    - executable側からlibrary中のカスタムROSノードクラスをロードして利用する
  - カスタムROSノードクラスを特定のexecutableに密結合させずに分離することで柔軟な運用が可能になります

ノード周りの詳細な解説は下記を参照ください

ROSノードを動かす手段

ROSノードは必ずexecutor上で動く
- rclcpp:spin(node)で実行した場合でも、内部でSingleThreadedExecutorが生成されその中でROSノードが動いています
ROSノードを動かすexecutorの実行を開始する方法は以下のどちらか
- ROSノードを動かす処理を記述したexecutableを実行することでROSノードの処理を開始する
- ROSノードを動かす処理を記述したlibraryをロードするexecutableを実行することでROSノードの処理を開始する

例えば、c++から他のプログラムファイルで定義されたカスタムROSノードクラス（my_namespace::MyNode）を動かす場合

rclcpp::executors::SingleThreadedExecutor exec;
auto my_node = std::make_shared<my_namespace::MyNode>(options);
exec.add_node(my_node);

executorとは

ROSノードを実行する為のスレッドプールを表すオブジェクト
1executor = 1 thread or 複数 thread
3種類あり
- SingleThreadedExecutor
- MultiThreadedExecutor
- StaticSingleThreadedExecutor
基本的には、1 executable=1 executorだが、 executable内で複数のexecutorを作成することも可能。

executable/libraryとは

executable/libraryという概念はROS2特有のものでなく、c/c++の世界（CMake）の用語。ROS2で初めてc++を学び始めた人は、先にCMakeについて学んでおく必要がある。
- executableもlibraryも、CMakeにおけるbuild targetの単位であり、CMakeist.txt中でビルドする為の情報（使用するソースファイル等）を指定しておき、colcon buildを行うことで生成される。
executableとは
- ユーザーもしくは他のexecutableから実行開始可能なプログラム（一群のソースコードから得られる）の単位。
- エントリーポイントなる関数（通常はmain）を持つ。
- プロセスとの関係
  - 1 executable = 1 process
libraryとは
- executableや他のlibraryからロード可能なプログラム（一群のソースコードから得られる）の単位。
- エントリーポイントなる関数を持たない。
  - libraryにはクラスを何でも定義できるが、外部から使用して欲しいクラスは所定の方式（=plugin形式）で公開する

ROS2におけるexecutableとは

ROSノードとの関係
- 必ずしもROSノードを動かす必要はないが、基本的にはROSノードを動かすexecutableを作成し、executableを起動して所定の目的を実現するのがROS2のスタイル。
- 1 executable = N ROSノード
  - シンプルなケースでは、1executable = 1ROSノードで作成することが多いが、複数のROSノードを実行することもできる。
  - 複数ROSノードを1 executable(=1 process)上で実行することで、ROSノード間の通信をプロセス内通信とすることができる。
使用方法
- launchの対象となれる。
- executableは通常の実行可能プログラムであり、直接コマンドラインから実行・プログラム中から実行も可能であるが、ROS2ではlaunchファイルから実行するのが通常のスタイル

ROS2におけるlibraryとは

ROSノードとの関係
- カスタムROSノードクラスをplugin形式で公開する為に使用する
- plugin形式の特別な形態としてcomponent形式がある。plugin形式では任意のクラスを公開できるが、component形式で公開できるのはROSノードクラスだけ。
- 基本的にROS2では、ROSノードクラスはpluginでなく全てcomponent形式とすることが推奨されている。
  - Components vs. Plugins in ROS 2
  - ただし、ros2_cotrolにおけるcontrollerやHW componentは、component形式でなく通常のplugin形式
- component形式のメリット
  - ROSノードを同じプロセス内に配置（同じexecutable上に配置）しROSノード間の通信をプロセス内通信にすることを、簡単に実装できる
  - componentは、自分で作成したexecutable上で実行することもできるが、rclcpp_componentsパッケージ内に標準で用意されているexecutableであるcomponent_containerを使用しても実行できる
- component形式でROSノードクラスを公開する方法
  - CMakeLists.txtでrclcpp_components_register_nodesを呼ぶ（呼ばない場合通常のplugin形式になる）
使用方法
- libraryがcomponent形式で作成された場合、launchの単位となることが可能
- libraryは実行可能プログラムではないので、直接コマンドラインから実行・プログラム中から実行はできないが、component形式で作成されていればlaunchファイルから起動できる。
  - その場合、1componentが乗ったexecutableが作成され実行される。

GitHubで編集を提案

解説対象

目標

前提

公式ドキュメント

参考情報

解説

ROS2におけるプログラミングとは

ROS2を理解する上でのポイント

ROSノードとは

ROSノードを動かす手段

executorとは

executable/libraryとは

ROS2におけるexecutableとは

ROS2におけるlibraryとは

Discussion