Description: This tutorial covers using roscreate-pkg or catkin to create a new package, and rospack to list package dependencies.
这一篇是要讲怎么创建一个package,并且用rospack去列举他们的依赖关系。
1 怎样建造一个package
-首先它需要包含一个catkin compliant package.xml文件。这个文件包含了包的元信息。
-还需要包含一个相关引用的文件CMakeLists.txt
-文件夹里只能有一个package
所以最简单的包看起来应该是下面这个样子:
my_package/
CMakeLists.txt
package.xml
#2 catkin 工作空间里的包
推荐的与catkin package工作的方式是使用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的工作空间
这个前面已经做过了。在中间还说到即使是个空包也可以build,忘记了就往前翻翻或者点击链接看看官方教程。
3 建立一个catkin Package
我们将会利用catkin_create_pkg脚本去建立一个catkin包,之后看接着可以用它做什么。
首先切换到之前建立的工作空间中:
cd ~/catkin_ws/src
现在可以使用 catkin_create_pkg脚本新建一个新的package名叫beginner_tutorials依赖于* std_msgs,roscpp, 和 rospy*:
$ catkin_create_pkg beginner_tutorials std_msgs rospy roscpp
这条命令会创建出包含beginner_tutorials和 CMakeLists.txt的一个文件夹 beginner_tutorials,它部分的依赖于我们在catkin_create_pkg 中给他的信息。
catkin_create_pkg 使用时需要提供一个package名称,和一个依赖关系列表,形式如下:
This is an example, do not try to run this
catkin_create_pkg <package_name> [depend1] [depend2] [depend3]
catkin_create_pkg 还有更多高级功能,可以[点击查看](http://wiki.ros.org/catkin/commands/catkin_create_pkg)
#4 编译一个catkin工作区和找到设置文件
现在编译catkin工作区的package:
$ cd ~/catkin_ws
$ catkin_make
编译(build)之后,会在工作区devel下级目录建立一个跟之前经常在/opt/ros/$ROSDISTRO_NAME下面相似的结构。
为了把工作区加入到ROS环境中,我们需要找到生成的设置文件在哪里。
执行命令:
`$ . ~/catkin_ws/devel/setup.bash`
#5 package 依赖关系
##5.1 第一级依赖
在之前使用xatkin_creat_pkg的时候,一些依赖关系就已经生成了,我们可以看一下这个生成的第一级依赖关系:
`$ rospack depends1 beginner_tutorials `
std_msgs
rospy
roscpp
rospack列举出的这些东西,跟我们使用catkin_create_pkg创建package的时候使用的参数是一样的。这些package的依赖关系存储在package.xml文件里:
$ roscd beginner_tutorials
$ cat package.xml
打开看一下就是下面这样:
<?xml version="1.0"?>
<package>
<name>beginner_tutorials</name>
<version>0.0.0</version>
<description>The beginner_tutorials package</description>
<maintainer email="qkingros@todo.todo">qkingros</maintainer>
<license>TODO</license>
<buildtool_depend>catkin</buildtool_depend>
<build_depend>roscpp</build_depend>
<build_depend>rospy</build_depend>
<build_depend>std_msgs</build_depend>
<run_depend>roscpp</run_depend>
<run_depend>rospy</run_depend>
<run_depend>std_msgs</run_depend>
<export>
</export>
</package>
##5.2 间接依赖
在很多情况下,一个依赖也有自己的依赖。例如,*rospy*就有其他的依赖。
`$ rospack depends1 rospy`
genpy
roscpp
rosgraph
rosgraph_msgs
roslib
std_msgs
一个包可以有很多依赖关系,还好*rospack*可以递归的确定所有镶套的依赖项。
`$ rospack depends beginner_tutorials`
cpp_common
rostime
roscpp_traits
roscpp_serialization
catkin
genmsg
genpy
message_runtime
gencpp
geneus
gennodejs
genlisp
message_generation
rosbuild
rosconsole
std_msgs
rosgraph_msgs
xmlrpcpp
roscpp
rosgraph
rospack
roslib
rospy
#6 定制你自己的包
这一部分教程将会一步一步的介绍之前创建的包,告诉你怎么去定制自己的包。
##6.1 定制 *package.xml*
现在将会详细浏览介绍原始生成的package.xml,看看哪里可以改。
`ls`一下就可以看到package.xml,打开它。
`vim package.xml `
如果提示这个:
The program 'vim' can be found in the following packages:
- vim
- vim-gnome
- vim-tiny
- vim-athena
- vim-athena-py2
- vim-gnome-py2
- vim-gtk
- vim-gtk-py2
- vim-gtk3
- vim-gtk3-py2
- vim-nox
- vim-nox-py2
Try: sudo apt install <selected package>
如果提示这个不要害怕,仅仅是因为vim没有安装,安装一下vim:
`$ sudo apt-get install vim`
现在就可以打开了。
为了防止自己不小心修改了package.xml,也可以使用
`cat package.xml`打开。
###6.1.1 描述标签
首先更新描述标签:
`<description>The beginner_tutorials package</description>`
这个就是描述,可以随便修改。
###6.1.2 maintainer 标签
接下来就是maintainer标签
<maintainer email="qkingros@todo.todo">qkingros</maintainer>
这是一个必须的并且重要的标签,他让其他人知道谁联系着这个package,也就是哪个人跟这个package有关系。至少要有一个此标签,当然这个意思就是也可以有多个。维护者的名字就是主体,还要放置在标签里他的email。如果我开心,也可以这样写,其实本来就该这样写:
<maintainer email="jiukui_y@foxmail.com">Savior2016</maintainer>
###6.1.3 许可标签
<license>TODO</license>
我们可以选择一个许可协议放在这里,常见的开源许可比如BSD,MIT等等。可以在[开源倡议](https://opensource.org/licenses/alphabetical)里面了解多种开源许可。
我们就是用BSD,因为ROS用的这个。
###6.1.4 依赖标签
<buildtool_depend>catkin</buildtool_depend>
<build_depend>roscpp</build_depend>
<build_depend>rospy</build_depend>
<build_depend>std_msgs</build_depend>
<run_depend>roscpp</run_depend>
<run_depend>rospy</run_depend>
<run_depend>std_msgs</run_depend>
依赖标签分成 build_depend, buildtool_depend, run_depend, test_depend.
详细的介绍可以看[Catkin Dependencies](http://wiki.ros.org/catkin/package.xml#Build.2C_Run.2C_and_Test_Dependencies)
因为我们是依据roscpp,rospy,std_msgs创建的,所以会有build_depend,如果要依赖他们运行,就要有run_depend标签,上面已经有了,没有的话要自己添加。
###6.1.5 package.xml的结尾
*没有什么乱七八糟没用的东西,很简洁。*官网是这么说的,然鹅现在已经有了。
<export>
</export>
这里包含没有指定的标签,其他工具可以被放在这里请求更多信息。
##6.2 定制CMakeLists.txt
下一节再讲。