Open Source Robotics

精选高质量开源机器人项目、工具和软件,推动机器人社区发展。

NoDL

每个 ROS 2 节点一份可审阅的接口文件,由它生成代码、文档与漂移检查

许可证

Apache-2.0

概述

NoDL(节点定义语言)让一个 ROS 2 节点在一份文档中声明它的接口——发布者、订阅者、服务、动作、QoS 与参数——这份文档可以像其他任何契约一样被审阅。它据此生成节点的连线代码:一个 C++ 抽象基类或一个 rclpy 基类,而行为逻辑仍由人手写;通过一个 rosdoc2 Sphinx 扩展渲染出精确的接口参考;并对照它检查运行中的系统是否发生了漂移。反方向同样可行:ros2 nodl describe 观察一个在线节点并起草它的 NoDL,因此现有代码库无需重写就能采用。它由 ROS 2 的 ROSGraph 工作组在 ros-tooling 下开发,并已为当前所有 ROS 2 发行版发布。

一个 ROS 2 节点的接口并不存在于任何特定的地方。话题和服务在构造函数代码里创建,参数则在有人记起来的地方声明,QoS 只是某个调用处的细节,而对一个节点究竟暴露了什么,唯一完整的描述就是运行中的图。NoDL 把这份接口放进一个文件,并让这个文件具有权威性。作者对范围说得很谨慎:它检查的是图的契约——端点、类型、QoS、参数——并明确表示它不证明行为、TF 坐标系语义、调度或实时性保证。

同一份文档服务于三种用途,可以分别采用。生成负责编写管道代码:C++ 生成器输出一个连好全部端点的抽象基类,并把参数交给 generate_parameter_library;Python 生成器则为 rclpy 做同样的事,包括生命周期节点。文档从文件而非会漂移的注释渲染出接口参考。一致性检查将声明的契约与运行中节点实际暴露的内容进行比较,而 ros2 nodl diff 可以离线比较两份文档。ament_nodl 把文档注册到 ament 索引,并在 colcon test 中运行在线节点检查。

项目始于 2020 年,第 2 版在一轮集中开发之后于 2026 年 9 月发布:嵌套参数、Python 的服务、动作与生命周期生成,以及一个可运行的 dummy-robot 教程,都在发布前的两周内合并。它的进展被写进了 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 负责人

局限

  • 按其自身描述仍处于早期采用阶段——第 2 版已发布,模式被称为相当稳定,而非定型
  • 只检查图的契约;不证明行为、TF 坐标系语义、调度或实时特性
  • 代码生成覆盖 C++ 与 Python;没有面向其他客户端库的生成器
  • 部分完整测试依赖只能通过 pip 安装,因此构建农场上的构建只运行精简的测试集
  • 采用代码生成意味着你的节点要继承一个生成的基类,这对现有代码是一次结构性改动
  • 维护者群体较小——近期的大部分工作来自少数几位贡献者

本网站需要 JavaScript 才能正常运行。请启用 JavaScript 以浏览我们的开源机器人项目。