机器人的参数一般会提前设置好，这些参数都会放在yaml文件里，但有些参数是需要动态改变的，调试导航时尤其如此。于是ROS提供了rosparam命令和参数服务器这两个工具。rosparam命令的方便之处在于它可以直接读取yaml文件中的参数，而不必自己找第三方库去文件中读取。

一般在package的文件夹里会建一个param文件夹，也就是与launch和msg同一级，yaml文件就放在这个param文件夹里。

使用rosparam load file.yaml命令将多个参数加载到参数服务器，在用到时会从服务器中获取。但实际上，这个命令直接用得不多。要将一个yaml文件中的参数在节点启动时都加载到参数服务器，一般是在launch文件中使用rosparam标签:

1
2

<rosparam file="$(find turtlebot_navigation)/param/move_base_params.yaml" command="load" />
<rosparam file="$(arg custom_param_file)" command="load" />

在launch文件里，如果参数paramA是在某个node之内的，那么它的全名是/node/paramA。如果希望全名是paramA，那么不应在任何node内，一般写在launch开头。

使用rosparam get时要注意，参数名称不只是yaml文件中的名称，而是一个完整名称，比如.yaml中是这样的:

1
2
3

TrajectoryPlannerROS:
  int_param: 2
  max_vel_x: 0.15

启动ROS节点后, 用rosparam get param可获知各个参数值，而且发现在关掉所有节点后，仍然能用rosparam get获得参数值，可见它被存到参数服务器里了

程序中的param

加载参数的方法其实有三种，除了上面说的直接用rosparam load命令和launch文件中使用load外，还可以在程序中使用param和setParam,getParam函数，这里和yaml文件就没关系了。

1
2
3
4
5
6
7
8
9
10

std::string s;
int num;
n.getParam("string_param", s);
pn.getParam("int_param", num);
n.setParam("string_param", "hehe");
pn.setParam("int_param", 222);


n.param<std::string>("string_param", s, "haha");
pn.param<int>("int_param", num, 666)

getParam()函数可以从参数服务器获取参数值。如果成功，变量s和num的值将会被修改为参数值，函数返回true；如果不成功（譬如参数服务器没有设置这个参数），变量s和num将保持原值，函数会返回false。setParam()就是设置参数的值了。param()函数从参数服务器取参数值给变量。如果无法获取，则将默认值赋给变量，和param()函数的区别是还提供了一个默认值。

还有ros::NodeHandle::hasParam()和ros::NodeHandle::deleteParam()函数，后者可以在析构函数中使用。

如果在yaml文件中定义如下

1
2
3

waypoints:
  X: [38, 38, 38, 38, 38, 38, 38 , 38.21, 39.25, 42.56, 48.97, 61]
  Y: [-57, -45, -32.0, -18.5, -12.0, 0.0, 12, 35, 42.89, 80.41, 131.48, 139.47]

1
2

vector<double> X;
nh.getParam("/frenet_planner/waypoints/X", X);

注意

使用yaml文件时，一定要注意格式的正确，但是最好不要用-符号，也就是不要用数组项，否则可能出问题，之前尝试使用一个第三方库读取yaml文件时，总是读取失败，发现只有加上-符号，也就是将参数作为数组项后才能正常读取。但再用rosparam get读取这个文件中的参数就会出错，结果获得的全是默认值，不是当前值。用rosparam list会发现加载的参数不全，原因是yaml文件中这样编辑:

1
2
3
4

TrajectoryPlannerROS:
  -name: value
  int_param: 2
  max_vel_x: 0.15

参考:Using Parameters in roscpp

YAML最基本，最常用的一些使用格式：
首先YAML中允许表示三种格式，分别是常量值，对象和数组

1
2
3
4
5
6
7
8
9
10
11
12
13

url: http://www.wolfcode.cn 

server:
    host: http://www.wolfcode.cn 

server:
    - 120.168.117.21
    - 120.168.117.22
    - 120.168.117.23
#常量
pi: 3.14   #定义一个数值3.14
hasChild: true  #定义一个boolean值
name: 'Hello YAML'   #定义一个字符串

yaml-cpp 读 yaml

ROS默认的yaml-cpp版本一般在0.5以上，CMakeLists如下配置

1
2
3
4
5
6
7
8
9
10

include_directories(
  /usr/include
  ${catkin_INCLUDE_DIRS}
)

add_executable(${PROJECT_NAME}  src/test_yaml.cpp)
target_link_libraries(${PROJECT_NAME}
   ${catkin_LIBRARIES}
   yaml-cpp  # 这里必须有
)

从map_server中学习一段代码:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

#include <ros/ros.h>
#include "yaml-cpp/yaml.h"
#include <iostream>
#include <fstream>
#include <string>

// 必须自定义，不明白为什么网上的资料都没有提到
template<typename T> void operator >> (const YAML::Node& node, T& i )
{
    i = node.as<T>();
}

int main(int argc, char** argv)
{
    ros::init(argc, argv, "test_yaml" );
    ros::NodeHandle nh;

    std::string file = "/home/user/map.yaml";
    std::ifstream fin(file.c_str());
    if (fin.fail() )
    {
      ROS_ERROR("could not open %s.", file.c_str());
      return false;
    }
    // 适用于 0.5 以上版本
    YAML::Node doc = YAML::Load(fin);
    try {
        double res, negate;
        std::string image;
        doc["resolution"] >> res;
        doc["image"] >> image;

        ROS_INFO("res: %f", res );
        ROS_INFO("negate: %f", negate);
        ROS_INFO("image: %s", image.c_str() );
    }
    catch (YAML::InvalidScalar &e) {
      ROS_ERROR("The map yaml file error, reason: %s.", e.what());
      return false;
    }
}

Python 读 Yaml

读YAML的最好方法是使用Python的yaml库PyYAML，到官网下载安装后，可以先运行测试程序看是否成功。
读取程序如下：

1
2
3
4
5
6

import yaml,os

f = open("test.yaml")
y = yaml.load(f,Loader=yaml.FullLoader)

print y

创建package后，package.xml不需要再修改

创建package命令是catkin_create_pkg nodeName

package名称

package的名称对应CMakeLists中的project(package)和package.xml中的<name>package</name>

package的命名是有官方规范的，我意外地发现test这个名字往往会带来问题，可能是因为带test的package都是用于测试的，所以要避免使用。基本规则如下:

1. 只能使用字母数字下划线
2. 字母只能用小写，开头必须是字母
3. 至少有两个字符长度
4. 只做消息的package以_msg结尾，只含launch的以_launch结尾，以此类推

不要轻易用msg, launch, test这样的字符串做名称，容易出问题。如果命名不规范，编译时会告警，影响编译时间。查看官方package列表，发现除了tf这样一个单词做名称的例子外，其他基本都是a_b或a_b_c这样的名称，例如tuw_geometry_rviz，所以这样命名比较稳妥。

package.xml

每个package.xml文件必须包含的标签包括：

• <package> : 最高级tag，属性：format，用于指定格式
• <name> ：package名称
• <version> ：当前版本
• <description>：package的基本描述
• <maintainer>(至少一个)：维护者
• <license>(至少一个)：协议
• <buildtool_depend>(至少一个): 一般情况下只需要指定catkin作为编译工具， 在需要交叉编译的情况下需要增加目标机器的编译工具

可选标签包括：

• <build_depend> (多个)：编译时需要依赖的其它package，适用于静态库
• <exec_depend> (多个)：运行时需要依赖的其它package，适用于静态库
• build_export_depend: 编译时需要链接(build against)的package
• <export>：用于添加额外的信息，比如需要嵌入的其它package的插件，或者一些说明信息。
  

使用depend可以表示同时包括build和exec依赖，也就是说<depend>roscpp</depend>相当于

1
2

<build_depend>roscpp</build_depend>
<exec_depend>roscpp</exec_depend>

一般都包括的几个是

1
2
3
4
5
6

<buildtool_depend>catkin</buildtool_depend>
<build_depend>message_generation</build_depend>
<exec_depend>message_runtime</exec_depend>
<!-- 可能还有其他msgs类型 -->
<depend>std_msgs</depend>
<build_export_depend>std_msgs</build_export_depend>  

几个重要路径

4个ROS的重要路径，可在CMakeLists中用message函数查看：

• CATKIN_PACKAGE_LIB_DESTINATION： lib库的路径

• CATKIN_PACKAGE_BIN_DESTINATION： 可执行文件的路径

• CATKIN_PACKAGE_SHARE_DESTINATION：共享文件的路径，就是CMakeLists中的INSTALL生成的两个cmake文件的路径

• catkin_INCLUDE_DIRS： 跟catkin有关文件的路径，不仅仅是ROS相关的

在代码中包含另一个package的头文件时，经常写成#include<robot_api/robot_api.h>，注意程序目录结构必须是这样：

多工作空间的问题

如果在/opt/ros/kinetic/之外，如果我们创建了多个工作空间且需要在多个工作空间中来回地工作，比如/home/user/catkin_ws1 和 /home/user/catkin_ws2

ROS_PACKAGE_PATH环境变量中的多个目录是有先后顺序的。如果工作空间1和2中的所有包之间没有依赖关系，那么将下面两句话放在bashrc文件中合适的位置（至少应该放在source /opt/ros/kinetic/setup.*sh后）。

1
2

source /home/user/catkin_ws1/devel/setup.*sh --extended
source /home/user/catkin_ws2/devel/setup.*sh --extended

环境变量中这样设置：

1
2

source /opt/ros/kinetic/setup.zsh
source /home/xiaoqiang/catkin_ws/devel/setup.zsh

source工作空间的顺序会影响链接的so文件

先source devel/setup.bash，再source /opt/ros/melodic/setup.bash，没有source install/setup.bash

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# libmove_base.so 所链接的 libcostmap_2d.so 是deve/lib里的
user@user:~/catkin_ws/install/lib$ ldd libmove_base.so | grep user
  libcostmap_2d.so => /home/user/my_ws/devel/lib/libcostmap_2d.so (0x00007f1d87062000)

user@user:~/catkin_ws/install/lib$ locate libcostmap_2d
# 有5个 libcostmap_2d.so
/home/user/catkin_ws/devel/lib/libcostmap_2d.so
/home/user/catkin_ws/install/lib/libcostmap_2d.so

/home/user/my_ws/devel/lib/libcostmap_2d.so
/home/user/my_ws/install/lib/libcostmap_2d.so

/opt/ros/melodic/lib/libcostmap_2d.so
# 删除 devel/lib/libcostmap_2d.so
user@user:~/catkin_ws/install/lib$ rm /home/user/my_ws/devel/lib/libcostmap_2d.so
# 此时就会链接到 ros 自带的 libcostmap_2d.so
# 如果ros自带的也被删除，就会链接失败，不去链接其他的 libcostmap_2d.so
user@user:~/catkin_ws/install/lib$ ldd libmove_base.so | grep cost
  libcostmap_2d.so => /opt/ros/melodic/lib/libcostmap_2d.so (0x00007f15a177a000)

编译时寻找其他工作空间的包

很奇怪，我编译的工作空间已经有voxel_grid，结果会去另一个工作空间找同名的包，但那个包已经被我删了，所以找不到，结果报错。

看catkin_make开头的信息，发现这里就涉及到了xju_ws这个包了

发现build文件夹里的几个文件涉及了xju_ws，但是如果删除再编译，还是会生成一模一样的文件。

最后只有重建一个工作空间，执行catkin_init_workspace，再编译，问题解决。

必须有设置的环境变量

• ROS_ROOT

这个是ROS核心包安装路径，也就是/opt/ros/kinetic/share/ros，不须自己设置

• ROS_PACKAGE_PATH

所有ros package所在位置，一般为/home/name/catkin_ws_test/src:/opt/ros/kinetic/share

这几个环境变量一般不需要显式地添加，而是通过运行source /opt/ros/kinetic/setup.bash和source %个人工作空间目录%/devel/setup.bash来进行设置。一般需要将上面这两行命令添加到系统的~/.bashrc文件中，来避免每次开启终端时都要重新手动执行设置命令。

• ROS_MASTER_URI

这个表示主机的IP信息，比如http://192.168.134.123:11311。这个必须要手动设置

• ROS_IP/ROS_HOSTNAME

ROS主从多机协作时使用，用来设置设置不同机器上ROS的网络地址。这个必须要手动设置

执行env | grep ROS会得到如下结果，有些环境变量不设置也会有默认值

1
2
3
4
5
6
7
8
9
10
11

ROSCONSOLE_FORMAT=[${message}
ROS_ETC_DIR=/opt/ros/melodic/etc/ros
ROS_ROOT=/opt/ros/melodic/share/ros
ROS_MASTER_URI=http://192.168.8.177:11311/
ROS_VERSION=1
ROS_PYTHON_VERSION=2
ROS_IP=192.168.8.177
ROS_PACKAGE_PATH=/home/user/test_nodes/src:/home/user/catkin_ws/src:/opt/ros/melodic/share
ROSLISP_PACKAGE_DIRECTORIES=/home/user/test_nodes/devel/share/common-lisp:/home/user/catkin_ws/devel/share/common-lisp
ROS_HOSTNAME=192.168.8.177
ROS_DISTRO=melodic

可选的环境变量

• ROS_VERSION, 比如 1

• ROS_DISTRO, 比如 noetic

• ROS_ETC_DIR

比如 /opt/ros/noetic/etc/ros

• ROS_HOME

ROS默认的home路径是~/.ros，默认情况下该目录下保存log文件和test的结果文件。通过修改这个环境变量可以改变上面两个文件的保存路径。

• ROS_LOG_DIR

该变量指向ros输出的log文件保存的目录。该变量为空时，log文件默认保存在ROS_HOME指向的目录中；设置该变量后，输出的log文件保存在ROS_LOG_DIR指向的目录中，做日志工具时很有用。一般在~/.bashrc文件中设置该变量。

• ROSCONSOLE_CONFIG_FILE

默认情况下，c++接口使用的log配置文件路径为$ROS_ROOT/config/rosconsole.config, 通过设置该变量可以配置c++接口的log信息的输出级别。

• ROSCONSOLE_FORMAT

修改log输出的格式，默认情况下的输出格式 export ROSCONSOLE_FORMAT= [${severity}] [${time}]: ${message}

• ROS_BOOST_ROOT

这个不用研究。 设置搜索boost库的地址，如果没有设置，那么默认使用ROS_BINDEPS_PATH

• ROS_PARALLEL_JOBS

这个和cmake 的-j8是类似的。

export ROS_PARALLEL_JOBS='-j8 -l8'
-j flag with an argument to run up to 8 jobs in parallel, independent of system load:

export ROS_PARALLEL_JOBS=-j8

using the -l flag to set a system load-dependent limit on parallelism. Excessive parallelism in a large build can exhaust system memory.

在ros中，我们有时需要一次性启动多个节点，这种情况下再用rosrun就力不从心了，于是出现了roslaunch命令和launch文件,launch文件使用XML语法launch文件使用XML语法。roslaunch不保证节点开始的顺序。因为没有办法从外部知道节点何时被完全初始化，所以所有被启动的节点必须是robust，以便以任何顺序启动。

node

node的形式为：

1

<node name="node-name" pkg="pkg-name" type="executable-name" output="screen" />

不要把pkg写成 pkg="$(find package)"，可能会报错：

1
2

ERROR: cannot launch node of type [path_to_file] package_path
ROS path [0]=/opt/ros/...

name属性给节点指派了名称，它将覆盖任何通过调用ros::init来赋予节点的名称。另外node标签内也可以用过arg设置节点参数值。如果node标签有children标签，就需要显式标签来定义。即末尾为/node>

当roslaunch开启所有nodes后,roslaunch会监视每个node,记录那些仍然活动的nodes。对于每个node,当其终止后,我们可以要求roslaunch重启该node,通过使用respawn属性。通过使用respawn属性: respawn="true"

respawn_delay="10"会让节点终止后，隔一段时间重新运行，和respawn="true"同时使用，单位秒

多个同样的节点有不同的topic

在launch文件中使用node_1和node_2，它们的type是一样的，但是还发布了话题。这样启动launch就会出现两个节点同一个话题的情况，这不是我们想要的。 此时要在代码中对NodeHandle的构造函数加~，这时param也加上了节点名做前缀，可能还要在launch中用remap修改话题名。

param

param是ROS系统运行中的参数，存储在参数服务器中。在launch文件中通过元素加载参数；launch文件执行后，参数就加载到ROS的参数服务器上了。每个活跃的节点都可以通过 ros::param::get()或getParam接口来获取parameter的值，用户也可以在终端中通过rosparam命令或获得参数的值。

<param>的使用方法如下：

1

<param name="frame" type="string" value="odom"/>    <!-- type可以没有 -->

1
2

string f;
nh.getParam("frame",f)

argument

argument是另外一个概念，类似于launch文件内部的局部变量，仅限于launch文件使用，和ROS节点内部的实现没有关系。argument只在启动文件内才有意义,不能被节点直接获取的

设置argument使用标签元素，语法如下：

1
2

<arg name="arg-name" default="arg-value" />
<arg name="arg-name" default="arg-unchanged-value" />

launch文件中需要使用到argument时，可以使用如下方式调用：

1
2
3

<arg name="arg-name" default="arg-value" />
<param name = "foo" value="$(arg arg-name)" />
<node name="node" pkg="package" type="type "args="$(arg arg-name)" />

1
2
3
4
5

int main(int argc, char **argv)
{
  ros::init(argc, argv, "map_server", ros::init_options::AnonymousName);
  std::string s(argv[1]);   // launch文件中的arg赋值给了s
}

虽然在launch文件中规定了参数的值，但我们在终端使用roslaunch命令时，还可以修改这个值，但前提是arg的赋值是用default，不是用value，命令如下:

1

roslaunch package-name launch-file-name arg-name:=arg-value

1
2

<param name="path1" value="$(env PATH1)"  />
<param name="path2" value="$(env PATH2)"  />

1
2
3

<param name="circumference" value="$(eval 2.* 3.1415 * arg('radius'))"/>
<!-- 当前launch所在的路径 -->
<arg name="abspath" value="$(eval eval('_' + '_import_' + '_(\'os\').path.abspath(\'.\')') )" />

1
2
3
4
5
6
7

<arg name="driver_enable" default=”true”/>

<group if="$(arg driver_enable)">

<include file= "$(find openni2_launch)/launch/openni2.launch"/>

</group>

1

roslaunch [pkg] [node] driver_enable:=false

1

<include file="$(find package)/launch/amcl.launch"/>