当前位置: 首页 > java >正文

ROS2 工作空间中, CMakeLists.txt, setup.py和 package.xml的作用分别是?

提问

ROS2 工作空间中, CMakeLists.txt, setup.py和 package.xml的作用分别是?

回答

在一个 ROS 2 包(package)里,这三个文件各司其职:

  1. package.xml

    • 作用:声明包的元信息和依赖关系,是 ROS 构建系统和生态工具(如 rosdepvcs)识别、安装和管理包的依据。

    • 主要内容

      • <name><version><description><license><maintainer><author> 等元数据
      • <depend><build_depend><exec_depend> 等依赖声明
      • 导出项(<export>),如是否启用动态链接库、插件描述器等
  2. CMakeLists.txt

    • 作用:用 CMake 语法定义包的“构建规则”(build rules),告诉 colcon(背后调用 ament_cmake)怎样编译 C/C++ 代码、生成接口(messages/services/actions)、安装可执行文件和资源。

    • 常见流程

      1. find_package(ament_cmake REQUIRED)find_package(rclcpp REQUIRED) 等:找到所需的 ament/C++ 库
      2. 对于自定义消息:调用 rosidl_generate_interfaces()
      3. add_executable() / ament_target_dependencies():定义可执行节点及其依赖
      4. install():指定要安装的二进制、库、资源目录
      5. ament_package():标记 CMake 包的结束,注册给 ament
    • 注意:即使是纯 Python 包,也需要一个最小化的 CMakeLists.txt 来激活 ament_python(通常只包含 find_package(ament_python REQUIRED)ament_python_install_package())。

  3. setup.py

    • 作用:Python 标准的打包脚本,告诉 setuptools(由 ament_python 调用)如何安装你的 Python 模块、数据文件及定义命令行入口(console scripts)。

    • 主要内容

      • nameversionpackagesinstall_requires(对应 package.xml 中的 exec_depend)
      • entry_points={'console_scripts': [...]}:将脚本安装为可执行命令(如 ros2 run my_pkg talker
      • data_files:安装 launch 文件、配置文件、参数包等非代码资源

它们之间的配合

  • 当你在工作空间根目录执行 colcon build 时:

    1. colcon 扫描每个 package 目录,读取其 package.xml 判断是否要构建,并收集依赖关系。
    2. 如果包声明使用 ament_cmake(在 CMakeLists.txt 中出现 find_package(ament_cmake ...)),就走 CMake 流程;如果声明使用 ament_python,就会调用 setup.py
    3. CMake 流程中,package.xml 也会被安装到最终的安装目录中,以便运行时和上层工具再次读取依赖。
  • 简单对比

    文件用途构建时机典型使用场景
    package.xml元信息 + 依赖管理colcon 扫描依赖所有 ROS 2 包
    CMakeLists.txtC/C++ 构建脚本 + 自定义接口生成ament_cmakeC++ 节点、接口包、自定义消息包
    setup.pyPython 安装脚本 + console entry pointsament_python纯 Python 节点包

这样分工明确,才能保证 ROS 2 包既能被正确地发现和管理,又能根据你所写的 C++、Python 代码或自定义消息去编译/安装。

http://www.xdnf.cn/news/13609.html

相关文章:

  • 【编译原理】题目合集(一)
  • 初识MySQL · 事务 · 下
  • TCP/IP 网络编程 | Reactor事件处理模式
  • 像素跟踪 跟踪像素 算法总结
  • 【慧游鲁博】【12】小程序端 · 智能导览对接后端文物图片识别功能
  • WEB JWT
  • java复习 09
  • 【开源工具】:基于PyQt5的智能网络驱动器映射工具开发全流程(附源码)
  • WWDC 2025 开发者特辑 | 肘子的 Swift 周报 #088
  • 计算机视觉之三维重建(深入浅出SfM与SLAM核心算法)—— 1. 摄像机几何
  • 2025最新软件测试八股文,查漏补缺(含答案+文档)
  • Spring Cloud Gateway 介绍
  • 离线部署openstack 2024.1 neutron
  • 离线部署openstack 2024.1 keystone
  • AI Agent 的架构与技术体系分析
  • 新能源知识库(40)一个省的综合电价由哪些因素决定?
  • C++ call_once用法
  • 基础知识:抽象类成员变量的继承与使用
  • Web APIS Day04
  • BlogX项目数据库读写分离AI面试题
  • 海外打车代驾app多语言切换模块设计
  • CentOs7.x系列IP地址由动态改静态(解决远程连接掉线问题)
  • 字符串|数组|计算常见函数整理-竞赛专用(从比赛真题中总结的,持续更新中)
  • 7.Vue的compute计算属性
  • atomicity of memory accesses
  • 【知识图谱构建系列1】数据集介绍
  • 本地docker部署的dify,不用git命令如何无损升级?
  • Vue3前端项目Docker容器化部署工作报告
  • 【算法 day01】LeetCode 704二分查找 | 27移除元素 | 977有序数组的平方
  • 【电力物联网】SDN架构与工作原理介绍