ROS2 常用指令 - 须臾自省

1208 字

6 分钟

ROS2 常用指令

2025-02-16

工具

项目构建#

1
cd ~/ros2_learning
2
colcon build --symlink-install
3
source install/setup.sh

ROS2 常用指令#

节点#

ros2 run node 运行对应功能节点

ros2 run turtlesim turtlesim_node ros2 run turtlesim turtle_teleop_key

ros2 node list 查看所有正在运行的节点
ros2 node info /node 查看正在运行节点的详细信息

话题#

ros2 topic list 查看所有已发布的话题
ros2 topic echo /node/topic 打印话题发布的信息
ros2 topic pub /node/topic msg "detail_info" 针对话题发布指令

其他#

查询所有可用接口

1
ros2 interface list

查询接口的详细信息

1
ros2 interface show sensor_msgs/msg/Image

查询所有服务

1
ros2 service list

调用服务

1
ros2 service call service_name service_type "values"
2
# ros2 service call /add_two_ints learning_interface/srv/AddTwoInts "a: 5, b: 10"

ros2 action
ros2 bag record 录制数据
ros2 bag paly 播放录制的数据
ros2 action send_goal /node/action act "detail_info" 发送动作
colcon build --symlink-install --packages-select package_name

ROS2 环境配置#

ROS2 一键安装：

1
wget http://fishros.com/install -O fishros && . fishros

ROS2 手动安装：

基本上参考官方手册就能完成配置，唯一需要注意的是拉取 ROS2 仓库时，需要为 raw.githubusercontent.com 的修改 host，可能报错：

1
ERROR: cannot download default sources list from: 20-default.list. Website may be down.

hosts 配置：

1
185.199.108.133 raw.githubusercontent.com
2
185.199.109.133 raw.githubusercontent.com
3
185.199.110.133 raw.githubusercontent.com
4
185.199.111.133 raw.githubusercontent.com
5
20.205.243.166 github.com

ROS2 基础#

创建&编译工作空间#

准备环境和相关工具

1
sudo apt update
2
sudo apt install -y python-is-python3
3
sudo apt install -y python3-pip
4
sudo apt install python3-colcon-common-extensions

创建工作空间

1
# ~/
2
mkdir -p ros2_learning/src
3
cd  ros2_learning

编译工作空间

1
git clone https://github.com/ros2/examples src/examples -b foxy
2
colcon build --symlink-install # colcon build
3
# 测试构建完成的包
4
colcon test
5
# 配置环境
6
source install/local_setup.sh
7
# 开启订阅者的测试节点
8
ros2 run examples_rclcpp_minimal_subscriber subscriber_member_function
9
# 开启发布者的测试节点
10
ros2 run examples_rclcpp_minimal_publisher publisher_member_function

colcon build：通常用于生产环境或发布阶段，它将会把构建的文件复制到安装目录中，确保安装后的文件是稳定的，不会因为源代码的修改而改变。
colcon build --symlink-install：在开发过程中更常用，因为它使用符号链接指向源代码目录，而不是复制文件。

创建包#

在工作空间中创建功能包：

1
ros2 pkg create --build-type ament_cmake cpp_package
2
ros2 pkg create --build-type ament_python py_package

创建包时，创建测试节点：

1
ros2 pkg create --build-type ament_cmake --node-name my_node my_package

--node-name 设置节点名称

1
.
2
├── [4.0K]  cpp_learning_node
3
│   ├── [1.2K]  CMakeLists.txt
4
│   ├── [4.0K]  include
5
│   ├── [ 601]  package.xml
6
│   └── [4.0K]  src
7
└── [4.0K]  py_learning_node
8
    ├── [ 630]  package.xml
9
    ├── [4.0K]  py_learning_node
10
    │   └── [   0]  __init__.py
11
    ├── [4.0K]  resource
12
    │   └── [   0]  py_learning_node
13
    ├── [ 101]  setup.cfg
14
    ├── [ 691]  setup.py
15
    └── [4.0K]  test

创建节点 Python#

在 py_learning_node/py_learning_node 中创建代码文件 node_helloworld.py
测试代码

1
import rclpy
2
from rclpy.node import Node
3
import time
4

5
def main(args=None):
6
    rclpy.init(args=args)
7
    node = Node("node_helloworld")
8

9
    while rclpy.ok():
10
        node.get_logger().info("Hello World")
11
        time.sleep(0.5)
12

13
    node.destroy_node()
14
    rclpy.shutdown()

或者自定义一个节点类：

1
import rclpy
2
from rclpy.node import Node
3
import time
4

5
class HelloWorldNode(Node):
6
    def __init__(self, name):
7
        super().__init__(name)
8
        while rclpy.ok():
9
            self.get_logger().info("Hello World")
10
            time.sleep(0.5)
11

12
def main(args=None):
13
    rclpy.init(args=args)
14
    node = HelloWorldNode("node_helloworld_class")
15
    node.destroy_node()
16
    rclpy.shutdown()

在包配置文件 setup.py 中添加节点信息

1
from setuptools import setup
2

3
package_name = 'py_learning_node'
4

5
setup(
6
    ....
7
    entry_points={
8
        'console_scripts': [
9
            'node_helloworld = py_learning_node.node_helloworld:main',
10
            'node_helloworld_class = py_learning_node.node_helloworld_class:main',
11
        ],
12
    },
13
)

退回到工作空间 ~/ros2_learning，构建包

1
colcon build --symlink-install
2
source install/setup.sh

创建节点 C++#

基础的参考上文

测试代码：

1
#include "rclcpp/rclcpp.hpp"
2

3
int main(int argc, char * argv[])
4
{
5
    rclcpp::init(argc, argv);
6
    auto node = std::make_shared<rclcpp::Node>("node_helloworld");
7
    RCLCPP_INFO(node->get_logger(), "Hello World");
8
    rclcpp::spin(node);
9
    rclcpp::shutdown();
10
    return 0;
11
}

重点在于 CMakeLists.txt

1
# 添加 rclcpp 包
2
find_package(rclcpp REQUIRED)
3

4
# 添加节点的关联代码和依赖
5
add_executable(node_helloworld src/node_helloworld.cpp)
6
ament_target_dependencies(node_helloworld rclcpp)
7

8
# 将编译完成的 node 安装到指定路径
9
install(TARGETS
10
  node_helloworld
11
  DESTINATION lib/${PROJECT_NAME}
12
)

接口 interface#

1
ros2 pkg create --build-type ament_cmake learning_interface

消息 message#

1
float64 radius              # 基础消息
2
geometry_msgs/Point center  # 引用其他包里的消息

其他的基础消息可通过以下指令查看：

1
ros2 interface show std_msgs/msg/

服务 service#

1
int64 a     # 请求
2
int64 b
3
int64 c
4
---
5
int64 sum   # 结果

动作 action#

参考 Understanding actions

1
float32 theta       # 动作接收端的目标
2
---
3
float32 delta       # 动作接收端在完成动作后的结果反馈
4
---
5
float32 remaining   # 动作接收端在执行动作中的实时反馈

CMakeLists.txt#

1
find_package(geometry_msgs REQUIRED)                # 消息中引入了其他包的消息
2
find_package(rosidl_default_generators REQUIRED)    # 定义接口必须导入的包
3

4
rosidl_generate_interfaces(${PROJECT_NAME}
5
  "msg/Num.msg"
6
  "msg/Sphere.msg"
7
  "srv/AddThreeInts.srv"
8
  "action/MoveCircle.action"
9
  DEPENDENCIES geometry_msgs # Add packages that above messages depend on, in this case geometry_msgs for Sphere.msg
10
)

package.xml#

1
<depend>geometry_msgs</depend>
2
<buildtool_depend>rosidl_default_generators</buildtool_depend>
3
<exec_depend>rosidl_default_runtime</exec_depend>
4
<member_of_group>rosidl_interface_packages</member_of_group>

由于接口依赖于 rosidl_default_generators 生成特定语言的代码，因此需要声明对它的构建工具依赖关系。
rosidl_default_runtime 是运行时或执行阶段依赖项，需要稍后才能使用接口。
rosidl_interface_packages 是您的包应与之关联的依赖项组的名称 tutorial_interfaces，使用标记声明。

参数 Parameter#

1
ros2 pkg create --build-type ament_python learning_parameter_py --dependencies rclpy
2
ros2 pkg create --build-type ament_cmake learning_parameter_cpp --dependencies rclcpp

声明参数：

1
key = '变量名称'
2
value = '变量值'
3
self.declare_parameter(key, value)

获取参数：

1
param = self.get_parameter('robot_name').get_parameter_value().string_value
2
# rcl_interfaces.msg.ParameterValue(
3
#   type=4,  类型从1开始计数，4表示第4个元素，string_value
4
#   bool_value=False,
5
#   integer_value=0,
6
#   double_value=0.0,
7
#   string_value='mbot',
8
#   byte_array_value=[],
9
#   bool_array_value=[],
10
#   integer_array_value=[],
11
#   double_array_value=[],
12
#   string_array_value=[])

更新参数：

1
new_name_param = rclpy.parameter.Parameter('robot_name', rclpy.Parameter.Type.STRING, 'mbot')
2
new_count_param = rclpy.parameter.Parameter('count', rclpy.Parameter.Type.INTEGER, count_param)
3
all_new_parameters = [new_name_param, new_count_param]
4
self.set_parameters(all_new_parameters)