ros学习3--Creating Package （ROS软件包创建）

挣扎的菜菜苏

于 2023-08-08 08:44:09 发布

阅读量686

点赞数 1

分类专栏： ROS学习文章标签：学习机器人自动驾驶

本文链接：https://blog.csdn.net/m0_60030502/article/details/132154601

版权

ROS学习专栏收录该内容

19 篇文章 3 订阅

订阅专栏

本文系统配置ubuntu20.04+ros1，是初学者按照ros官网初级教程学习记录，仅作个人学习记录，如有问题可联系本文作者。

附上ros1官网学习教程链接Documentation - ROS Wikihttps://wiki.ros.org/ros2官网学习教程链接Project Governance — ROS 2 Documentation: Rolling documentationhttps://docs.ros.org/en/rolling/The-ROS2-Project/Governance.html

一、一个catkin软件包的基本组成

一个包要想称为catkin软件包，必须符合以下要求：

这个包必须有一个符合catkin规范的package.xml文件
- 这个package.xml文件提供有关该软件包的元信息
这个包必须有一个catkin版本的CMakeLists.txt文件
- 如果它是个Catkin元包的话，则需要有一个CMakeList.txt文件的相关样板
每个包必须有自己的目录
- 这意味着在同一个目录下不能有嵌套的或者多个软件包存在

最简单的软件包如下：

my_package/
  CMakeLists.txt
  package.xml

二、catkin工作空间中的软件包

开发catkin软件包的推荐方法是使用catkin工作空间，但也可以单独开发catkin软件包。一个简单的工作空间如下所示：

workspace_folder/        -- WORKSPACE
  src/                   -- SOURCE SPACE
    CMakeLists.txt       -- 'Toplevel' CMake file, provided by catkin
    package_1/
      CMakeLists.txt     -- CMakeLists.txt file for package_1
      package.xml        -- Package manifest for package_1
    ...
    package_n/
      CMakeLists.txt     -- CMakeLists.txt file for package_n
      package.xml        -- Package manifest for package_n

三、创建catkin软件包

首先根据之前的学习，创建一个空白的catkin工作空间，然后切换到刚才创建的空白catkin工作空间中的源文件空间目录：

# You should have created this in the Creating a Workspace Tutorial
$ cd ~/catkin_ws/src

catkin_create_pkg命令会要求你输入package_name，如有需要还可以在后面添加一些需要依赖的其它软件包：

# This is an example, do not try to run this
# catkin_create_pkg <package_name> [depend1] [depend2] [depend3]

使用catkin_create_pkg命令创建一个名为beginner_tutorials的新软件包，这个软件包依赖于std_msgs、roscpp和rospy：

$ catkin_create_pkg beginner_tutorials std_msgs rospy roscpp

这将会创建一个名为beginner_tutorials的文件夹，这个文件夹里面包含一个package.xml文件和一个CMakeLists.txt文件，这两个文件都已经部分填写了你在执行catkin_create_pkg命令时提供的信息。具体输出如下：

catkin_create_pkg命令也有更多的高级功能，具体可前往以下链接。catkin/commands/catkin_create_pkghttps://wiki.ros.org/catkin/commands/catkin_create_pkg

四、构建一个catkin工作区并生效配置文件

现在在catkin工作区中构建软件包：

$ cd ~/catkin_ws
$ catkin_make

工作空间构建完成后，在devel子目录下可以看到

要将这个工作空间添加到ROS环境中，需要source一下生成的配置文件：

$ . ~/catkin_ws/devel/setup.bash

五、软件包依赖关系

5.1一级依赖

之前使用catkin_create_pkg命令时提供了几个软件包作为依赖关系，现在可以使用rospack命令工具来查看这些一级依赖包。

$ rospack depends1 beginner_tutorials

输出如下：

如你所见，rospack列出了在运行catkin_create_pkg命令时作为参数的依赖包，这些依赖关系存储在package.xml文件中。

输入：

$ roscd beginner_tutorials
$ cat package.xml

输出：

<?xml version="1.0"?>
<package format="2">
  <name>beginner_tutorials</name>
  <version>0.0.0</version>
  <description>The beginner_tutorials package</description>

  <!-- One maintainer tag required, multiple allowed, one person per tag -->
  <!-- Example:  -->
  <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> -->
  <maintainer email="user@todo.todo">user</maintainer>


  <!-- One license tag required, multiple allowed, one license per tag -->
  <!-- Commonly used license strings: -->
  <!--   BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3 -->
  <license>TODO</license>


  <!-- Url tags are optional, but multiple are allowed, one per tag -->
  <!-- Optional attribute type can be: website, bugtracker, or repository -->
  <!-- Example: -->
  <!-- <url type="website">http://wiki.ros.org/beginner_tutorials</url> -->


  <!-- Author tags are optional, multiple are allowed, one per tag -->
  <!-- Authors do not have to be maintainers, but could be -->
  <!-- Example: -->
  <!-- <author email="jane.doe@example.com">Jane Doe</author> -->


  <!-- The *depend tags are used to specify dependencies -->
  <!-- Dependencies can be catkin packages or system dependencies -->
  <!-- Examples: -->
  <!-- Use depend as a shortcut for packages that are both build and exec dependencies -->
  <!--   <depend>roscpp</depend> -->
  <!--   Note that this is equivalent to the following: -->
  <!--   <build_depend>roscpp</build_depend> -->
  <!--   <exec_depend>roscpp</exec_depend> -->
  <!-- Use build_depend for packages you need at compile time: -->
  <!--   <build_depend>message_generation</build_depend> -->
  <!-- Use build_export_depend for packages you need in order to build against this package: -->
  <!--   <build_export_depend>message_generation</build_export_depend> -->
  <!-- Use buildtool_depend for build tool packages: -->
  <!--   <buildtool_depend>catkin</buildtool_depend> -->
  <!-- Use exec_depend for packages you need at runtime: -->
  <!--   <exec_depend>message_runtime</exec_depend> -->
  <!-- Use test_depend for packages you need only for testing: -->
  <!--   <test_depend>gtest</test_depend> -->
  <!-- Use doc_depend for packages you need only for building documentation: -->
  <!--   <doc_depend>doxygen</doc_depend> -->
  <buildtool_depend>catkin</buildtool_depend>
  <build_depend>roscpp</build_depend>
  <build_depend>rospy</build_depend>
  <build_depend>std_msgs</build_depend>
  <build_export_depend>roscpp</build_export_depend>
  <build_export_depend>rospy</build_export_depend>
  <build_export_depend>std_msgs</build_export_depend>
  <exec_depend>roscpp</exec_depend>
  <exec_depend>rospy</exec_depend>
  <exec_depend>std_msgs</exec_depend>


  <!-- The export tag contains other, unspecified, tags -->
  <export>
    <!-- Other tools can request additional information be placed here -->

  </export>
</package>

5.2间接依赖

在很多情况下，一个依赖包还会有它自己的依赖关系。

比如rospy，输入：

$ rospack depends1 rospy

输出：

一个软件包还有相当多间接的依赖关系，使用rospack可以递归检测出所有嵌套的依赖包。

$ rospack depends beginner_tutorials

六、自定义软件包--自定义package.xml

自动生成的package.xml文件应该在你的新软件包中。现在引用第五章节中的内容，看看新生成的package.xml文件以及每一个需要你关注的元素。

6.1描述标签

首先关注description标签：

  5   <description>The beginner_tutorials package</description>

可以将描述信息修改为任何你需要的内容，但是按照惯例，第一句话应该简短一些，因为它包括了软件包的范围。如果用一句话难以描述完全那就需要换行了。

6.2维护者标签

接下来是maintainer标签：

  7   <!-- One maintainer tag required, multiple allowed, one person per tag --> 
  8   <!-- Example:  -->
  9   <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> -->
  10   <maintainer email="user@todo.todo">user</maintainer>

这是package.xml中要求填写的一个重要标签，能够让其他人联系到软件包的相关人员。所以至少需要填写一个维护者，也可以添加多个。除了在标签里面填写维护者的名字外，还应该在标签的email属性中填写电子邮件地址：

  7   <maintainer email="you@yourdomain.tld">Your Name</maintainer>

6.3许可证标签

再接下来是license标签，同样地也需要：

  12   <!-- One license tag required, multiple allowed, one license per tag -->
  13   <!-- Commonly used license strings: -->
  14   <!--   BSD, MIT, Boost Software License, GPLv2, GPLv3, LGPLv2.1, LGPLv3 -->
  15   <license>TODO</license>

应该选择一种许可证并将它填写到这里。一些常见的开源许可协议有BSD、MIT、Boost Software License、GPLv2、GPLv3、LGPLv2.1和LGPLv3。你可以在Open Source Initiative中阅读其中的若干个许可协议的相关信息。因为其他核心ROS组件已经在使用，使用BSD许可证如下：

  8   <license>BSD</license>

6.4依赖项标签

接下来的标签描述了软件包的依赖关系，这些依赖项分为build_depend、buildtool_depend、run_depend、test_depend。有关这些标记的详细说明，请参考Catkin Dependencies相关的文档。在之前的操作中，因为我们将roscpp、rospy和std_msgs作为catkin_create_pkg命令的参数，因此依赖关系如下所示：

  27   <!-- The *_depend tags are used to specify dependencies -->
  28   <!-- Dependencies can be catkin packages or system dependencies -->
  29   <!-- Examples: -->
  30   <!-- Use build_depend for packages you need at compile time: -->
  31   <!--   <build_depend>genmsg</build_depend> -->
  32   <!-- Use buildtool_depend for build tool packages: -->
  33   <!--   <buildtool_depend>catkin</buildtool_depend> -->
  34   <!-- Use exec_depend for packages you need at runtime: -->
  35   <!--   <exec_depend>python-yaml</exec_depend> -->
  36   <!-- Use test_depend for packages you need only for testing: -->
  37   <!--   <test_depend>gtest</test_depend> -->
  38   <buildtool_depend>catkin</buildtool_depend>
  39   <build_depend>roscpp</build_depend>
  40   <build_depend>rospy</build_depend>
  41   <build_depend>std_msgs</build_depend>

除了catkin中默认提供的buildtool_depend，所有我们列出的依赖包都已经被添加到build_depend标签中。在本例中，因为在编译和运行时都需要用到所有指定的依赖包，因此还要将每一个依赖包分别添加到run_depend标签中：

  12   <buildtool_depend>catkin</buildtool_depend>
  13 
  14   <build_depend>roscpp</build_depend>
  15   <build_depend>rospy</build_depend>
  16   <build_depend>std_msgs</build_depend>
  17 
  18   <exec_depend>roscpp</exec_depend>
  19   <exec_depend>rospy</exec_depend>
  20   <exec_depend>std_msgs</exec_depend>

6.5最终的package.xml

现在看最后去掉了注释和未使用标签后的package.xml文件：

  1 <?xml version="1.0"?>
  2 <package format="2">
  3   <name>beginner_tutorials</name>
  4   <version>0.1.0</version>
  5   <description>The beginner_tutorials package</description>
  6 
  7   <maintainer email="you@yourdomain.tld">Your Name</maintainer>
  8   <license>BSD</license>
  9   <url type="website">http://wiki.ros.org/beginner_tutorials</url>
  10   <author email="you@yourdomain.tld">Jane Doe</author>
  11 
  12   <buildtool_depend>catkin</buildtool_depend>
  13 
  14   <build_depend>roscpp</build_depend>
  15   <build_depend>rospy</build_depend>
  16   <build_depend>std_msgs</build_depend>
  17 
  18   <exec_depend>roscpp</exec_depend>
  19   <exec_depend>rospy</exec_depend>
  20   <exec_depend>std_msgs</exec_depend>
  21 
  22 </package>