Open Source Robotics

Eine kuratierte Sammlung hochwertiger Open-Source-Robotikprojekte, Werkzeuge und Software für die Robotik-Community.

NoDL

Eine prüfbare Schnittstellendatei pro ROS-2-Knoten, daraus Code, Doku und Drift-Checks

Lizenz

Apache-2.0

Überblick

NoDL, die Node Definition Language, lässt einen ROS-2-Knoten seine Schnittstelle — Publisher, Subscriptions, Services, Actions, QoS und Parameter — in einem einzigen Dokument deklarieren, das sich wie jeder andere Vertrag reviewen lässt. Aus diesem Dokument erzeugt es die Verdrahtung des Knotens als abstrakte C++-Basisklasse oder rclpy-Basisklasse, das Verhalten bleibt handgeschrieben; es rendert über eine rosdoc2-Sphinx-Erweiterung eine exakte Schnittstellenreferenz; und es prüft ein laufendes System gegen das Dokument auf Drift. Auch die umgekehrte Richtung funktioniert: ros2 nodl describe beobachtet einen laufenden Knoten und entwirft dessen NoDL, sodass eine bestehende Codebasis es ohne Neuschreiben übernehmen kann. Entwickelt wird es von der ROSGraph Working Group von ROS 2 unter ros-tooling, veröffentlicht für jede aktuelle ROS-2-Distribution.

Die Schnittstelle eines ROS-2-Knotens lebt nirgendwo im Besonderen. Topics und Services entstehen im Konstruktorcode, Parameter werden deklariert, wo jemand daran gedacht hat, QoS ist ein Detail einer Aufrufstelle, und die einzige vollständige Beschreibung dessen, was ein Knoten bereitstellt, ist der laufende Graph. NoDL legt diese Schnittstelle in eine Datei und macht die Datei maßgeblich. Die Autoren sind beim Umfang vorsichtig: Es prüft Graphverträge — Endpunkte, Typen, QoS, Parameter — und sagt klar, dass es weder Verhalten noch TF-Frame-Semantik, Scheduling oder Echtzeitgarantien nachweist.

Dasselbe Dokument dient drei Zwecken, die sich einzeln übernehmen lassen. Die Generierung schreibt die Verrohrung: Der C++-Generator erzeugt eine abstrakte Basisklasse mit allen Endpunkten verdrahtet und delegiert Parameter an generate_parameter_library, der Python-Generator tut dasselbe für rclpy, einschließlich Lifecycle-Knoten. Die Dokumentation rendert eine Schnittstellenreferenz aus der Datei statt aus Kommentaren, die veralten. Die Konformitätsprüfung vergleicht den deklarierten Vertrag mit dem, was ein laufender Knoten tatsächlich bereitstellt, und ros2 nodl diff vergleicht zwei Dokumente offline. ament_nodl registriert Dokumente im ament-Index und führt die Live-Prüfung unter colcon test aus.

Das Projekt begann 2020, Version 2 erschien im September 2026 nach einem Arbeitsschub: verschachtelte Parameter, Python-Generierung für Services, Actions und Lifecycle sowie ein lauffähiges Dummy-Robot-Tutorial wurden alle in den zwei Wochen vor dem Release übernommen. Über den Fortschritt wird in den eigenen Protokollen des ROS PMC berichtet, und Version 2.1 ist für die nächste ROS-2-Distribution im April 2027 geplant.

Warum es wichtig ist

In der Schnittstellenverdrahtung steckt viel ROS-2-Zeit und viele Integrationsfehler: ein Topic-Name, der in einem Knoten geändert wurde und in seinem Konsumenten nicht, ein Parameter, den niemand dokumentiert hat, eine QoS-Unstimmigkeit, die erst zur Laufzeit auffällt. NoDL ist der eigene Versuch des ROS-Projekts, die Knotenschnittstelle zu einem expliziten Vertrag zu machen statt zu einer Eigenschaft, die sich aus dem Code ergibt — von der Arbeitsgruppe, die für die ROS-Graph-Werkzeuge zuständig ist. Diese Herkunft macht es schon so früh beobachtenswert: Setzt es sich durch, landet es in jeder Vorlage.

Welches Problem es löst

Die Schnittstelle eines ROS-2-Knotens ist über Konstruktorcode verstreut und nur im laufenden Graphen vollständig sichtbar, deshalb bleibt sie undokumentiert und driftet zwischen Knoten auseinander. NoDL macht daraus eine einzige geprüfte Datei, die die Verdrahtung und die Dokumentation erzeugt und ein laufendes System erkennt, das nicht mehr zu ihr passt.

Wichtigste Punkte

  • Ein NoDL-Dokument deklariert Publisher, Subscriptions, Services, Actions, QoS und Parameter eines Knotens
  • Erzeugt die Schnittstellenverdrahtung als abstrakte C++- oder rclpy-Basisklasse, das Verhalten bleibt handgeschrieben
  • Rendert über eine rosdoc2-Sphinx-Erweiterung eine exakte Schnittstellenreferenz in die ROS-Dokumentation
  • Prüft einen laufenden Knoten gegen seinen deklarierten Vertrag, ros2 nodl diff vergleicht Dokumente offline
  • ros2 nodl describe entwirft eine NoDL aus einem laufenden Knoten, bestehender Code kann sie also ohne Neuschreiben übernehmen
  • Entwickelt von der ROSGraph Working Group von ROS 2 und veröffentlicht für Humble, Jazzy, Kilted, Lyrical und Rolling
  • Version 2 erschien im September 2026, 2.1 ist für die ROS-2-Distribution im April 2027 geplant

Für wen

  • ROS-2-Teams, deren Integrationsfehler daher kommen, dass Knoten sich über Topics, Typen, QoS oder Parameter uneinig sind
  • Paket-Maintainer, die Schnittstellendokumentation generiert statt von Hand gepflegt haben wollen
  • Alle, die einen neuen Knoten beginnen und seine Schnittstelle lieber einmal deklarieren, als die Verrohrung von Hand zu schreiben
  • CI-Verantwortliche, die einen colcon test wollen, der fehlschlägt, wenn ein laufender Knoten von seinem Vertrag abweicht

Einschränkungen

  • Nach eigener Aussage im Stadium früher Übernahme — v2 ist erschienen, das Schema gilt als einigermaßen stabil, nicht als festgelegt
  • Prüft nur den Graphvertrag; Verhalten, TF-Frame-Semantik, Scheduling oder Echtzeiteigenschaften weist es nicht nach
  • Codegenerierung gibt es für C++ und Python; für andere Client-Bibliotheken fehlt ein Generator
  • Einige Abhängigkeiten der vollständigen Tests gibt es nur über pip, daher laufen die Buildfarm-Builds mit reduzierter Testsuite
  • Wer die Generierung übernimmt, lässt seinen Knoten von einer generierten Basisklasse erben — eine strukturelle Änderung für bestehenden Code
  • Kleine Maintainer-Gruppe — der Großteil der jüngsten Arbeit stammt von einer Handvoll Mitwirkender

Diese Website benötigt JavaScript. Bitte aktivieren Sie JavaScript, um unsere Open-Source-Robotikprojekte zu erkunden.