NoDL
ROS 2 ノードごとに一つのレビュー可能なインターフェース定義から、コード・文書・逸脱検査を生成
ライセンス
Apache-2.0
概要
NoDL(Node Definition Language)は、ROS 2 のノードがそのインターフェース——パブリッシャ、サブスクリプション、サービス、アクション、QoS、パラメータ——を一つの文書で宣言できるようにします。その文書は他の契約と同じようにレビューできます。NoDL はそこから、ノードの配線を C++ の抽象基底クラスまたは rclpy の基底クラスとして生成し(振る舞いは手書きのまま)、rosdoc2 の Sphinx 拡張で正確なインターフェース参照を描き出し、稼働中のシステムがそこから逸脱していないかを検査します。逆方向も可能で、ros2 nodl describe は稼働中のノードを観察してその NoDL の下書きを作るため、既存のコードベースも書き直さずに導入できます。開発しているのは ros-tooling 配下の ROS 2 ROSGraph ワーキンググループで、現行のすべての ROS 2 ディストリビューション向けにリリースされています。
ROS 2 のノードのインターフェースは、どこか決まった場所にあるわけではありません。トピックやサービスはコンストラクタのコードで作られ、パラメータは誰かが思い出した場所で宣言され、QoS は呼び出し箇所の細部にすぎず、ノードが何を公開しているかを完全に記述しているのは稼働中のグラフだけです。NoDL はそのインターフェースを一つのファイルに収め、そのファイルを正本にします。作者は範囲について慎重で、検査するのはグラフの契約——エンドポイント、型、QoS、パラメータ——であり、振る舞い、TF フレームの意味、スケジューリング、リアルタイム性の保証を証明するものではないと明言しています。
同じ文書が、別々に導入できる三つの用途に使えます。生成は配管部分を書きます。C++ ジェネレータはすべてのエンドポイントを配線した抽象基底クラスを出力し、パラメータは generate_parameter_library に委ねます。Python ジェネレータは rclpy 向けに同じことを行い、ライフサイクルノードにも対応します。文書化は、古びていくコメントではなくファイルからインターフェース参照を生成します。適合性検査は、宣言された契約と稼働中のノードが実際に公開しているものを比較し、ros2 nodl diff は二つの文書をオフラインで比較します。ament_nodl は文書を ament インデックスに登録し、稼働ノードの検査を colcon test の中で実行します。
プロジェクトは 2020 年に始まり、集中的な作業を経て 2026 年 9 月にバージョン 2 が出ました。入れ子のパラメータ、Python のサービス・アクション・ライフサイクル生成、実行可能なダミーロボットのチュートリアルは、いずれもリリース前の二週間でマージされたものです。進捗は ROS PMC 自身の議事録で報告されており、バージョン 2.1 は 2027 年 4 月の次期 ROS 2 ディストリビューションに合わせて予定されています。
重要な理由
インターフェースの配線は ROS 2 で多くの時間を食い、多くの統合バグが潜む場所です。あるノードでは変えたのに利用側では変えていないトピック名、誰も文書化していないパラメータ、実行時にしか現れない QoS の不一致。NoDL は、ノードのインターフェースをコードから自然に浮かび上がる性質ではなく明示的な契約にしようとする、ROS プロジェクト自身の試みであり、ROS のグラフ関連ツールを担うワーキンググループから出てきたものです。この出自こそ、まだ初期の段階でも注目に値する理由です。定着すれば、あらゆるテンプレートに入ることになる類いのものです。
解決する課題
ROS 2 ノードのインターフェースはコンストラクタのコードに散らばり、稼働中のグラフでしか全体が見えないため、文書化されず、ノード間で少しずつずれていきます。NoDL はそれをレビュー済みの一つのファイルにし、そこから配線とドキュメントを生成し、もはやそれと一致しない稼働中のシステムを見つけ出します。
主なポイント
- 一つの NoDL 文書で、ノードのパブリッシャ、サブスクリプション、サービス、アクション、QoS、パラメータを宣言する
- インターフェースの配線を C++ または rclpy の基底クラスとして生成し、振る舞いは手書きのまま残す
- rosdoc2 の Sphinx 拡張で、正確なインターフェース参照を ROS のドキュメントに描き出す
- 稼働中のノードを宣言された契約と照合し、ros2 nodl diff で文書同士をオフラインで比較する
- ros2 nodl describe で稼働中のノードから NoDL を下書きできるため、既存コードも書き直さずに導入できる
- ROS 2 の ROSGraph ワーキンググループが開発し、Humble・Jazzy・Kilted・Lyrical・Rolling 向けにリリース
- バージョン 2 は 2026 年 9 月に公開。2.1 は 2027 年 4 月の ROS 2 ディストリビューションに予定
対象
- トピック・型・QoS・パラメータをめぐるノード間の食い違いが統合バグの原因になっている ROS 2 チーム
- インターフェース文書を手作業で保守するのではなく生成したいパッケージ保守者
- 新しいノードを作るにあたり、配管を手書きするよりインターフェースを一度宣言したい人
- 稼働中のノードが契約から外れたら失敗する colcon test がほしい CI 担当者
制限事項
- 自身の説明でも早期導入の段階——v2 は出ており、スキーマはかなり安定しているとされるが確定ではない
- 検査するのはグラフの契約のみで、振る舞い、TF フレームの意味、スケジューリング、リアルタイム性は証明しない
- コード生成は C++ と Python のみで、他のクライアントライブラリ向けのジェネレータはない
- 完全なテストの依存関係の一部は pip でしか入手できないため、ビルドファームでのビルドは縮小したテストで走る
- 生成を採用すると、ノードは生成された基底クラスを継承することになり、既存コードにとっては構造的な変更になる
- 保守者の層は薄く、最近の作業の大半は数人の貢献者によるもの