机器人 / 系统课时

声明并读取节点参数

声明并读取节点参数

采样定时器如果把周期写死在代码里,每次调频都得修改程序。这里使用 ROS 2 Jazzy 的 rclpy 节点参数保存采样周期,让节点在启动时接受命令行覆盖,并通过日志和参数查询确认实际使用的数值。

学习目标

  • 使用 declare_parameter() 声明带默认值的参数,并通过 get_parameter() 读取。
  • 把定时器周期改为启动参数,运行时覆盖默认值并验证。
  • 区分启动时参数覆盖与运行中动态调整定时器。

参数声明与读取规则

在 rclpy.node.Node 子类中,先调用 self.declare_parameter('sample_period', 1.0),再通过 self.get_parameter('sample_period').value 取出当前值。这里的 1.0 是浮点数,表示默认周期为 1 秒;传入 0.5 时,目标采样频率约为 2 Hz。

declare_parameter() 会优先采用节点启动时为同名参数提供的覆盖值;没有覆盖时才使用默认值。参数名必须前后一致,读取未声明的参数通常会抛出异常。参数值只决定随后如何创建定时器,不会自动让已创建的定时器改变周期。

编写可运行的采样节点

适用环境为 Ubuntu 24.04 + ROS 2 Jazzy,使用已安装的 rclpy,不要求先创建功能包。将以下完整程序保存为当前目录的 sampling_node.py:

python
import math

import rclpy
from rclpy.node import Node


class SamplingNode(Node):
    def __init__(self):
        super().__init__('sampling_node')
        self.declare_parameter('sample_period', 1.0)
        period = self.get_parameter('sample_period').value

        # 周期应为有限的正浮点秒数,避免创建无效定时器
        if not isinstance(period, float) or not math.isfinite(period) or period <= 0:
            raise ValueError('sample_period must be a positive double')

        self.count = 0
        self.timer = self.create_timer(period, self.sample)
        self.get_logger().info(f'sample_period={period:.2f}s')

    def sample(self):
        self.count += 1
        # 用递增计数模拟一次采样,实际可替换为传感器读取
        self.get_logger().info(f'sample #{self.count}')


def main(args=None):
    rclpy.init(args=args)
    node = None
    try:
        node = SamplingNode()
        rclpy.spin(node)
    except KeyboardInterrupt:
        pass
    finally:
        if node is not None:
            node.destroy_node()
        if rclpy.ok():
            rclpy.shutdown()


if __name__ == '__main__':
    main()

预期结果:程序启动时先打印实际周期,之后每次定时器回调将计数加一。rclpy.spin() 负责调度回调;按 Ctrl+C 结束后,程序释放节点并关闭 ROS 上下文。

启动覆盖并核对参数

在包含 sampling_node.py 的目录打开终端,先加载 Jazzy 环境,再使用 --ros-args -p 指定启动参数:

bash
source /opt/ros/jazzy/setup.bash
python3 sampling_node.py --ros-args -p sample_period:=0.5

预期输出(节选):

text
[INFO] [<TIME>] [sampling_node]: sample_period=0.50s
[INFO] [<TIME>] [sampling_node]: sample #1
[INFO] [<TIME>] [sampling_node]: sample #2

<TIME> 是动态时间戳,实际数字会不同;计数继续增长,日志间隔约为 0.5 秒,不保证硬实时精度。保持节点运行,在另一终端检查其参数:

bash
source /opt/ros/jazzy/setup.bash
ros2 param get /sampling_node sample_period

预期输出:

text
Double value is: 0.5

不带 -p 启动则使用默认的 1.0 秒。ros2 param get 显示的是节点当前保存的参数值,与启动日志一致时,说明覆盖和读取都已成功。

常见错误与生效边界

  • 覆盖值写成整数 1:此例默认值为浮点型,建议统一写 1.0 或 0.5,避免参数类型不匹配。
  • 传入 0.0 或负数:程序会在创建定时器前报 ValueError;周期必须是大于零的有限浮点数。
  • 只更改运行中的参数:即使通过 ros2 param set 改变参数值,本示例已创建的 create_timer() 也不会自动更新周期。要改变实际节奏,按新参数重启节点;若必须在线改频,则需额外实现参数更新处理与定时器重建。
  • 查询不到节点:先确认程序仍在运行、两个终端已加载 ROS 环境且 ROS_DOMAIN_ID 一致,再执行 ros2 node list 检查是否存在 /sampling_node。

这样便能把采样周期从硬编码改为启动配置,且可分别验证参数值和定时器实际回调间隔。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

声明并读取节点参数

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通