Open Source Robotics

Una colección curada de proyectos, herramientas y software de robótica de código abierto de alta calidad.

NoDL

Un archivo de interfaz revisable por nodo ROS 2 que genera su código, documentación y controles de deriva

Licencia

Apache-2.0

Resumen

NoDL, el Node Definition Language, permite que un nodo de ROS 2 declare su interfaz —publicadores, suscripciones, servicios, acciones, QoS y parámetros— en un único documento que puede revisarse como cualquier otro contrato. A partir de él genera el cableado del nodo como una clase base abstracta de C++ o una clase base de rclpy, dejando el comportamiento escrito a mano; genera una referencia exacta de la interfaz mediante una extensión de Sphinx para rosdoc2; y comprueba si un sistema en marcha se ha desviado de él. También funciona en sentido inverso: ros2 nodl describe observa un nodo en ejecución y redacta su NoDL, de modo que un código existente puede adoptarlo sin reescribirse. Lo desarrolla el grupo de trabajo ROSGraph de ROS 2 dentro de ros-tooling, y está publicado para todas las distribuciones actuales de ROS 2.

La interfaz de un nodo de ROS 2 no vive en ningún sitio concreto. Los tópicos y servicios se crean en el código del constructor, los parámetros se declaran donde alguien se acordó de hacerlo, la QoS es un detalle de una llamada y la única descripción completa de lo que expone un nodo es el grafo en ejecución. NoDL pone esa interfaz en un archivo y lo convierte en la referencia autorizada. Los autores son cuidadosos con el alcance: comprueba contratos del grafo —extremos, tipos, QoS, parámetros— y dice con claridad que no demuestra el comportamiento, la semántica de los marcos TF, la planificación ni garantías de tiempo real.

El mismo documento sirve para tres usos que se pueden adoptar por separado. La generación escribe la fontanería: el generador de C++ produce una clase base abstracta con todos los extremos cableados y delega los parámetros en generate_parameter_library, y el generador de Python hace lo mismo para rclpy, incluidos los nodos de ciclo de vida. La documentación genera una referencia de la interfaz a partir del archivo y no de comentarios que se quedan desfasados. La conformidad compara el contrato declarado con lo que un nodo en marcha expone de verdad, y ros2 nodl diff compara dos documentos sin conexión. ament_nodl registra los documentos en el índice de ament y ejecuta la comprobación del nodo en vivo dentro de colcon test.

El proyecto empezó en 2020 y la versión 2 llegó en septiembre de 2026 tras un empujón de trabajo: parámetros anidados, generación en Python de servicios, acciones y ciclo de vida, y un tutorial ejecutable del robot de prueba se fusionaron en las dos semanas previas al lanzamiento. Su avance figura en las propias actas del PMC de ROS, y la versión 2.1 está prevista para la siguiente distribución de ROS 2, en abril de 2027.

Por qué importa

El cableado de interfaces se lleva mucho tiempo en ROS 2 y alberga muchos fallos de integración: un nombre de tópico que cambió en un nodo y no en su consumidor, un parámetro que nadie documentó, un desajuste de QoS que solo aparece en ejecución. NoDL es el intento del propio proyecto ROS de convertir la interfaz del nodo en un contrato explícito en lugar de una propiedad que emerge del código, y viene del grupo de trabajo responsable de las herramientas del grafo de ROS. Esa procedencia es lo que lo hace digno de seguir aun tan pronto: si cuaja, es el tipo de cosa que acaba en todas las plantillas.

Qué problema resuelve

La interfaz de un nodo de ROS 2 está repartida por el código del constructor y solo se ve completa en el grafo en ejecución, así que queda sin documentar y se va desalineando entre nodos. NoDL la convierte en un único archivo revisado que genera el cableado, genera la documentación y detecta un sistema en marcha que ya no coincide con él.

Puntos clave

  • Un documento NoDL declara los publicadores, suscripciones, servicios, acciones, QoS y parámetros de un nodo
  • Genera el cableado de la interfaz como clase base abstracta de C++ o de rclpy, dejando el comportamiento escrito a mano
  • Produce una referencia exacta de la interfaz dentro de la documentación de ROS mediante una extensión de Sphinx para rosdoc2
  • Comprueba un nodo en ejecución contra su contrato declarado, y ros2 nodl diff compara documentos sin conexión
  • ros2 nodl describe redacta un NoDL a partir de un nodo en vivo, así que el código existente puede adoptarlo sin reescribirse
  • Desarrollado por el grupo de trabajo ROSGraph de ROS 2 y publicado para Humble, Jazzy, Kilted, Lyrical y Rolling
  • La versión 2 salió en septiembre de 2026; la 2.1 está prevista para la distribución de ROS 2 de abril de 2027

Para quién es

  • Equipos de ROS 2 cuyos fallos de integración vienen de nodos que no coinciden en tópicos, tipos, QoS o parámetros
  • Mantenedores de paquetes que quieren documentación de interfaz generada en lugar de mantenida a mano
  • Quien empiece un nodo nuevo y prefiera declarar su interfaz una vez antes que escribir la fontanería a mano
  • Responsables de CI que quieren un colcon test que falle cuando un nodo en marcha se aparta de su contrato

Limitaciones

  • En fase de adopción temprana según su propia descripción: la v2 ya salió y el esquema se considera razonablemente estable, no cerrado
  • Solo comprueba el contrato del grafo; no demuestra comportamiento, semántica de marcos TF, planificación ni propiedades de tiempo real
  • La generación de código cubre C++ y Python; no hay generador para otras bibliotecas cliente
  • Algunas dependencias de las pruebas completas solo existen en pip, así que las compilaciones de la granja de construcción ejecutan un conjunto reducido
  • Adoptar la generación implica que tu nodo herede de una clase base generada, un cambio estructural para el código existente
  • Grupo pequeño de mantenedores: la mayor parte del trabajo reciente viene de un puñado de colaboradores

Este sitio web requiere JavaScript. Por favor, habilite JavaScript para explorar nuestros proyectos de robótica.