ROS2学习之旅(13)——创建ROS2 功能包
一个功能包可以被认为是ROS2代码的容器。如果希望能够管理代码或与他人共享代码,那么需要将其组织在一个包中。通过包,可以发布ROS2工作,并允许其他人轻松地构建和使用它。
在ROS2中,创建功能包使用ament作为其构建系统,colcon作为其编译工具。可以使用CMake或Python来创建包,都是官方支持的,不过也存在其他构建类型,本文仅针对CMake,即采用C++编写程序进行讨论。
1.什么组成了ROS2功能包
ROS2 CMake包的最低要求内容为:
-
package.xml
包含关于包的元信息的文件 -
CMakeLists.txt
描述如何在包中编译代码
最简单的包可能有如下的文件结构:
my_package/
CMakeLists.txt
package.xml
2.工作空间中的包
一个工作空间可以包含任意多个包,每个包都在自己的文件夹中。同样也可以在一个工作空间中拥有不同构建类型的包(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.创建一个功能包
首先,确定ROS2环境已经配置好,如果未配置,可以参考:ROS2环境配置
然后,建立dev_ws
工作空间,可以参考:ROS2工作空间建立
确保终端位于src
目录下:
cd ~/dev_ws/src
ROS2中创建一个新的功能包的语法为:
ros2 pkg create --build-type ament_cmake <package_name>
在本文中,将使用可选参数——node-name
,它将在包中创建一个简单的Hello World类型的可执行文件。在终端中输入如下命令:
ros2 pkg create --build-type ament_cmake --node-name my_node my_package
现在在工作空间的src
目录中有一个名为my_package
的新文件夹。
运行该命令后,终端将返回消息:
going to create a new package
package name: my_package
destination directory: /home/**/dev_ws/src
package format: 3
version: 0.0.0
description: TODO: Package description
maintainer: ['** <**@todo.todo>']
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
可以看到新包自动生成的文件。
4.编译功能包
将包放到工作空间中特别有价值,因为可以通过在工作空间的根目录中运行colcon build
来一次编译多个包。否则,将不得不单独编译每个包。
返回工作空间的根目录:
cd ~/dev_ws
现在编译功能包:
colcon build
当工作空间中有许多包时,colcon build
可能需要很长时间,这是可以只编译某个包。
当只编译my_package
时,可以执行:
colcon build --packages-select my_package
5.soure setup文件
要使用新的包和可执行文件,首先打开一个新的终端并source ROS2的安装空间。
然后,在dev_ws
目录中,运行以下命令来source工作空间:
. install/setup.bash
现在工作空间已经添加到环境中,可以使用新包中的可执行文件。
6.使用功能包
为了运行刚刚创建的my_node
节点,在终端执行:
ros2 run my_package my_node
此时终端输出:
hello world my_package package
7.查看包的内容
在dev_ws/src/my_package
中,会看到ros2 pkg create
自动生成的文件和文件夹:
其中,my_node.cpp
在src
目录中。所有自定义的C++节点都存放在src
中。
8.定制package.xml
在创建包之后的返回消息中,包括description
、license
和TODO
说明。这是因为描述和许可声明并不是自动设置的,但是想要发布包,它们是必需的,可能还需要填写maintainer
字段。
在dev_ws/src/my_package
目录下,打开package.xml
文件:
1<?xml version="1.0"?>
2<?xml-model
3 href="http://download.ros.org/schema/package_format3.xsd"
4 schematypens="http://www.w3.org/2001/XMLSchema"?>
5<package format="3">
6 <name>my_package</name>
7 <version>0.0.0</version>
8 <description>TODO: Package description</description>
9 <maintainer email="user@todo.todo">user</maintainer>
10 <license>TODO: License declaration</license>
11
12 <buildtool_depend>ament_cmake</buildtool_depend>
13
14 <test_depend>ament_lint_auto</test_depend>
15 <test_depend>ament_lint_common</test_depend>
16
17 <export>
18 <build_type>ament_cmake</build_type>
19 </export>
20</package>
在第9行输入姓名和电子邮件,然后,编辑第8行上的描述,以总结包的功能:
<description>Beginner client libraries tutorials practice package</description>
然后,在第10行更新license。
因为这个包仅用于练习,所以使用任何许可证都是安全的。这里使用Apache License 2.0
:
<license>Apache License 2.0</license>
不要忘记保存。
在license标记下面,看到一些以_depend
结尾的标记名称。在这里,package.xml
将列出对其他包的依赖关系,让colcon
进行搜索。my_package
很简单,没有任何依赖项。
9.总结
现在已经创建了一个包来组织代码,并使其易于他人使用。
包被自动填充了必要的文件,然后使用colcon
来构建它,这样就可以在本地环境中使用它的可执行文件。
如果给您带来帮助,希望能给点个关注,以后还会陆续更新有关机器人的内容,点个关注不迷路~欢迎大家一起交流学习。
都看到这了,点个推荐再走吧~
未经允许,禁止转载。