ROS Catkin 教程之 package.xml

最新推荐文章于 2023-03-12 16:04:52 发布
最新推荐文章于 2023-03-12 16:04:52 发布
阅读量696 收藏 6
点赞数 1
分类专栏： ROS程序设计

1. 概览

程序包清单是一个名为 package.xml 的 XML 文件，必须包含在任何符合 catkin 规范的程序包的根目录中。此文件定义包的各种属性，例如包名称，版本号，作者，维护者以及对其他 catkin 包的依赖。请注意，此概念类似于旧版 rosbuild 构建系统中使用的 manifest.xml 文件。

你的系统包依赖项在 package.xml 中声明。 如果这些依赖项缺失或不正确，你可以在自己的计算机上构建源代码并运行测试，但是当发布到 ROS 社区时，你的程序包将无法正常运行。 其他人根据这些信息得知使用你的程序包需要安装的软件（除了 U-Texas 的 catkin 任务导向文档）。

2. 格式2（推荐）

这是新程序包的推荐格式，并且推荐你将格式 1 的程序包转换为格式 2 的程序包。有关从格式 1 迁移到格式 2的说明，请参阅 catkin API 文档中的 从格式 1 迁移到格式 2。

格式 2 的完整文档可以在 catkin API 文档中找到。更多信息可以在 REP 140 - Package Manifest Format Two Specification 中找到。

2.1 基本结构

每个 package.xml 文件都将 <package> 标记作为文档中的根标记。

<package format="2">

</package>

2.2 必需的标记

为使程序包清单完整，<package> 标记中需要嵌套一套最小标记。

  • <name> - 程序包名
  • <version> - 包的版本号（需要 3 个点分隔的整数）
  • <description> - 对包内容的描述
  • <maintainer> - 包的维护者名字
  • license - 发布代码的软件许可证（例如 GPL, BSD, AS）

举个例子，这里是一个名为 foo_core 的虚构包的包清单。

<package format="2">
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
  This package provides foo capability.
  </description>
  <maintainer email="ivana@osrf.org">Ivana Bildbotz</maintainer>
  <license>BSD</license>
</package>

2.3 依赖

上述带有最小标记的程序包清单没有指出对其他包的任何依赖性。程序包可以有六种类型的依赖项：

  • Build 依赖指定构建此程序包所需的程序包。这种情况是在构建的时候需要一些来自这些包的文件，例如在编译时包含了来自这些包的头文件，需要链接来自这些包的库或在构建时需要任何其他资源（特别是当这些包是在 CMake 中的 find_package() 时）。在交叉编译方案中，构建依赖应当适用于目标体系结构。
  • Build 导出依赖指定将此程序包构建为库所依赖的包。例如你在将要导出的头文件中包含了依赖项的头文件，则属于这种情况（特别是当这些包在 CMake 中的 catkin_package() 中声明为 (CATKIN_)DEPENDS时）。
  • Execution 依赖指定运行此程序包中代码所需的包。当此包中的依赖有共享库时就是这种情况（特别是当这些包在 CMake 中的 catkin_package() 中声明为 (CATKIN_)DEPENDS 时）。
  • Test 依赖仅指定用于单元测试的其他依赖项。不要重复指定已经提到的构建和运行时依赖。
  • Build 工具依赖指定此程序包构建自身所需的构建系统工具。通常，唯一需要的构建工具是 catkin。 在交叉编译方案中，构建工具依赖应当适用于执行编译的体系结构。
  • 文档工具依赖指定程序包用来生成文档的工具。

上述 6 种依赖项分别使用以下 6 个标签指定：

  • <depend>
  • <buildtool_depend>
  • <build_depend>
  • <build_export_depend>
  • <exec_depend>
  • <test_depend>
  • <doc_depend>

所有包都至少有一个依赖项，即构建工具依赖项 catkin，如下例所示。

<package format="2">
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
    This package provides foo capability.
  </description>
  <maintainer email="ivana@osrf.org">Ivana Bildbotz</maintainer>
  <license>BSD</license>

  <buildtool_depend>catkin</buildtool_depend>
</package>

一个指定了构建、执行、测试和文档依赖关系的更实际的例子可能如下所示。

<package format="2">
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
    This package provides foo capability.
  </description>
  <maintainer email="ivana@willowgarage.com">Ivana Bildbotz</maintainer>
  <license>BSD</license>

  <url>http://ros.org/wiki/foo_core</url>
  <author>Ivana Bildbotz</author>

  <buildtool_depend>catkin</buildtool_depend>

  <depend>roscpp</depend>
  <depend>std_msgs</depend>

  <build_depend>message_generation</build_depend>

  <exec_depend>message_runtime</exec_depend>
  <exec_depend>rospy</exec_depend>

  <test_depend>python-mock</test_depend>

  <doc_depend>doxygen</doc_depend>
</package>

更多关于依赖关系的细节可以在 catkin API 文档中找到。

2.4 元功能包

将多个程序包组织为一个逻辑包通常可以带来方便，这可以通过元功能包来实现。元功能包是一个普通的功能包，但在其 package.xml 的 <export> 标记中嵌套了一个 <metapackage />：

 <export>
   <metapackage />
 </export>

除了对 catkin 必需的 <buildtool_depends> 依赖之外，元功能包只能对其所组织的包具有 execution 依赖性。

另外，元功能包需要一个如下面样板所示的 CMakeLists.txt 文件：

cmake_minimum_required(VERSION 2.8.3)
project(<PACKAGE_NAME>)
find_package(catkin REQUIRED)
catkin_metapackage()

注意：将 <PACKAGE_NAME> 替换为元功能包的名称。

2.5 其他标记

  • <url> - 该程序包的 URL 信息，通常是 ros.org 上的维基页。
  • <author> - 程序包作者

3. 格式 1（旧的格式）

较旧的 catkin 程序包清单使用格式 1。 如果 <package> 标签没有 format 属性，则它是格式 1 的包。 格式 2 用于新程序包。

package.xml 的格式很简单。

3.1 基本结构

每个 package.xml 文件都将 <package> 标记作为文档中的根标记。

<package>

</package>

3.2 必需的标记

为使程序包清单完整，<package> 标记中需要嵌套一套最小标记。

  • <name> - 程序包名
  • <version> - 包的版本号（需要 3 个点分隔的整数）
  • <description> - 对包内容的描述
  • <maintainer> - 包的维护者名字
  • license - 发布代码的软件许可证（例如 GPL, BSD, AS）

举个例子，这里是一个名为 foo_core 的虚构包的包清单。

<package>
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
  This package provides foo capability.
  </description>
  <maintainer email="ivana@osrf.org">Ivana Bildbotz</maintainer>
  <license>BSD</license>
</package>

3.3 构建、运行和测试依赖

上述带有最小标记的程序包清单没有指出对其他包的任何依赖性。程序包可以有四种类型的依赖项：

  • Build Tool 依赖指定此程序包构建自身所需的构建系统工具。通常，唯一需要的构建工具是 catkin。 在交叉编译方案中，构建工具依赖应当适用于执行编译的体系结构。
  • Build 依赖指定构建此程序包所需的程序包。这种情况是在构建的时候需要一些来自这些包的文件，例如在编译时包含了来自这些包的头文件，需要链接来自这些包的库或在构建时需要任何其他资源（特别是当这些包是在 CMake 中的 find_package() 时）。在交叉编译方案中，构建依赖应当适用于目标体系结构。
  • Run 依赖指定运行此程序包中代码所需的包，以及从此包构建库所需的包。当此包中的依赖有共享库，或在公共头文件中传递地包含了它们的头文件时就是这种情况（特别是当这些包在 CMake 中的 catkin_package() 中声明为 (CATKIN_)DEPENDS 时）。
  • Test 依赖仅指定用于单元测试的其他依赖项。不要重复指定已经提到的构建和运行时依赖。

上述 4 种依赖项分别使用以下 4 个标签指定：

  • <buildtool_depend>
  • <build_depend>
  • <run_depend>
  • <test_depend>

所有包都至少有一个依赖项，即构建工具依赖项 catkin，如下例所示。

<package>
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
    This package provides foo capability.
  </description>
  <maintainer email="ivana@willowgarage.com">Ivana Bildbotz</maintainer>
  <license>BSD</license>

  <buildtool_depend>catkin</buildtool_depend>
</package>

一个指定了构建、执行、和测试依赖关系的更实际的例子可能如下所示。

<package>
  <name>foo_core</name>
  <version>1.2.4</version>
  <description>
    This package provides foo capability.
  </description>
  <maintainer email="ivana@willowgarage.com">Ivana Bildbotz</maintainer>
  <license>BSD</license>

  <url>http://ros.org/wiki/foo_core</url>
  <author>Ivana Bildbotz</author>

  <buildtool_depend>catkin</buildtool_depend>

  <build_depend>message_generation</build_depend>
  <build_depend>roscpp</build_depend>
  <build_depend>std_msgs</build_depend>

  <run_depend>message_runtime</run_depend>
  <run_depend>roscpp</run_depend>
  <run_depend>rospy</run_depend>
  <run_depend>std_msgs</run_depend>

  <test_depend>python-mock</test_depend>
</package>

有关依赖关系的更多细节请点击这里。

3.4 元功能包

将多个程序包组织为一个逻辑包通常可以带来方便，这可以通过元功能包来实现。元功能包是一个普通的功能包，但在其 package.xml 的 <export> 标记中嵌套了一个 <metapackage />：

 <export>
   <metapackage />
 </export>

除了对 catkin 必需的 <buildtool_depends> 依赖之外，元功能包只能对其所组织的包具有 execution 依赖性。

另外，元功能包需要一个如下面样板所示的 CMakeLists.txt 文件：

cmake_minimum_required(VERSION 2.8.3)
project(<PACKAGE_NAME>)
find_package(catkin REQUIRED)
catkin_metapackage()

注意：将 <PACKAGE_NAME> 替换为元功能包的名称。

在讨论了 package.xml 文件的安装之后，元功能包现在有了 CMakeLists.txt 文件：

https://groups.google.com/forum/#!msg/ros-sig-buildsystem/mn-VCkl2OHk/dUsHBBjyK30J

所以现在元功能包的 package.xml 文件是会安装到系统中的 ，但是仍然强制要求用户不要不要把元功能包作为依赖项，所以不要偏离建议的样板 CMakeLists.txt 代码。

3.5 其他标记

  • <url> - 该程序包的 URL 信息，通常是 ros.org 上的维基页。
  • <author> - 程序包作者

更多信息请查看 http://ros.org/reps/rep-0127.html

lcc816
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ROS学习：ROS文件系统--package.xml
技术小白的进阶之路
05-12 1475
package.xml 也是一个 catkin的package 必备文件，它是这个软件包的描述文件，在较早的ROS 版本 ( rosbuild 编译系统) 中，这个文件叫做 manifest.xml ，用于描述 pacakge 的基本信息。如果你在网上看到一些 ROS 项目里包含着 manifest.xml ，那么它多半是hydro版本之前的项目了。 package.xml作用 pacakge...
关于package.xml和CMakeList.txt的解读
weixin_43463140的博客
03-29 1018
关于package.xml和CMakeList.txt的解读前言一、关于package.xml文件的讲解？二、关于CMakeList.txt文件的讲解1.必需的CMake版本：cmake_minimum_required()2.软件包名：project()3.软件包名：project()4.软件包名：project()5.软件包名：project()6.软件包名：project()7.软件包名：project()8.软件包名：project()总结 参考来源： —https://mp.weixin.qq.c
catkin package.xml
xiaoma_bk的博客
01-10 476
catkin package.xml wiki 写的超详细 1.格式2（推荐） 这是新软件包的推荐格式。还建议将旧格式1程序包迁移到格式2.有关从格式1迁移到格式2的说明，请参阅catkin API文档中的从格式1迁移到格式2。Migrating from Format 1 to Format 2  包清单是一个名为package.xml的XML文件，必须包含在任何符合catkin的包的根文...
1. ROS基础知识——catkin、package
MaXiaoTiancsdn的博客
12-03 305
1. catkin_make 1.1 建立工作空间 $ mkdir -p ~/catkin_ws/src　　 $ cd ~/catkin_ws/ $ catkin_make #初始化工作空间 1.2编译 $ cd ~/catkin_ws #回到工作空间,catkin_make必须在工作空间下执行 $ catkin_make #开始编译 $ source ~/catkin_ws/dev...
catkin学习第二章：package.xml
Jian的博客
02-12 716
官方package.xml文档链接 depend 相当于<build_depend>、<build_export_depend>、<exec_depend> <depend>roscpp</depend> run_depend 相当于<exec_depend>、<build_export_depend> <run_depend>rospy</run_depend> build_depend 指定编
ROS Catkin 教程之 catkin_package(...) 到底在做什么？
liuzubing的博客
06-03 957
While looking at a CMakeLists.txt file, I was wondering the exact meaning of theCATKIN_DEPENDSoption of thecatkin_package(...)macro was. I would expect to see there the same packages as listed in thefind_package(...)macro but this does not seem to b...
兼容ros1 ros2自定义消息的cmakelists.txt文件与package.xml文件
最新发布
04-14
在ROS（Robot Operating System）开发中，`cmakelists.txt`和`package.xml`是两个至关重要的文件，它们定义了ROS包的构建规则和元数据。当我们需要在ROS1和ROS2之间实现兼容性，特别是在处理自定义消息时，这两个...
catkin_package.xml - ROS Wiki.pdf
06-22
在ROS（Robot Operating System，机器人操作系统）中，每个catkin兼容的软件包根目录下都必须包含一个名为package.xml的包清单文件。这个文件非常重要，它定义了软件包的属性，如包名称、版本号、作者、维护者和对...
ros系统之package.xml编写
yyl80的博客
08-15 711
以版本2编写： 包含的内容： 模板： <?xml version="1.0"?> <!-- 1.0根据实际修改--> <package format="2"> <name>package name</name> <!--package name 根据实际的包进行修改 --> <version>...
ROS课程讲义--2 Catkin工作空间和Package
jinking01的专栏
11-02 1724
2.2 Catkin工作空间 Catkin工作空间是创建、修改、编译catkin软件包的目录。catkin的工作空间，直观的形容就是一个仓库，里面装载着ROS的各种项目工程，便于系统组织管理调用。在可视化图形界面里是一个文件夹。我们自己写的ROS代码通常就放在工作空间中，本节就来介绍catkin工作空间的结构。 2.2.1 初始化catkin工作空间 介绍完catkin编译系统，我们来建立一...
ros catkin包配置文件package.xml
二进制君
11-07 694
参考：http://wiki.ros.org/catkin/package.xml 1. 概述 包清单是一个名为package.xml 的 XML文件，必须包含在任何符合 catkin 的包的根文件夹中。此文件定义有关包的属性，如包名称、版本号、作者、维护者以及其他 catkin 包的依赖项。 2. 格式 2（推荐） 这是新包的推荐格式。还建议将较旧的格式 1 包迁移到格式 2。有关从格式 1 迁移到格式 2 的说明，请参阅在 catkin API 文档中从格式 1迁移到格式 2。 2.1 基本结构 每个包
Metapackage包
一抹烟霞的博客
11-11 886
Metapackage（功能包集）是把一些相近的功能模块、 软件包放到一起。 ROS里常见的Metapacakge有： 2、Metapackage写法 CMakeLists.txt 写法如下： cmake_minimum_required(VERSION 2.8.3) project(ros_a...
ROS下创建meta_package
Learning by doing
11-28 4918
1.背景 不知道大家有没有这样的经历，自己的catkin_ws/src下的package越来越多了，每次运行的时候，都得先去确认一下package的名字。有没有像ROS by example的代码rbx1那样，将这本书的所有package全部集中到一个metapackage下。比如我们实验室用的机器人是youbot，那么我可以把自己写的代码全部放在一个地方，比如叫youbot_yw,创建的pac
package.xml
weixin_30607029的博客
11-11 412
package.xml 也是一个catkin的package必备文件， 它是这个软件包的描述文件， 在较早的ROS版本(rosbuild编译系统)中， 这个文件叫做 manifest.xml ， 用于描述pacakge的基本信息。 如果你在网上看到一些ROS项目里包含着 manifest.xml ， 那么它多半是hydro版本之前的项目了。 1、package.xml作用 pacakg...
catkin_package解析
chengde6896383的专栏
05-31 2329
catkin_package与find_packagehttps://cloud.tencent.com/developer/ask/183702 ROS Catkin 教程之 catkin_package(...) 到底在做什么？https://blog.csdn.net/lcc816/article/details/82962561 https://answers.ros.org/quest...
catkin 工作空间 - Package 组成
andiao1218的博客
05-24 253
package 是 ROS 软件的基本组织形式，ROS 就是由一个个的 package 组成的 package 是 catkin 的编译基本单元 一个 package 可以包含多个可执行文件（节点） package 下要包含这两个文件 CMakeLists.txt、package.xml CMakeLists.txt 规定 catkin 编译的规则，例如：源文件、依赖项、目标文件...
实现ROS基本功能
TheRun的博客
03-12 956
测试订阅和发布节点新开3个终端，分别输入roscore发布者发布的消息：订阅者收到的消息测试自定义消息格式下面使用自定义的消息格式int64 age需要修改①加入消息头文件 ②修改发布类型为beginner_tutorials::MyFirstMsg.msg ③修改终端输出#include // 虽然.msg不算头文件，但这样写就能包括进来// 包名/消息名.h在while函数中修改（赋值+显示+发布）
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值