< >
Home » ROS入门教程 » ROS入门教程-1.1.3 创建ROS程序包

ROS入门教程-1.1.3 创建ROS程序包

ROS入门教程-创建ROS程序包

说明：

  • 本教程介绍如何使用roscreate-pkg或catkin创建一个新程序包,并使用rospack查看程序包的依赖关系。

针对CATKIN方式

目录

  • 1.一个catkin程序包由什么组成?
  • 2.在catkin工作空间中的程序包
  • 3.创建一个catkin程序包
  • 4.程序包依赖关系
  • 5.一级依赖
  • 6.间接依赖
  • 7.自定义你的程序包
  • 8.自定义 package.xml
  • 9.描述标签
  • 10.维护者标签
  • 11.许可标签
  • 12.依赖项标签
  • 13.最后完成的 package.xml
  • 14.自定义 CMakeLists.txt

一个catkin程序包由什么组成?

  • 一个程序包要想称为catkin程序包必须符合以下要求：

    • 1.该程序包必须包含catkin compliant package.xml文件，这个package.xml文件提供有关程序包的元信息。

    • 2.程序包必须包含一个catkin 版本的CMakeLists.txt文件，而Catkin metapackages中必须包含一个对CMakeList.txt文件的引用。

    • 3.每个目录下只能有一个程序包。这意味着在同一个目录下不能有嵌套的或者多个程序包存在。

  • 最简单的程序包也许看起来就像这样：

my_package/
  CMakeLists.txt
  package.xml

在catkin工作空间中的程序包

  • 开发catkin程序包的一个推荐方法是使用catkin工作空间，但是你也可以单独开发(standalone)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程序包

  • 本部分教程将演示如何使用catkin_create_pkg命令来创建一个新的catkin程序包以及创建之后都能做些什么。
  • 首先切换到之前通过创建catkin工作空间教程创建的catkin工作空间中的src目录下：
# You should have created this in the Creating a Workspace Tutorial
$ cd ~/catkin_ws/src
  • 现在使用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命令会要求你输入package_name，如果有需要你还可以在后面添加一些需要依赖的其它程序包：

# This is an example, do not try to run this
# catkin_create_pkg <package_name> [depend1] [depend2] [depend3]
  • catkin_create_pkg命令也有更多的高级功能，这些功能在catkin/commands/catkin_create_pkg中有描述。

程序包依赖关系

一级依赖

  • 之前在使用catkin_create_pkg命令时提供了几个程序包作为依赖包
  • 现在我们可以使用rospack命令工具来查看一级依赖包。
  • (Jan 9, 2013)groovy版本的rospack 有个已经修复的BUG报告，它会可能要花时间显示包依赖。
  • 如果你看到类似问题，可以忽略如下命令：
$ rospack depends1 beginner_tutorials
  • 效果：
std_msgs
rospy
roscpp
  • 就像你看到的rospack列出了在运行catkin_create_pkg命令时作为参数的依赖包
  • 这些依赖包随后保存在package.xml文件中。
$ roscd beginner_tutorials
$ cat package.xml
  • 效果：
<package>
...
  <buildtool_depend>catkin</buildtool_depend>
  <build_depend>roscpp</build_depend>
  <build_depend>rospy</build_depend>
  <build_depend>std_msgs</build_depend>
...
</package>

间接依赖

  • 在很多情况中，一个依赖包还会有它自己的依赖包，比如rospy还有其它依赖包。
  • (Jan 9, 2013)groovy版本的rospack 有个已经修复的BUG报告，它会可能要花时间显示包依赖。
  • 如果你看到类似问题，可以忽略如下命令：
$ rospack depends1 rospy
  • 效果：
genpy
rosgraph
rosgraph_msgs
roslib
std_msgs
  • 一个程序包还可以有好几个间接的依赖包，幸运的是使用rospack可以递归检测出所有的依赖包。
  • 例如：
$ rospack depends beginner_tutorials
  • 效果：
cpp_common
rostime
roscpp_traits
roscpp_serialization
genmsg
genpy
message_runtime
rosconsole
std_msgs
rosgraph_msgs
xmlrpcpp
roscpp
rosgraph
catkin
rospack
roslib
rospy

自定义你的程序包

  • 本部分教程将剖析catkin_create_pkg命令生成的每个文件并详细描述这些文件的组成部分以及如何自定义这些文件。

自定义 package.xml

  • 自动生成的package.xml文件应该在你的新程序包中。
  • 现在让我们一起来看看新生成的package.xml文件以及每一个需要你注意的标签元素。

描述标签

  • 首先更新描述标签：
<description>The beginner_tutorials package</description>
  • 将描述信息修改为任何你喜欢的内容，但是按照约定第一句话应该简短一些，因为它覆盖了程序包的范围。
  • 如果用一句话难以描述完全那就需要换行了。

维护者标签

  • 接下来是维护者标签：
   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>

许可标签

  • 再接下来是许可标签，同样的也需要：
  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中阅读其中的若干个许可协议的相关信息。
  • 对于本教程我们将使用BSD协议，因为ROS核心组件的剩余部分已经使用了该协议：
   8   <license>BSD</license>

依赖项标签

  • 接下来的标签用来描述程序包的各种依赖项，这些依赖项分为:
build_depend
buildtool_depend
run_depend
test_depend
  • 关于这些标签的更详细介绍请参考Catkin Dependencies相关的文档。
  • 在之前的操作中，因为我们将std_msgs、roscpp、rospy作为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 run_depend for packages you need at runtime: -->
  35   <!--   <run_depend>python-yaml</run_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   <run_depend>roscpp</run_depend>
  19   <run_depend>rospy</run_depend>
  20   <run_depend>std_msgs</run_depend>

最后完成的 package.xml

  • 现在看下面最后去掉了注释和未使用标签后的package.xml文件就显得更加简洁了：
   1 <?xml version="1.0"?>
   2 <package>
   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   <run_depend>roscpp</run_depend>
  19   <run_depend>rospy</run_depend>
  20   <run_depend>std_msgs</run_depend>
  21 
  22 </package>

自定义 CMakeLists.txt

  • 到此，这个包含程序包元信息的package.xml文件已经按照需要完成了裁剪整理，现在你可以继续下面的教程了。
  • catkin_create_pkg命令生成的CMakeLists.txt文件将在后续关于编译ROS程序代码的教程中讲述。

针对rosbuild方式

目录

  • 1.使用roscreate
  • 2.创建新的ROS包
  • 3.直接包依赖
  • 4.间接包依赖
  • 5.ROS 客户端库
  • 6.回顾

使用roscreate

  • 在我们创建包之前，看看roscreate-pkg命令行工具，它会创建新的ROS包

  • 所有的ROS包有类似文件结构：manifests, CMakeLists.txt, mainpage.dox, and Makefiles

  • roscreate-pkg创建方法消除手工创建新的包很多繁琐的工作，消除了常见的错误(如：用手打字建立文件和表现引起的)。

  • 创建新包在目前的目录：

# roscreate-pkg [package_name]
  • 你能指定包的依赖：
# roscreate-pkg [package_name] [depend1] [depend2] [depend3]

创建新ROS包

  • 我们打算进入根目录或项目目录，来创建我们的beginner_tutorials包

  • 这个包依赖std_msgs, roscpp, 和rospy

  • 进入 ~/fuerte_workspace/sandbox 目录:

$ cd ~/fuerte_workspace/sandbox
  • 如果是Fuerte以上的版本：
$ roscd
$ cd sandbox
  • 创建包:
$ roscreate-pkg beginner_tutorials std_msgs rospy roscpp
  • 效果:
Creating package directory ~/fuerte_workspace/sandbox/beginner_tutorials
Creating include directory ~/fuerte_workspace/sandbox/beginner_tutorials/include/beginner_tutorials
Creating cpp source directory ~/ros/ros_tutorials/beginner_tutorials/src
Creating python source directory ~/fuerte_workspace/sandbox/beginner_tutorials/src/beginner_tutorials
Creating package file ~/fuerte_workspace/sandbox/beginner_tutorials/Makefile
Creating package file ~/fuerte_workspace/sandbox/beginner_tutorials/manifest.xml
Creating package file ~/fuerte_workspace/sandbox/beginner_tutorials/CMakeLists.txt
Creating package file ~/fuerte_workspace/sandbox/beginner_tutorials/mainpage.dox

  • 请编辑beginner_tutorials/manifest.xml和mainpage.dox，完成创建包。

  • 需要花时间阅读beginner_tutorials/manifest.xml文件

  • 它在ROS系统里起到重要作用，定义了包如何构建，运行和记录

  • 现在需要确保ROS能找到新包，常常在发生变化之后，使用rospack profile识别新目录。

  • 例如：

    $ rospack profile
    $ rospack find beginner_tutorials

  • 效果：

    YOUR_PACKAGE_PATH/beginner_tutorials

  • 如果失败，意味着ROS不能找到新包，那问题可能出在ROS_PACKAGE_PATH

  • 请查阅SVN的安装说明或来自二进制的(依赖你安装的ROS)。

  • 如果你已经创建或增加包在已存在的包路径之外，你需要修改ROS_PACKAGE_PATH环境变量去包含新的位置。

  • 尝试重source你的工作空间的setup.sh

source ~/workspace/devel/setup.sh
  • 尝试移动的包的目录
$ roscd beginner_tutorials 
$ pwd
  • 效果：
YOUR_PACKAGE_PATH/beginner_tutorials

直接依赖

  • 当使用roscreate-pkg，一些包依赖会提供。这些直接依赖通过rospack可以查看
  • (Jan 9, 2013)groovy版本的rospack 有个已经修复的BUG报告，它会可能要花时间显示包依赖。
  • 如果你看到类似问题，可以忽略如下命令：
$ rospack depends1 beginner_tutorials
  • 效果：
std_msgs
rospy
roscpp
  • 正如看到的rospack列出相同的依赖名称(在roscreate-pkg使用的)
  • 这些依赖是存在manifest 文件，浏览manifest.xml
$ roscd beginner_tutorials
$ cat manifest.xml
  • 内容如下：
 <package>

  ...

  <depend package="std_msgs">
  <depend package="rospy">
  <depend package="roscpp">

 </package>

间接依赖

  • 在很多情况下，依赖包也有自己的依赖包
  • 例如：rospy有其他依赖
  • (Jan 9, 2013)groovy版本的rospack 有个已经修复的BUG报告，它会可能要花时间显示包依赖。
  • 如果你看到类似问题，可以忽略如下命令：
$ rospack depends1 rospy
  • 效果：
roslib
roslang
  • 一个包有一些间接依赖，幸运的是rospack可以递归所有的嵌套的依赖
$ rospack depends beginner_tutorials
  • 效果：
rospack
roslib
std_msgs
rosgraph_msgs
rosbuild
roslang
rospy
cpp_common
roscpp_traits
rostime
roscpp_serialization
xmlrpcpp
rosconsole
roscpp
  • 注意：在Fuerte版本，列表更短：
std_msgs
roslang
rospy
roscpp

ROS客户端库

  • 你可能担心之前例子中的rospy和roscppy依赖。
  • rospy和roscpp客户端库.
  • 客户端库允许不同编程语言在ROS中实现通讯
  • rospy是Python的客户端库
  • roscpp是C++的客户端库

回顾

  • 列出使用的命令：
1.roscreate-pkg = ros+create-pkg : 生成ROS包需要的文件
2.rospack = ros+pack(age) : 提供ROS package相关的信息 
3.rosstack = ros+stack  : 提供ROS stack 相关的信息
  • 现在你已经创建了一个新的ROS程序包，接下来我们开始编译这个程序包

纠错,疑问,交流: 请进入讨论区或 点击加入Q群

获取最新文章: 扫一扫右上角的二维码加入“创客智造”公众号


标签: ros程序包