Ros中动态参数的配置与应用——dynamic reconfigure

目录

代码结构体

创建配置文件

1. 首先通过以下命令行创建一个功能包dynamic_tutorials

2. 实现动态参数配置需要编写一个配置文件

3. 添加编译规则

创建应用节点

 动态参数修改

---

 

---

代码结构体

创建配置文件

1. 首先通过以下命令行创建一个功能包dynamic_tutorials

catkin_create_pkg dynamic_tutorials rospy roscpp dynamic_reconfigure

2. 实现动态参数配置需要编写一个配置文件

在功能包中创建一个放置配置文件的cfg目录，然后在其中创建一个配置文件Tutorials.cfg

#!/usr/bin/env python
PACKAGE = "dynamic_tutorials"
from dynamic_reconfigure.parameter_generator_catkin import *

gen = ParameterGenerator()
gen.add("int_param", int_t, 0, "An Integer parameter", 50, 0, 100)
gen.add("double_param", double_t, 0, "A double parameter", .5, 0, 1)
gen.add("str_param", str_t, 0, "A string parameter", "Hello World")
gen.add("bool_param", bool_t, 0, "A Boolean parameter", True)

size_enum = gen.enum([ gen.const("Small", int_t, 0, "A small constant"),
                       gen.const("Medium", int_t, 1, "A medium constant"),
                       gen.const("Large", int_t, 2, "A large constant"),
                       gen.const("ExtraLarge", int_t, 3, "An extra large constant")], "An enum to set size")

gen.add("size", int_t, 0, "A size parameter which is edited via an enum", 1, 0, 3, edit_method=size_enum)
exit(gen.generate(PACKAGE, "dynamic_tutorials", "Tutorials"))

配置文件详解：

#!/usr/bin/env python
PACKAGE = "dynamic_tutorials"

↑↑↑↑↑此处为动态参数配置文件必备的两句设置，指明python为解释器。PACKAGE为所在包的包名。

from dynamic_reconfigure.parameter_generator_catkin import *

↑↑↑↑↑需要导入dynamic_reconfigure功能包提供的参数生成器parameter generator）

gen = ParameterGenerator()

↑↑↑↑↑创建一个参数生成器，接下来就可以开始定义需要动态配置的参数了

gen.add("int_param", int_t, 0, "An Integer parameter", 50, 0, 100)

这里定义了四个不同类型的参数，生成参数可以使用参数生成器的
add(name, type, level, description, default, min, max)
的方法实现，方法传入参数的意义如下：

• name：参数名，使用字符串描述；
• type：定义参数的类型，可以是int_t, double_t, str_t, 或者bool_t；
• level：需要传入参数动态配置回调函数中的掩码，在回调函数中会修改所有参数的掩码，表示参数已经进行修改；
• description：描述参数作用的字符串；
• default：设置参数的默认值；
• min：可选，设置参数的最小值，对于字符串和布尔类型值不生效；
• max：可选，设置参数的最大值，对于字符串和布尔类型值不生效；

这种方法可以生成一个参数值，也可以使用如下方法生成一个枚举类型的值：

size_enum = gen.enum([ gen.const("Small", int_t, 0, "A small constant"),
                       gen.const("Medium", int_t, 1, "A medium constant"),
                       gen.const("Large", int_t, 2, "A large constant"),
                       gen.const("ExtraLarge", int_t, 3, "An extra large constant")], "An enum to set size")

gen.add("size", int_t, 0, "A size parameter which is edited via an enum", 1, 0, 3, edit_method=size_enum)

这里定义了一个int_t类型得到参数“size”，该参数的值可以通过一个枚举列出来。枚举的定义使用enum方法进行定义，其中使用const方法定义每一个枚举值的名称、类型、值、描述字符串。

exit(gen.generate(PACKAGE, "dynamic_tutorials", "Tutorials"))

最后一行代码用于生成所有C++和Python相关的文件并且退出程序，这里第二个参数表示动态参数运行的节点名，第三个参数是生成文件所使用的前缀，需要和配置文件名相同。

配置文件创建完成后，需要使用如下命令为配置文件添加可执行权限：chmod a+x cfg/Tutorials.cfg

3. 添加编译规则

类似于消息的定义，这里也需要生成代码文件，所以在CMakeLists.txt中添加如下编译规则：

#add dynamic reconfigure api
generate_dynamic_reconfigure_options(
  cfg/Tutorials.cfg
  #...
)

# make sure configure headers are built before any node using them
add_dependencies(dynamic_reconfigure_node ${PROJECT_NAME}_gencfg)

配置文件相关的工作就到此为止，接下来需要创建一个dynamic_reconfigure_node，来调用参数的动态配置。

创建应用节点

dynamic_reconfigure_node节点的代码实现server.cpp如下：

#include 

#include 
#include "dynamic_tutorials/TutorialsConfig.h"

void callback(dynamic_tutorials::TutorialsConfig &config, uint32_t level) {
    ROS_INFO("Reconfigure Request: %d %f %s %s %d", 
            config.int_param, config.double_param, 
            config.str_param.c_str(), 
            config.bool_param?"True":"False", 
            config.size);
}

int main(int argc, char **argv) 
{
    ros::init(argc, argv, "dynamic_tutorials");

    dynamic_reconfigure::Server server;
    dynamic_reconfigure::Server::CallbackType f;

    f = boost::bind(&callback, _1, _2);
    server.setCallback(f);

    ROS_INFO("Spinning node");
    ros::spin();
    return 0;
}

过程详解：

#include
#include
#include "dynamic_tutorials/TutorialsConfig.h"

↑↑↑↑↑首先需要包含必要的头文件，其中有一个TutorialsConfig.h头文件，就是配置文件所生成的。 

    ros::init(argc, argv, "dynamic_tutorials");
    dynamic_reconfigure::Server server;

↑↑↑↑↑初始化ROS节点，然后创建了一个参数动态配置的服务端实例，参数配置的类型就是配置文件中描述的类型。该服务端实例会监听客户端的参数配置请求。

dynamic_reconfigure::Server::CallbackType f;
f = boost::bind(&callback, _1, _2);
server.setCallback(f);

↑↑↑↑↑然后定义一个回调函数，并将回调函数和服务端绑定，当客户端请求修改参数时，服务端即可跳转到回调函数中进行处理。 

void callback(dynamic_tutorials::TutorialsConfig &config, uint32_t level) {
    ROS_INFO("Reconfigure Request: %d %f %s %s %d",
            config.int_param, config.double_param,
            config.str_param.c_str(),
            config.bool_param?"True":"False",
            config.size);
}

↑↑↑↑↑对于本例程来说，回调函数并不复杂。回调函数的传入参数有两个，一个是新的参数配置值，另外一个表示参数修改的掩码。然后在回调函数中将修改后的参数值打印出来。

代码编辑完成后在CmakeLists.txt中加入以下编译规则：

# for dynamic reconfigure
add_executable(dynamic_reconfigure_node src/server.cpp)

# make sure configure headers are built before any node using them
add_dependencies(dynamic_reconfigure_node ${PROJECT_NAME}_gencfg)

# for dynamic reconfigure
target_link_libraries(dynamic_reconfigure_node ${catkin_LIBRARIES})

现在就可以编译dynamic_tutorials功能包了。

cd ~/catkin_ws
catkin_make

 动态参数修改

编译成功后使用如下命令将roscore和dynamic_reconfigure_node运行起来:

roscore
rosrun dynamic_tutorials dynamic_reconfigure_node

这个时候参数动态配置的服务端就运行起来了。下面启动ROS提供的可视化参数配置工具来修改参数:

rosrun rqt_reconfigure rqt_reconfigure

在打开的如下图所示的可视化界面中，可以通过输入、拖动、下拉选择的方式动态修改参数，输入方式的不同和配置文件中的参数设置有关，例如设置了参数的最大最小值，就会有拖动条；设置为枚举类型，就会是下拉选项。

修改后可以在服务端的终端中看到修改成功的打印信息，如图所示↑↑↑↑↑