机器人 / 系统课时
创建自定义 msg 字段结构
创建自定义 msg 字段结构
将温度传感器的一次采样固定为设备标识、采样时间和摄氏温度三个字段,并在 ROS 2 Jazzy 中定义、生成和检查 TemperatureReading.msg。完成后,发布者与订阅者可以共享同一消息类型,而不必解析约定格式的字符串。
学习目标
- 按数据含义选择
.msg的字段类型、名称与单位。 - 创建独立接口包,正确声明消息生成依赖。
- 编译并核验生成的消息接口,识别常见定义错误。
确定最小字段契约
假设两个温度探头每秒各发布一次读数。每条消息只需要回答三个问题:哪个探头、何时采样、测到多少摄氏度。
| 字段 | 类型 | 示例 | 约定 |
|---|---|---|---|
device_id |
string |
probe-01 |
设备稳定标识,不填 ROS 节点名 |
stamp |
builtin_interfaces/Time |
10 秒、200000000 纳秒 | 采样时刻,使用节点约定的 ROS 时钟 |
temperature_celsius |
float32 |
23.5 |
单位固定为 °C,允许负值 |
builtin_interfaces/Time 含 sec 和 nanosec 两个成员,不能简写成 time;float32 足以表达一般温度传感器的小数读数。无需再添加 unit 字符串或 frame_id:单位已由字段名约束,本例没有坐标系数据。
创建接口包与消息文件
以下操作适用于 Ubuntu 24.04、ROS 2 Jazzy 和 Bash,假设已安装 colcon,且 robot_interfaces 尚不存在。将接口放入 ament_cmake 包;使用它的 Python 节点仍可位于独立的 ament_python 包。
source /opt/ros/jazzy/setup.bash
mkdir -p ~/ros2_ws/src
cd ~/ros2_ws/src
# 单独创建接口包,避免与 Python 节点包混在一起
ros2 pkg create --build-type ament_cmake --license Apache-2.0 robot_interfaces
mkdir -p robot_interfaces/msg
test -d robot_interfaces/msg && echo 'msg directory ready'预期结果:命令末尾输出下列文本;包创建命令还会输出文件创建信息,实际路径可能不同。
msg directory ready在 ~/ros2_ws/src/robot_interfaces/msg/TemperatureReading.msg 写入以下完整内容:
# 发送端分配的设备标识
string device_id
# 采样发生时的 ROS 时间
builtin_interfaces/Time stamp
# 摄氏温度,读数可以小于零
float32 temperature_celsius.msg 每行是“类型 + 字段名”,# 后为注释。文件名用 TemperatureReading.msg 这种大驼峰形式,字段用 device_id 这种小写下划线形式;不要写 deviceId 或 temperature-Celsius。
配置接口生成依赖
msg 文件只是声明,须通过 rosidl 生成可导入的消息类型。下面两段都是片段示例,依赖刚才由 ros2 pkg create 生成的现有配置文件,不能单独作为完整文件使用。
在 robot_interfaces/CMakeLists.txt 中、现有 ament_package() 之前加入:
find_package(builtin_interfaces REQUIRED)
find_package(rosidl_default_generators REQUIRED)
# 生成消息代码时解析 Time 所在的接口包
rosidl_generate_interfaces(${PROJECT_NAME}
"msg/TemperatureReading.msg"
DEPENDENCIES builtin_interfaces
)
ament_export_dependencies(rosidl_default_runtime)在 robot_interfaces/package.xml 的 <package> 内加入以下依赖与接口包分组声明,保留已有的 ament_cmake 依赖及 <export> 配置:
<buildtool_depend>rosidl_default_generators</buildtool_depend>
<depend>builtin_interfaces</depend>
<exec_depend>rosidl_default_runtime</exec_depend>
<member_of_group>rosidl_interface_packages</member_of_group>rosidl_default_generators 用于构建,rosidl_default_runtime 用于运行,builtin_interfaces 提供 Time。如果遗漏 DEPENDENCIES builtin_interfaces,生成阶段可能无法解析引用的消息类型。
构建并检查字段
在工作空间根目录构建,并加载本地生成的接口。最后用 grep 只保留顶层三个字段,避免 ros2 interface show 展开 Time 内部成员时影响核对。
cd ~/ros2_ws
colcon build --packages-select robot_interfaces
source install/setup.bash
ros2 interface show robot_interfaces/msg/TemperatureReading | grep -E '^(string device_id|builtin_interfaces/Time stamp|float32 temperature_celsius)$'预期结果(仅列出最后一条命令筛出的字段;构建日志和耗时因机器而异):
string device_id
builtin_interfaces/Time stamp
float32 temperature_celsius如果提示找不到接口,先确认构建成功,再在当前终端重新执行 source ~/ros2_ws/install/setup.bash;如果 colcon 报找不到 builtin_interfaces,检查 CMakeLists.txt 的 find_package、DEPENDENCIES 与 package.xml 的依赖是否一致。修改 .msg 后必须重新构建,不能指望已生成的 Python 类自动更新。
后续发布采样消息时,应把 stamp 设为实际采样时刻,例如在 rclpy 节点中用 self.get_clock().now().to_msg() 获取时间;若使用仿真时间,相关节点还需要采用一致的时钟配置。消息保持三个字段即可,只有出现明确的新消费需求时才扩展接口。