ament_cmake 项目使用指南

ament_cmake 项目使用指南

项目地址:https://gitcode.com/gh_mirrors/am/ament_cmake

1. 项目介绍

ament_cmake 是 ROS 2 中基于 CMake 的包构建系统。它是一组脚本，增强了 CMake 的功能，并为包作者提供了便利的功能。ament_cmake 主要用于大多数（如果不是全部）C/C++ 项目，是 ROS 2 生态系统中的重要组成部分。

2. 项目快速启动

2.1 安装

首先，确保你已经安装了 ROS 2。然后，通过以下命令安装 ament_cmake：

sudo apt-get install ros-foxy-ament-cmake

2.2 创建一个新项目

使用 ros2 pkg create 命令创建一个新的 ROS 2 包：

ros2 pkg create --build-type ament_cmake my_package

2.3 编写 CMakeLists.txt

在 my_package 目录下，编辑 CMakeLists.txt 文件，添加以下内容：

cmake_minimum_required(VERSION 3.5)
project(my_package)

find_package(ament_cmake REQUIRED)

# 添加你的源文件
add_executable(my_node src/my_node.cpp)

# 添加依赖
ament_target_dependencies(my_node rclcpp)

# 安装节点
install(TARGETS my_node DESTINATION lib/${PROJECT_NAME})

ament_package()

2.4 编译项目

使用 colcon 编译你的项目：

colcon build --packages-select my_package

2.5 运行节点

编译完成后，运行你的节点：

source install/setup.bash
ros2 run my_package my_node

3. 应用案例和最佳实践

3.1 添加依赖

在 CMakeLists.txt 中添加依赖时，推荐使用 ament_target_dependencies 宏：

find_package(Eigen3 REQUIRED)
ament_target_dependencies(my_target Eigen3)

3.2 构建库

如果你需要构建一个可重用的库，可以使用以下代码：

add_library(my_library src/my_library.cpp)
ament_export_targets(my_libraryTargets HAS_LIBRARY_TARGET)
ament_export_dependencies(some_dependency)

install(
  DIRECTORY include/
  DESTINATION include
)

install(
  TARGETS my_library
  EXPORT my_libraryTargets
  LIBRARY DESTINATION lib
  ARCHIVE DESTINATION lib
  RUNTIME DESTINATION bin
  INCLUDES DESTINATION include
)

3.3 测试和 linting

为了分离测试和构建库，可以在 CMakeLists.txt 中添加以下内容：

if(BUILD_TESTING)
  find_package(ament_cmake_gtest REQUIRED)
  ament_add_gtest(my_test src/my_test.cpp)
endif()

4. 典型生态项目

4.1 ROS 2 核心库

ament_cmake 是 ROS 2 核心库的一部分，广泛用于构建 ROS 2 的 C++ 包。例如，rclcpp 和 rclpy 都是基于 ament_cmake 构建的。

4.2 机器人操作系统

在机器人操作系统中，ament_cmake 用于构建各种机器人相关的包，如导航、感知和控制等。

4.3 自动驾驶

在自动驾驶领域，ament_cmake 用于构建自动驾驶软件栈中的各种组件，如感知、规划和控制模块。

通过以上步骤，你可以快速上手 ament_cmake，并在 ROS 2 项目中高效地构建和管理你的包。

ament_cmake Supporting CMake packages for working with ament 项目地址: https://gitcode.com/gh_mirrors/am/ament_cmake