Open Source Robotics

Une collection organisée de projets, outils et logiciels robotiques open source de haute qualité.

NoDL

Un fichier d'interface relisible par nœud ROS 2, qui génère son code, sa doc et ses contrôles de dérive

Licence

Apache-2.0

Aperçu

NoDL, le Node Definition Language, permet à un nœud ROS 2 de déclarer son interface — publishers, abonnements, services, actions, QoS et paramètres — dans un document unique que l'on relit comme n'importe quel contrat. À partir de ce document, il génère le câblage du nœud sous forme de classe de base abstraite C++ ou de classe de base rclpy, le comportement restant écrit à la main ; il produit une référence exacte de l'interface via une extension Sphinx pour rosdoc2 ; et il vérifie qu'un système en fonctionnement n'a pas dérivé par rapport à lui. Le sens inverse marche aussi : ros2 nodl describe observe un nœud en marche et rédige son NoDL, si bien qu'une base de code existante peut l'adopter sans réécriture. Il est développé par le groupe de travail ROSGraph de ROS 2 au sein de ros-tooling, et publié pour toutes les distributions ROS 2 actuelles.

L'interface d'un nœud ROS 2 ne vit nulle part en particulier. Les topics et services sont créés dans le code du constructeur, les paramètres déclarés là où quelqu'un y a pensé, la QoS n'est qu'un détail d'un point d'appel, et la seule description complète de ce qu'un nœud expose est le graphe en fonctionnement. NoDL place cette interface dans un fichier et fait de ce fichier la référence. Les auteurs restent prudents sur la portée : il vérifie des contrats de graphe — points de terminaison, types, QoS, paramètres — et dit clairement qu'il ne prouve ni le comportement, ni la sémantique des repères TF, ni l'ordonnancement, ni des garanties temps réel.

Le même document sert trois usages que l'on peut adopter séparément. La génération écrit la plomberie : le générateur C++ produit une classe de base abstraite avec tous les points de terminaison câblés et délègue les paramètres à generate_parameter_library, et le générateur Python fait de même pour rclpy, nœuds à cycle de vie compris. La documentation produit une référence d'interface à partir du fichier plutôt que de commentaires qui vieillissent. La conformité compare le contrat déclaré à ce qu'un nœud en marche expose réellement, et ros2 nodl diff compare deux documents hors ligne. ament_nodl enregistre les documents dans l'index ament et exécute la vérification du nœud en direct sous colcon test.

Le projet a débuté en 2020 et la version 2 est arrivée en septembre 2026 après une poussée de travail : paramètres imbriqués, génération Python des services, actions et cycles de vie, et un tutoriel exécutable avec le robot factice ont tous été fusionnés dans les deux semaines précédant la sortie. Ses progrès figurent dans les propres comptes rendus du PMC de ROS, et la version 2.1 est prévue pour la prochaine distribution ROS 2, en avril 2027.

Pourquoi c'est important

Le câblage des interfaces absorbe beaucoup de temps dans ROS 2 et abrite beaucoup de bogues d'intégration : un nom de topic changé dans un nœud et pas chez son consommateur, un paramètre que personne n'a documenté, une incompatibilité de QoS qui n'apparaît qu'à l'exécution. NoDL est la tentative du projet ROS lui-même de faire de l'interface d'un nœud un contrat explicite plutôt qu'une propriété qui émerge du code, et il vient du groupe de travail chargé des outils du graphe ROS. Cette provenance le rend digne d'attention même aussi tôt : s'il prend, c'est le genre de chose qui finit dans tous les modèles de projet.

Le problème résolu

L'interface d'un nœud ROS 2 est éparpillée dans le code du constructeur et n'est visible en entier que dans le graphe en fonctionnement ; elle reste donc sans documentation et dérive d'un nœud à l'autre. NoDL en fait un fichier unique et relu, qui génère le câblage, génère la documentation et repère un système en marche qui ne lui correspond plus.

Points clés

  • Un document NoDL déclare les publishers, abonnements, services, actions, QoS et paramètres d'un nœud
  • Génère le câblage de l'interface sous forme de classe de base abstraite C++ ou rclpy, le comportement restant écrit à la main
  • Produit une référence exacte de l'interface dans la documentation ROS via une extension Sphinx pour rosdoc2
  • Vérifie un nœud en marche par rapport à son contrat déclaré, et ros2 nodl diff compare des documents hors ligne
  • ros2 nodl describe rédige un NoDL à partir d'un nœud en marche : le code existant peut l'adopter sans réécriture
  • Développé par le groupe de travail ROSGraph de ROS 2 et publié pour Humble, Jazzy, Kilted, Lyrical et Rolling
  • La version 2 est sortie en septembre 2026 ; la 2.1 est prévue pour la distribution ROS 2 d'avril 2027

Pour qui

  • Les équipes ROS 2 dont les bogues d'intégration viennent de nœuds en désaccord sur les topics, types, QoS ou paramètres
  • Les mainteneurs de paquets qui veulent une documentation d'interface générée plutôt que tenue à la main
  • Quiconque démarre un nouveau nœud et préfère déclarer son interface une fois plutôt qu'écrire la plomberie à la main
  • Les responsables d'intégration continue qui veulent un colcon test qui échoue quand un nœud en marche s'écarte de son contrat

Limites

  • En phase d'adoption précoce de son propre aveu — la v2 est sortie et le schéma est dit raisonnablement stable, pas figé
  • Ne vérifie que le contrat de graphe ; ne prouve ni le comportement, ni la sémantique des repères TF, ni l'ordonnancement, ni les propriétés temps réel
  • La génération de code couvre C++ et Python ; il n'y a pas de générateur pour les autres bibliothèques clientes
  • Certaines dépendances des tests complets n'existent que via pip, donc les compilations de la ferme de build exécutent une suite réduite
  • Adopter la génération veut dire que votre nœud hérite d'une classe de base générée, un changement structurel pour du code existant
  • Petit groupe de mainteneurs — l'essentiel du travail récent vient d'une poignée de contributeurs

Ce site nécessite JavaScript. Veuillez activer JavaScript pour explorer nos projets de robotique open source.