大纲
在《Robot Operating System——初探动态配置Parameters》中,我们提到Node自身作为Parameters相关Service的服务端,与我们创建的rclcpp::SyncParametersClient、rclcpp::AsyncParametersClient客户端通信。本文我们将看看一个空的Node提供了哪些默认的Service和Parameters。
参考的例子是demo_nodes_cpp/src/parameters/parameter_blackboard.cpp。
其内容非常简单:继承于Node类,并自动声明了Node中的Parameters。
// Copyright 2019 Open Source Robotics Foundation, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include <memory>
#include <string>
#include "rcl_interfaces/srv/list_parameters.hpp"
#include "rclcpp/rclcpp.hpp"
#include "rclcpp_components/register_node_macro.hpp"
#include "demo_nodes_cpp/visibility_control.h"
namespace demo_nodes_cpp
{
class ParameterBlackboard : public rclcpp::Node
{
public:
DEMO_NODES_CPP_PUBLIC
explicit ParameterBlackboard(
rclcpp::NodeOptions options
)
: Node(
"parameter_blackboard",
options.allow_undeclared_parameters(true).
automatically_declare_parameters_from_overrides(true))
{
RCLCPP_INFO(
this->get_logger(),
"Parameter blackboard node named '%s' ready, and serving '%zu' parameters already!",
this->get_fully_qualified_name(), this->list_parameters(
{}, rcl_interfaces::srv::ListParameters::Request::DEPTH_RECURSIVE).names.size());
}
};
} // namespace demo_nodes_cpp
RCLCPP_COMPONENTS_REGISTER_NODE(demo_nodes_cpp::ParameterBlackboard)
我们通过下面的命令运行这个程序
./build/demo_nodes_cpp/parameter_blackboard
然后我们在新的终端中,使用ROS2 Cli来查看这个运行中的Node。
运行之前我们需要初始化下环境:
source /opt/ros/jazzy/setup.bash
查询Node的Parameters
我们先看看系统中运行了哪些Node。
ros2 node list
可以看到只有刚启动的/parameter_blackboard在运行。
然后我们可以通过下面指令查看上述Node中的Parameters。
ros2 param list /parameter_blackboard
或者使用dump指令
ros2 param dump /parameter_blackboard
查询Node的Service
使用下面命令查看这个Node暴露的信息
ros2 node info /parameter_blackboard
可以看到,空的Node有:
- /parameter_events的发布者和订阅者。这说明Node自身可能会对这类Topic进行内部处理。具体这块的内容,我们在后续文章中会做分析。
- /rosout的发布者。这说明该Node的Log可能是通过发布消息进行的。
- 包括/parameter_blackboard/set_parameters、/parameter_blackboard/list_parameters等在内的一系列Service。这就是我们刚提到的,Node暴露出来的有关Parameters的服务端。
具体这些Service的说明如下:
describe_parameters
- 作用:返回一组参数的描述信息。这些信息包括参数的名称、类型、是否只读等。
- 使用场景:当你需要了解节点中特定参数的详细信息时,可以使用此方法。
ros2 service call /parameter_blackboard/describe_parameters rcl_interfaces/srv/DescribeParameters "{names: ['qos_overrides./parameter_events.publisher.depth', 'qos_overrides./parameter_events.publisher.durability']}"
get_parameter_types
- 作用:查询一组参数的类型。
- 使用场景:当你需要知道特定参数的数据类型(如整型、浮点型、字符串等)时,可以使用此方法。
ros2 service call /parameter_blackboard/get_parameter_types rcl_interfaces/srv/GetParameterTypes "{names: ['qos_overrides./parameter_events.publisher.depth', 'qos_overrides./parameter_events.publisher.durability']}"
get_parameters
- 作用:获取一组参数的当前值。
- 使用场景:当你需要读取节点中一个或多个参数的值时,可以使用此方法。
ros2 service call /parameter_blackboard/get_parameters rcl_interfaces/srv/GetParameters "{names: ['qos_overrides./parameter_events.publisher.depth', 'qos_overrides./parameter_events.publisher.durability']}"
get_type_description
- 作用:动态获取适当的类型描述。
- 使用场景:当你需要完整的编程类型描述时,可以使用此方法。
list_parameters
- 作用:列出节点中满足某些条件的参数名称。可以指定搜索的深度。
- 使用场景:当你需要知道节点中有哪些参数,或者需要找到符合特定条件的参数集合时,可以使用此方法。
ros2 service call /parameter_blackboard/list_parameters rcl_interfaces/srv/ListParameters "{prefixes: ['qos_overrides'],
depth: 10}"
set_parameters
- 作用:设置一组参数的值。这个操作不是原子性的,意味着如果设置多个参数,一些可能会成功而其他可能会失败。
- 使用场景:当你需要修改节点中一个或多个参数的值时,可以使用此方法。
ros2 service call /parameter_blackboard/set_parameters rcl_interfaces/srv/SetParameters "{parameters: [{name: 'example_parameter1', value: {type: 2, integer_value: 10}}, {name: 'example_parameter2', value: {type: 1, bool_value: true}}]}"
可以看到,我们传递了两个参数,返回两个设置的结果。
set_parameters_atomically
- 作用:以原子方式设置一组参数的值。这意味着要么所有的更改都成功应用,要么一个也不应用。
- 使用场景:当你需要确保多个参数更改要么全部成功要么全部失败时,可以使用此方法。
ros2 service call /parameter_blackboard/set_parameters_atomically rcl_interfaces/srv/SetParametersAtomically "{parameters: [{name: 'example_parameter1', value: {type: 2, integer_value: 10}}, {name: 'example_parameter2', value: {type: 1, bool_value: true}}]}"
可以看到,我们传递了两个参数,返回一个设置的结果——整体作为一个动作进行。