ROS2系列教程：package结构（CMake与Python两种包）

1
<?xml version="1.0"?>
2
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
3
<package format="3">
4
  <!-- 基本信息 -->
5
  <name>my_pkg</name>
6
  <version>0.1.0</version>
7
  <description>一个示例包</description>
8
  <maintainer email="you@example.com">Your Name</maintainer>
9
  <license>Apache-2.0</license>
10

11
  <!-- 依赖声明（五种） -->
12
  <buildtool_depend>ament_cmake</buildtool_depend>     <!-- 构建工具 -->
13
  <depend>rclcpp</depend>                              <!-- 构建+运行时依赖 -->
14
  <build_depend>sensor_msgs</build_depend>             <!-- 仅构建时依赖 -->
15
  <exec_depend>launch_ros</exec_depend>               <!-- 仅运行时依赖 -->
16
  <test_depend>ament_lint_auto</test_depend>          <!-- 测试依赖 -->
17

18
  <!-- 导出（可省略） -->
19
  <export>
20
    <build_type>ament_cmake</build_type>
21
  </export>
22
</package>

1
<package format="3">

1
<export>
2
  <build_type>ament_cmake</build_type>
3
  <member_of_group>rosidl_interface_packages</member_of_group>
4
</export>

1
py_pkg/
2
├── package.xml            # 包清单（build_type = ament_python）
3
├── setup.py               # 构建配置（核心）
4
├── setup.cfg              # 安装路径配置
5
├── resource/
6
│   └── py_pkg             # ament 索引标记（内容可空）
7
├── test/
8
│   ├── test_copyright.py
9
│   ├── test_flake8.py
10
│   └── test_pep257.py
11
└── py_pkg/                # Python 源码目录（与包同名）
12
    ├── __init__.py
13
    └── my_node.py         # 节点实现

1
from setuptools import setup
2
from glob import glob
3
import os
4

5
package_name = 'py_pkg'
6

7
setup(
8
    name=package_name,                                  # 包名，必须与目录同名
9
    version='0.0.0',                                    # 版本号
10
    packages=[package_name],                            # Python 包列表（源码目录）
11
    data_files=[                                        # 数据/资源文件安装位置
12
        ('share/ament_index/resource_index/packages',
13
            ['resource/' + package_name]),              # ament 索引（必须）
14
        ('share/' + package_name, ['package.xml']),     # 包清单（必须）
15
        (os.path.join('share', package_name, 'launch'), # launch 文件（可选）
16
            glob('launch/*.launch.py')),
17
        (os.path.join('share', package_name, 'config'), # 配置文件（可选）
18
            glob('config/*.yaml')),
19
    ],
20
    install_requires=['setuptools'],
21
    zip_safe=True,
22
    maintainer='your_name',
23
    maintainer_email='you@example.com',
24
    description='Python 示例包',
25
    license='Apache-2.0',
26
    entry_points={
27
        'console_scripts': [
28
            'my_node = py_pkg.my_node:main',            # 命令名 = 模块:函数
29
        ],
30
    },
31
)

1
[develop]
2
script_dir=$base/lib/py_pkg
3
[install]
4
install_scripts=$base/lib/py_pkg

1
cpp_pkg/
2
├── package.xml            # 包清单（build_type = ament_cmake）
3
├── CMakeLists.txt         # 构建规则（核心）
4
├── include/cpp_pkg/       # 公共头文件（按约定与包同名）
5
│   └── my_node.hpp
6
├── src/
7
│   ├── my_node.cpp        # 节点实现
8
│   └── main.cpp           # 入口
9
├── launch/                # launch 文件（需在 CMakeLists 安装）
10
├── config/                # 配置文件
11
└── msg/ srv/ action/      # 接口定义目录（本包定义接口时）

1
cmake_minimum_required(VERSION 3.8)
2
project(cpp_pkg)                    # 项目名 = 包名
3

4
if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
5
  add_compile_options(-Wall -Wextra -Wpedantic)
6
endif()
7

8
# 找依赖：用到几个找几个，保持最小化
9
find_package(ament_cmake REQUIRED)
10
find_package(rclcpp REQUIRED)
11
find_package(std_msgs REQUIRED)     # 用到标准消息时
12

13
# 生成库（可选，模块化时用）
14
add_library(cpp_pkg_core
15
  src/my_node.cpp
16
)
17
target_include_directories(cpp_pkg_core PUBLIC
18
  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
19
  $<INSTALL_INTERFACE:include>)
20
ament_target_dependencies(cpp_pkg_core rclcpp std_msgs)
21

22
# 生成可执行文件
23
add_executable(my_node src/main.cpp)
24
target_link_libraries(my_node cpp_pkg_core)   # 链接自己的库
25
ament_target_dependencies(my_node rclcpp std_msgs)
26

27
# 安装：可执行文件、头文件、launch、config（缺一不可）
28
install(TARGETS my_node cpp_pkg_core
29
  EXPORT export_${PROJECT_NAME}
30
  ARCHIVE DESTINATION lib
31
  LIBRARY DESTINATION lib
32
  RUNTIME DESTINATION lib/${PROJECT_NAME}
33
)
34
install(DIRECTORY include/ DESTINATION include)
35
install(DIRECTORY launch DESTINATION share/${PROJECT_NAME})
36
install(DIRECTORY config DESTINATION share/${PROJECT_NAME})
37

38
ament_package()

1
# msg/RobotStatus.msg —— 自定义消息
2
string robot_name          # 字符串字段
3
float32 battery_level      # 浮点字段（0.0 ~ 1.0）
4
int32 status_code          # 整数状态码
5
builtin_interfaces/Time stamp   # 嵌套内置类型

1
# 请求部分
2
float64 target_speed
3
bool   is_emergency_stop
4

5
---
6
# 响应部分
7
bool     success
8
string   message

1
find_package(rosidl_default_generators REQUIRED)
2
find_package(builtin_interfaces REQUIRED)
3

4
# 声明接口文件（msg 与 srv 分开列）
5
set(msg_files
6
  "msg/RobotStatus.msg"
7
)
8
set(srv_files
9
  "srv/SetSpeed.srv"
10
)
11

12
# 生成接口（核心命令）
13
rosidl_generate_interfaces(${PROJECT_NAME}
14
  ${msg_files}
15
  ${srv_files}
16
  DEPENDENCIES builtin_interfaces
17
)
18

19
# 接口包不需要普通可执行文件，直接 ament_package
20
ament_package()

1
<depend>rosidl_default_generators</depend>
2
<depend>builtin_interfaces</depend>
3
<member_of_group>rosidl_interface_packages</member_of_group>

1
#include "my_interfaces/msg/robot_status.hpp"
2
#include "my_interfaces/srv/set_speed.hpp"
3

4
// 使用消息
5
my_interfaces::msg::RobotStatus status;
6
status.robot_name = "turtlebot";
7
status.battery_level = 0.85f;

1
from my_interfaces.msg import RobotStatus
2
from my_interfaces.srv import SetSpeed
3

4
status = RobotStatus()
5
status.robot_name = "turtlebot"
6
status.battery_level = 0.85