创建 ROS2 功能包

使用 CMake 或 Python 创建一个新程序包，然后运行其可执行文件。

1 What is a ROS 2 package?¶

可以将包视为 ROS 2 代码的容器。如果您希望能够安装代码或与他人共享代码，则需要将其组织在一个软件包中。使用软件包，您可以发布 ROS2 的工作，并允许其他人轻松构建和使用它。

ROS2 中的软件包创建使用 ament 作为其构建系统，并使用 colcon 作为其构建工具。您可以使用官方支持的 CMake 或 Python 创建软件包，尽管确实存在其他构建类型。

2 What makes up a ROS 2 package?¶

ROS 2 Python 和 CMake 软件包各自具有自己的最低要求内容：

1. CMake：

• package.xml 文件，其中包含有关程序包的元信息
• CMakeLists.txt 文件，描述如何在包中构建代码

2. Python：

• package.xml 文件，其中包含有关程序包的元信息
• setup.py 包含有关如何安装软件包的说明
• 软件包包含可执行文件时，需要 setup.cfg，以便 ros2 run 可以找到它们
• /：ROS 2 工具用来查找软件包的与软件包同名的目录包含__init__.py

最简单的包可能具有如下文件结构：

1. CMake：

my_package/
     CMakeLists.txt
     package.xml

2. Python：

my_package/
      setup.py
      package.xml
      resource/my_package

3 Packages in a workspace¶

一个工作空间可以包含所需数量的程序包，每个程序包都位于其自己的文件夹中。您还可以在一个工作空间（CMake，Python等）中拥有不同构建类型的软件包。您不能有嵌套的程序包。

最佳做法是在工作区中有一个 src 文件夹，并在其中创建包。这样可以使工作空间的顶层保持“干净”。

典型的一个工作空间内功能包的结构如下：

workspace_folder/
    src/
      package_1/
          CMakeLists.txt
          package.xml

      package_2/
          setup.py
          package.xml
          resource/package_2
      ...
      package_n/
          CMakeLists.txt
          package.xml

3.1 Create a package¶

首先，source 您的 ROS 2 installation。

创建的工作空间 dev_ws 用于新软件包，运行软件包创建命令之前，请确保您位于 src 文件夹中。

在 ROS 2 中创建新程序包的命令语法为：

1. CMake：

$ ros2 pkg create --build-type ament_cmake 

2. Python：

$ ros2 pkg create --build-type ament_python 

接下来将使用可选参数 --node-name，该参数在包中创建一个简单的 Hello World 类型的可执行文件。

在终端中输入以下命令：

$ mkdir -p dev_ws/src
$ cd dev_ws/src

• Python：

$ ros2 pkg create --build-type ament_python --node-name my_node my_package_py

• CMake：

$ ros2 pkg create --build-type ament_cmake --node-name my_node my_package_cpp

现在，您将在工作区的 src 目录中拥有一个名为 my_package_py 与 my_package_cpp 的新文件夹。运行命令后，您的终端将返回以下消息：

• CMake：

going to create a new package
package name: my_package
destination directory: /home/user/dev_ws/src
package format: 3
version: 0.0.0
description: TODO: Package description
maintainer: [' ']
licenses: ['TODO: License declaration']
build type: ament_cmake
dependencies: []
node_name: my_node
creating folder ./my_package
creating ./my_package/package.xml
creating source and include folder
creating folder ./my_package/src
creating folder ./my_package/include/my_package
creating ./my_package/CMakeLists.txt
creating ./my_package/src/my_node.cpp

• Python：

going to create a new package
package name: my_package
destination directory: /home/user/dev_ws/src
package format: 3
version: 0.0.0
description: TODO: Package description
maintainer: [' ']
licenses: ['TODO: License declaration']
build type: ament_python
dependencies: []
node_name: my_node
creating folder ./my_package
creating ./my_package/package.xml
creating source folder
creating folder ./my_package/my_package
creating ./my_package/setup.py
creating ./my_package/setup.cfg
creating folder ./my_package/resource
creating ./my_package/resource/my_package
creating ./my_package/my_package/__init__.py
creating folder ./my_package/test
creating ./my_package/test/test_copyright.py
creating ./my_package/test/test_flake8.py
creating ./my_package/test/test_pep257.py
creating ./my_package/my_package/my_node.py

您可以看到为新软件包自动生成的文件。

3.2 Build a package¶

将软件包放在工作空间中特别有价值，因为您可以通过在工作空间根目录中运行 colcon build 一次构建许多软件包。否则，您将必须分别构建每个软件包。

返回工作区的根目录，现在您可以构建软件包：

$ cd ..
$ colcon build

这个命令会编译工作空间中的所有功能包，如果只想编译某一个包的话，可以这样：

$ colcon build --packages-select my_package

3.3 Source the setup file¶

要使用新的程序包和可执行文件，请先打开一个新终端，然后获取 ROS2 的主要安装源。然后，从 dev_ws 目录中，运行以下命令来获取您的工作空间：

# Linux
$ . install/setup.bash
# Windows
$ call install/local_setup.bat

现在您的工作区已添加到路径中，您将可以使用新程序包的可执行文件。

3.4 Use the package¶

要在软件包创建期间运行使用--node-name参数创建的可执行文件，请输入以下命令：

$ ros2 run my_package_py my_node

3.5 Examine package contents¶

不管你是用 CMake 还是 python 创建的包，打开看一下，里边有哪些默认的文件：

3.6 Customize package.xml¶

创建软件包后，package.xml 文件需要我们手动完善一下。您可能在返回消息中注意到字段 description 和 license 包含 TODO 注释。这是因为软件包 description 和 license 声明不会自动设置，但是如果您要释放软件包，则必须设置。maintainer 字段可能也需要填写。

完善以上描述信息、许可证和作者邮箱，关于许可证的详细介绍可以参考 here。

由于此软件包仅供练习，因此可以安全使用任何许可证。我们使用 Apache License 2.0：

Apache License 2.0

在许可证标签下方，您会看到一些标签名称以 _depend 结尾。这是您的 package.xml 列出其对其他软件包的依赖关系的地方，供 colcon 搜索。my_package_* 很简单，没有任何依赖关系，但是您将在以后的教程中看到这个空间的使用。

如果使用的是 Python 包，还需要多修改一个文件 setup.py。setup.py 文件包含与 package.xml 相同的description，license和 maintainer，因此您也需要进行设置。它们需要在两个文件中完全匹配。版本和名称（package_name）也需要完全匹配，并且应在两个文件中自动填充。

4 总结

您已经创建了一个用于组织代码并易于他人使用的程序包。您的软件包将自动填充必要的文件，然后使用 colcon 进行构建，以便可以在本地环境中使用其可执行文件。