理解参数 (Understanding parameters)¶

目标：学习如何在 ROS 2 中获取、设置、保存和重载参数。

教程级别：初学者

时间：5 分钟

背景
先决条件
任务
- 1 设置
- 2 ros2 param list
- 3 ros2 param get
- 4 ros2 param set
- 5 ros2 param dump
- 6 ros2 param load
- 7 在节点启动时加载参数文件
总结
下一步

背景¶

参数是节点的配置值。您可以将参数视为节点设置。节点可以将参数存储为整数 (integers)、浮点数 (floats)、布尔值 (booleans)、字符串 (strings) 和列表 (lists)。在 ROS 2 中，每个节点都维护自己的参数。有关参数的更多背景信息，请参阅概念文档。

先决条件¶

本教程使用 turtlesim 包。

一如既往，不要忘记在打开的每个新终端中 source ROS 2。

任务¶

1 设置¶

启动两个 turtlesim 节点：/turtlesim 和 /teleop_turtle。

打开一个新终端并运行：

ros2 run turtlesim turtlesim_node

打开另一个终端并运行：

ros2 run turtlesim turtle_teleop_key

2 ros2 param list¶

要查看属于您的节点的参数，请打开一个新终端并输入以下命令：

ros2 param list

/teleop_turtle:
  qos_overrides./parameter_events.publisher.depth
  qos_overrides./parameter_events.publisher.durability
  qos_overrides./parameter_events.publisher.history
  qos_overrides./parameter_events.publisher.reliability
  scale_angular
  scale_linear
  use_sim_time
/turtlesim:
  background_b
  background_g
  background_r
  qos_overrides./parameter_events.publisher.depth
  qos_overrides./parameter_events.publisher.durability
  qos_overrides./parameter_events.publisher.history
  qos_overrides./parameter_events.publisher.reliability
  use_sim_time

每个节点都有参数 use_sim_time；它并非 turtlesim 独有。

根据名称，看起来 /turtlesim 的参数使用 RGB 颜色值来确定 turtlesim 窗口的背景颜色。

要确定参数的类型，可以使用 ros2 param get。

3 ros2 param get¶

要显示参数的类型和当前值，请使用命令：

ros2 param get <node_name> <parameter_name>

让我们找出 /turtlesim 的参数 background_g 的当前值：

ros2 param get /turtlesim background_g

Integer value is: 86

现在您知道 background_g 拥有一个整数值。

如果您对 background_r 和 background_b 运行相同的命令，您将分别获得值 69 和 255。

4 ros2 param set¶

要在运行时更改参数的值，请使用命令：

ros2 param set <node_name> <parameter_name> <value>

让我们更改 /turtlesim 的背景颜色：

ros2 param set /turtlesim background_r 150

Set parameter successful

您的 turtlesim 窗口的背景颜色应该会发生变化：

使用 set 命令设置参数只会更改当前会话中的参数，而不是永久更改。但是，您可以保存设置并在下次启动节点时重新加载它们。

5 ros2 param dump¶

您可以使用以下命令查看节点的所有当前参数值：

ros2 param dump <node_name>

默认情况下，该命令会打印到标准输出 (stdout)，但您也可以将参数值重定向到文件中以供日后保存。要将 /turtlesim 参数的当前配置保存到文件 turtlesim.yaml 中，请输入命令：

ros2 param dump /turtlesim > turtlesim.yaml

您将在 shell 运行的当前工作目录中找到一个新文件。如果您打开此文件，您将看到以下内容：

/turtlesim:
  ros__parameters:
    background_b: 255
    background_g: 86
    background_r: 150
    qos_overrides:
      /parameter_events:
        publisher:
          depth: 1000
          durability: volatile
          history: keep_last
          reliability: reliable
    use_sim_time: false

如果您想在将来使用相同的参数重新加载节点，转储 (dumping) 参数会很方便。

6 ros2 param load¶

您可以使用以下命令将文件中的参数加载到当前运行的节点：

ros2 param load <node_name> <parameter_file>

要将使用 ros2 param dump 生成的 turtlesim.yaml 文件加载到 /turtlesim 节点的参数中，请输入命令：

ros2 param load /turtlesim turtlesim.yaml

Set parameter background_b successful
Set parameter background_g successful
Set parameter background_r successful
Set parameter qos_overrides./parameter_events.publisher.depth failed: parameter 'qos_overrides./parameter_events.publisher.depth' cannot be set because it is read-only
Set parameter qos_overrides./parameter_events.publisher.durability failed: parameter 'qos_overrides./parameter_events.publisher.durability' cannot be set because it is read-only
Set parameter qos_overrides./parameter_events.publisher.history failed: parameter 'qos_overrides./parameter_events.publisher.history' cannot be set because it is read-only
Set parameter qos_overrides./parameter_events.publisher.reliability failed: parameter 'qos_overrides./parameter_events.publisher.reliability' cannot be set because it is read-only
Set parameter use_sim_time successful

注意只读参数只能在启动时修改，之后不能修改，这就是为什么会有一些关于“qos_overrides”参数的警告。

7 在节点启动时加载参数文件¶

要使用保存的参数值启动相同的节点，请使用：

ros2 run <package_name> <executable_name> --ros-args --params-file <file_name>

这与您通常用于启动 turtlesim 的命令相同，只是添加了标志 --ros-args 和 --params-file，后跟您要加载的文件。

停止正在运行的 turtlesim 节点，并尝试使用保存的参数重新加载它，使用：

ros2 run turtlesim turtlesim_node --ros-args --params-file turtlesim.yaml

turtlesim 窗口应该照常出现，但带有您之前设置的紫色背景。

注意当在节点启动时使用参数文件时，所有参数（包括只读参数）都将被更新。

总结¶

节点具有定义其默认配置值的参数。您可以从命令行获取 (get) 和设置 (set) 参数值。您还可以将参数设置保存到文件中，以便在以后的会话中重新加载它们。

下一步¶

回到 ROS 2 通信方法，在下一篇教程中，您将学习有关动作 (actions) 的内容。