详解使用ament_cmake构建ROS2功能包

最新推荐文章于 2024-04-11 17:25:03 发布
最新推荐文章于 2024-04-11 17:25:03 发布
阅读量3k 收藏 51
点赞数 9
分类专栏： ROS 文章标签： 人工智能 ROS 机器人 SLAM
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/He3he3he/article/details/131327065
版权

ROS2的构建系统叫做ament_cmake，它是基于CMake改进而来的。接下来将详细介绍一下ament_cmake常用的一些命令：

  • ament_target_dependencies：添加重要的头文件、库以及相关依赖
  • ament_export_dependencies：导出依赖给下游的功能包，以至于使用该库时，不必再调用find_package添加这些依赖
  • ament_export_include_directories：标记该功能包的头文件位置，以便其他功能包要依赖该功能包时能顺利找到对应的头文件
  • ament_export_libraries：标记该功能包需要导出的库，以便其他的功能包能链接到这些库。
  • ament_package：每个功能都必须执行一次调用，会为该功能生成一个ament索引，以及cmake相关配置文件，以便其他功能包能够通过find_package找到该功能包。由于ament_package()会从CMakeLists.txt文件中收集大量信息，因此它应该是CMakeLists.txt文件中的最后一个调用。

ROS2功能包

一个功能包的构建信息包含在

  • CMakeLists.txt：描述了如何构建此功能包
  • package.xml：包含该功能包的依赖信息，它可以帮助编译工具colcon确定多个功能包编译的顺序

CMakeList.txt

接下来，以nav2中一个比较有代表性的功能包nav2_costmap_2d的CmakeList.txt来进行介绍

  1. 指定cmake的最低版本(3.5)和功能包的名字
cmake_minimum_required(VERSION 3.5)
project(nav2_costmap_2d)
  1. 查找ament_cmake包
find_package(ament_cmake REQUIRED)
  1. 查找构建此功能包所需的依赖-ROS2功能包
find_package(geometry_msgs REQUIRED)
find_package(laser_geometry REQUIRED)
find_package(map_msgs REQUIRED)
find_package(message_filters REQUIRED)
find_package(nav2_common REQUIRED)
find_package(nav2_msgs REQUIRED)
find_package(nav2_util)
find_package(nav2_voxel_grid REQUIRED)
find_package(nav_msgs REQUIRED)
find_package(pluginlib REQUIRED)
find_package(rclcpp REQUIRED)
find_package(rclcpp_lifecycle REQUIRED)
find_package(rmw REQUIRED)
find_package(sensor_msgs REQUIRED)
find_package(std_msgs REQUIRED)
find_package(std_srvs REQUIRED)
find_package(tf2_geometry_msgs REQUIRED)
find_package(tf2 REQUIRED)
find_package(tf2_ros REQUIRED)
find_package(tf2_sensor_msgs REQUIRED)
find_package(visualization_msgs REQUIRED)
find_package(angles REQUIRED)
  1. 查找构建此功能包所需的系统依赖-非ROS2功能包
find_package(Eigen3 REQUIRED)
include_directories(
  include
  ${EIGEN3_INCLUDE_DIRS}
)
  1. 使用add_library构建库
add_library(nav2_costmap_2d_core SHARED
  src/array_parser.cpp
  src/costmap_2d.cpp
  src/layer.cpp
  src/layered_costmap.cpp
  src/costmap_2d_ros.cpp
  src/costmap_2d_publisher.cpp
  src/costmap_math.cpp
  src/footprint.cpp
  src/costmap_layer.cpp
  src/observation_buffer.cpp
  src/clear_costmap_service.cpp
  src/footprint_collision_checker.cpp
  plugins/costmap_filters/costmap_filter.cpp
)
  1. 设置变量dependencies，这里主要添加的是ROS2功能包
set(dependencies
  geometry_msgs
  laser_geometry
  map_msgs
  message_filters
  nav2_msgs
  nav2_util
  nav2_voxel_grid
  nav_msgs
  pluginlib
  rclcpp
  rclcpp_lifecycle
  sensor_msgs
  std_msgs
  std_srvs
  tf2
  tf2_geometry_msgs
  tf2_ros
  tf2_sensor_msgs
  visualization_msgs
  angles
)
  1. 通过ament_target_dependencies添加ROS2功能包依赖，它将依赖的库、头文件以及自身依赖添加到目标中
ament_target_dependencies(nav2_costmap_2d_core
  ${dependencies}
)
  1. 通过add_executable构建可执行文件，同时也需要使用ament_target_dependencies添加相关依赖
add_executable(nav2_costmap_2d_markers src/costmap_2d_markers.cpp)
target_link_libraries(nav2_costmap_2d_markers
  nav2_costmap_2d_core
)

ament_target_dependencies(nav2_costmap_2d_markers
  ${dependencies}
)

add_executable(nav2_costmap_2d_cloud src/costmap_2d_cloud.cpp)
target_link_libraries(nav2_costmap_2d_cloud
  nav2_costmap_2d_core
)

add_executable(nav2_costmap_2d src/costmap_2d_node.cpp)
ament_target_dependencies(nav2_costmap_2d
  ${dependencies}
)

target_link_libraries(nav2_costmap_2d
  nav2_costmap_2d_core
  layers
  filters
)
  1. 安装库
install(TARGETS
  nav2_costmap_2d_core
  layers
  filters
  nav2_costmap_2d_client
  ARCHIVE DESTINATION lib
  LIBRARY DESTINATION lib
  RUNTIME DESTINATION bin
)
  1. 安装可执行文件，注意这里的可执行文件路径为： lib/${PROJECT_NAME}而不是bin
install(TARGETS
  nav2_costmap_2d
  nav2_costmap_2d_markers
  nav2_costmap_2d_cloud
  RUNTIME DESTINATION lib/${PROJECT_NAME}
)
  1. 导出头文件
install(DIRECTORY include/
  DESTINATION include/
)
  1. 导出launch和参数文件
install(
  DIRECTORY launch params
  DESTINATION share/${PROJECT_NAME}
)
  1. 通过ament_export_include_directories导出该功能包的头文件，以便其他功能包依赖此功能包时，能够找到对应的头文件
ament_export_include_directories(include)
  1. 通过ament_export_libraries导出该功能包构建的库，以便其他功能包能够顺利链接到
ament_export_libraries(layers filters nav2_costmap_2d_core nav2_costmap_2d_client)
  1. 通过ament_export_dependencies导出此功能包所有的ROS相关的依赖，依赖其他功能包依赖此功能包时，不必再通过find_package重复添加这些依赖
ament_export_dependencies(${dependencies})
  1. 最后调用ament_package
ament_package()

注意ament_package是可以带参数的：

ament_package(CONFIG_EXTRAS cmake/xxxx.cmake)

注意事项

  • 相比ROS1， ROS2没有了devel，只有install
  • ROS2中没有了CATKIN_DEVEL_PREFIX等变量
  • CMAKE_INSTALL_PREFIX指的是xxx/install/${package_name}而不是xxx/install

为了获得xxx/install，可以通过如下方法：

set(INSTALL_DIR ${CMAKE_INSTALL_PREFIX})
string(REPLACE "/${PROJECT_NAME}" "" INSTALL_DIR ${INSTALL_DIR})

补充

如果想在执行source install/setup.bash时，同时添加自己的环境变量，可

  1. 在功能包中添加一个env-hooks文件夹，在文件夹中添加一个project_name.sh.in文件
ament_prepend_unique_value UESER_ENV_PATH "$AMENT_CURRENT_PREFIX/XXXX"
  1. 在CMakeLists.txt中添加
ament_environment_hooks("${CMAKE_CURRENT_SOURCE_DIR}/env-hooks/${PROJECT_NAME}.sh.in")

package.xml

对于package.xml主要需要添加如下信息:

  • 编译的工具依赖：
<buildtool_depend>ament_cmake</buildtool_depend>
  • 依赖的ROS2功能包
  <depend>geometry_msgs</depend>
  <depend>laser_geometry</depend>
  <depend>map_msgs</depend>
  <depend>message_filters</depend>
  <depend>nav2_msgs</depend>
  <depend>nav2_util</depend>
  <depend>nav2_voxel_grid</depend>
  <depend>nav_msgs</depend>
  <depend>pluginlib</depend>
  <depend>rclcpp</depend>
  <depend>rclcpp_lifecycle</depend>
  <depend>sensor_msgs</depend>
  <depend>std_msgs</depend>
  <depend>std_srvs</depend>
  <depend>tf2</depend>
  <depend>tf2_geometry_msgs</depend>
  <depend>tf2_ros</depend>
  <depend>tf2_sensor_msgs</depend>
  <depend>visualization_msgs</depend>
  <depend>angles</depend>
  • 导出依赖：
  <export>
	  <build_type>ament_cmake</build_type>
  </export>

完整的package.xml

<?xml version="1.0"?>
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format ="3">
  <name>nav2_costmap_2d</name>
  <version>1.2.0</version>
  <description>
    This package provides an implementation of a 2D costmap that takes in sensor
    data from the world, builds a 2D or 3D occupancy grid of the data (depending
    on whether a voxel based implementation is used), and inflates costs in a
    2D costmap based on the occupancy grid and a user specified inflation radius.
    This package also provides support for map_server based initialization of a
    costmap, rolling window based costmaps, and parameter based subscription to
    and configuration of sensor topics.
  </description>
  <maintainer email="stevenmacenski@gmail.com">Steve Macenski</maintainer>
  <license>BSD-3-Clause</license>
  <license>Apache-2.0</license>

  <buildtool_depend>ament_cmake</buildtool_depend>
  <build_depend>nav2_common</build_depend>

  <depend>geometry_msgs</depend>
  <depend>laser_geometry</depend>
  <depend>map_msgs</depend>
  <depend>message_filters</depend>
  <depend>nav2_msgs</depend>
  <depend>nav2_util</depend>
  <depend>nav2_voxel_grid</depend>
  <depend>nav_msgs</depend>
  <depend>pluginlib</depend>
  <depend>rclcpp</depend>
  <depend>rclcpp_lifecycle</depend>
  <depend>sensor_msgs</depend>
  <depend>std_msgs</depend>
  <depend>std_srvs</depend>
  <depend>tf2</depend>
  <depend>tf2_geometry_msgs</depend>
  <depend>tf2_ros</depend>
  <depend>tf2_sensor_msgs</depend>
  <depend>visualization_msgs</depend>
  <depend>angles</depend>

  <test_depend>ament_lint_common</test_depend>
  <test_depend>ament_lint_auto</test_depend>
  <test_depend>nav2_map_server</test_depend>
  <test_depend>ament_cmake_gtest</test_depend>
  <test_depend>launch</test_depend>
  <test_depend>launch_testing</test_depend>
  <test_depend>nav2_lifecycle_manager</test_depend>

  <export>
	  <build_type>ament_cmake</build_type>
  </export>
</package>

注意：如果是自定义的msg或者srv

  • format的版本需要为3
<package format="3">
  • 编译工具依赖ament_cmake和rosidl_default_generators
  <buildtool_depend>ament_cmake</buildtool_depend>
  <buildtool_depend>rosidl_default_generators</buildtool_depend>
  • 另外需要添加
  <exec_depend>rosidl_default_runtime</exec_depend>
  <member_of_group>rosidl_interface_packages</member_of_group>
  • 导出
  <export>
    <build_type>ament_cmake</build_type>
  </export>

参考

火柴的初心
关注
  • 9
    点赞
  • 踩
  • 51
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
ament_cmake：支持CMake软件包以使用ament
02-13
ament_cmake：支持CMake软件包以使用ament
ament_cmake_auto_gtest：临时仓库的便利rement自动脚本
02-17
ament是ROS2的依赖管理和构建系统的基础，它提供了一系列的CMake宏和函数，帮助开发者构建ROS2兼容的软件包。GTest则是一个强大的开源测试框架，用于编写C++项目的单元测试。ament_cmake_auto_gtest结合了这两个组件...
【ROS2笔记三】构建ROS2功能包
最新发布
Shen Mu Xin's Blog
04-11 862
ROS2可以使用或者来创建工作包，使用进行开发推荐使用，使用进行开发推荐使用来创建包。ROS2 和各自有自己的最低要求内容：::在创建ROS2功能包之前，确保你已经位于工作空间当中，这里我的工作空间命名为 创建功能包，推荐使用（cpp）或（python）作为编译类型，并且添加依赖。1.创建一个包，在ROS2中创建新包的命令语法是： 是创建包的意思 用来指定该包的编译类型，一共有三个可选项、、 用于制定证书，一般设置为，如果不指定的话会弹出一个警告但是没有别的影响 指的是这个功能包的依赖，这里使用的
ROS2创建cpp功能包和节点
2301_76920231的博客
05-05 1521
编译时告诉编译器helloworld_node节点在helloworld.cpp文件中#helloworld_node节点依赖rclcpp四：进行编译在vs code终端中进行编译，先进入First_nodecpp文件夹下（不是在First_nodecpp/src 文件夹下进行编译）然后 colcon build 接着source install/setup.bash 最后运行节点：ros2 run hello_world helloworld_node。
动手学ROS2-1工作空间、功能包和节点
mlf2051288062的博客
07-11 951
本文基于ubuntu22.04和ros2 humble版本。
ROS1&ROS2之CmakeList.txt和package.xml用法详解
MGodmonkey的专属博客
07-26 4003
目前还在学习ROS+无人机框架中，，，更多更新文章详见我的个人博客主页【
ROS2基本概念（胡乱总结）
m0_73239336的博客
08-09 1036
DDS发布订阅模型，订阅者和发布者都不唯一，异步通信机制：适用于周期发布的数据（例如：传感器）.msg文件定义通信的消息结构模型：客户端/服务器（C/S）模型 同步通信机制服务器端唯一，客户端可以不唯一.srv文件定义请求和应答数据结构。
ROS2学习笔记之创建自己的功能包
01-06
ROS2学习笔记之创建自己的功能包背景前期准备学习内容1. 创建一个包2. 编译新建的包3 Source工作空间的配置文件4 使用新建的包5. 查看包的内容6....ROS2的包使用ament作为构建系统，colcon为编译工具。尽管可以
ROS_典型功能代码详解
01-25
创建新包使用`catkin_create_pkg`命令，代码管理遵循CMake或ament构建系统。 5. **节点(Node)**：节点是ROS程序的基本执行单元，可以理解为独立运行的进程。创建ROS节点通常涉及初始化ROS节点句柄(`ros::init`)，并...
housou:ROS 2广播通讯包
03-25
6. **依赖管理**：ROS 2的包通常会依赖于其他基础库或工具包，如`ament`和`rclcpp`等，这些都是实现ROS 2功能所必需的。 7. **测试和示例**：一个完整的ROS 2软件包通常会包含测试用例和示例代码，帮助用户理解和...
ROS2 入门应用 元功能包（Python）
氢键H-H
02-06 9935
ROS2 入门应用 元功能包（Python）的创建和编译
【C++】ROS：ROS2环境配置与基础示例
DevFrank的博客
06-15 4002
ros2环境配置与基础使用
ROS（7）ROS2命令与学习
JYliangliang的博客
10-24 363
self.server = self.create_service(接口类型(srv数据类型), 服务名, 服务器回调函数self.object_position_callback)while rclpy.ok(): ret,image = cap.read() 读取一帧图像 if ret==True: object_detect(image) 检测。self.get_parameter(参数名).get_parameter_value().string_value 从ROS2系统中读取参数的值。
ROS | 工作空间及功能包的创建
Rome was not built in a day.
05-17 3333
ROS | 工作空间及功能包的创建1. 创建工作空间2. 创建功能包 1. 创建工作空间 工作空间是一个存放工程开发相关文件的文件夹，创建工作空间首先在Linux系统中打开一个新的终端，并按照以下步骤输入指令。 $ mkdir -p ~/ROS_ws/src $ cd ~/ROS_ws/src $ catkin_init_workspace $ cd .. $ catkin_make install 说明： 第一条指令表示在/home/用户名/下创建一个ROS工作空间，即文件夹ROS_ws。同时在工作空
ROS2前置基础教程 | 使用CMakeLists.txt编译ROS2节点
生活不止眼前的苟且
06-17 3323
答案是有的，那就是cmake工具。cmake通过调用CMakeLists.txt直接生成Makefile。 2.新建CMakeLists.txt 在新建，输入下面内容。 3.编译代码 我们一般会创建一个新的目录，运行cmake并进行编译，这样的好处是不会显得那么乱。 创建好文件夹，接着运行cmake指令，代表到上级目录找。 运行完cmake你应该可以在build目录下看到cmake自动生成的Makefile了，接着就可以运行make指令进行编译 运行完上面的指令，就可以在build目录下发现节点了。ROS2
ROS2入门教程—自定义话题及服务消息类型_拓展
Roar冷颜的博客
09-23 3208
ROS2入门教程—自定义话题及服务消息类型_拓展1 创建功能包2 创建msg文件3 编译msg文件4 设置多个接口   在前面的教程中，我们已经学习了如何在一个功能包中创建自定义msg和srv接口，然后在其他功能包中调用自定义的接口。虽然在专用接口功能包中声明接口是一个好习惯，但有时在一个功能包中声明、创建和使用接口更加方便。本教程将重点介绍在一个功能包中声明、创建和使用msg接口类型，但本教程的步骤适用于所有接口类型。 1 创建功能包   首先打开一个新终端，并且设置环境变量，以便ros2命令能够正常工作
idea中module设置下dependencies的export选项
逝不等琴生的博客
05-08 7784
idea中module设置下dependencies的export选项 export 会改变当前module的依赖架包的共享范围： 例如有module A 配置依赖了jdbc.jar ,module B 又依赖 module A，但是如果你不在module A里的dependencies 里面把 JDBC。jar 前面的 export 勾上，module B是无法用到 JDBC的内容的，编译无法通...
基于ROS2开发的点云体素化
lovely_yoshino的博客
04-02 5432
0. 简介 最近在收到了很多读者的消息后,我觉得有必要开这个坑,来给大家阐述下如何对激光雷达点云以及图像点云去做栅格化以及体素化的操作.这部分需要各位读者拥有PCL,octomap,ROS2,C++的一些基础.好了废话不多说,我们第二章主要介绍点云的体素化. 1. octomap octomap是一种基于八叉树的三维地图创建工具, 可以显示包含无障碍区域及未映射区域的完整3D图形, 而且基于占有率栅格的传感器数据可以在多次测量中实现融合和更新; 地图可提供多种分辨率, 数据可压缩, 存储紧凑. 事实上, o
ament_cmake_autoConfig.cmake ament_cmake_auto-config.cmake
08-20
ament_cmake_autoConfig.cmake和ament_cmake_auto-config.cmake都是用于自动配置ament_cmake包的CMake模块文件。这些文件包含了一些CMake变量和函数，用于设置ament_cmake包的构建和安装过程中所需的依赖项、编译选项和安装目录等信息。这些模块文件通常由ament_cmake包提供，可以在CMakeLists.txt文件中使用include()命令来加载它们，以便使用其中定义的功能和变量。具体来说，ament_cmake_autoConfig.cmake用于配置ament_cmake包的构建，而ament_cmake_auto-config.cmake用于配置ament_cmake包的安装。这两个文件都是通过在CMake的扩展点系统中使用的，以实现代码的模块化和灵活性。 <span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* *3* [【ROS2原理3】：构建系统“ament_cmake”和构建工具“ament_tools”](https://blog.csdn.net/gongdiwudu/article/details/126192244)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] - *2* [ROS2学习（十六）.ROS概念 - 构建系统](https://blog.csdn.net/amuro_ray027/article/details/120201983)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_2"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

火柴的初心

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值