ROS系列四:建立ROS程式包
目錄
一個catkin程式包由什麼組成?
一個程式包要想稱為catkin程式包必須符合以下要求：
-
該程式包必須包含catkin compliant package.xml
檔案- 這個package.xml檔案提供有關程式包的元資訊。
-
程式包必須包含一個catkin 版本的CMakeLists.txt檔案，而Catkin metapackages中必須包含一個對CMakeList.txt檔案的引用。
- 每個目錄下只能有一個程式包。
- 這意味著在同一個目錄下不能有巢狀的或者多個程式包存在。
最簡單的程式包也許看起來就像這樣：
-
my_package/ CMakeLists.txt package.xml
在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程式包
本部分教程將演示如何使用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) There is a bug reported and already fixed in rospack in groovy, which takes sometime until the change gets reflected on your computer. If you see a similar issue like this with the next command, you can skip to the next command.
$ 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) There is a bug reported and already fixed in rospack in groovy, which takes sometime until the change gets reflected on your computer. If you see a similar issue like this with the next command, you can skip to the next command.
$ 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檔案以及每一個需要你注意的標籤元素。
描述標籤
首先更新描述標籤：
5 <description>The beginner_tutorials package</description>
將描述資訊修改為任何你喜歡的內容，但是按照約定第一句話應該簡短一些，因為它覆蓋了程式包的範圍。如果用一句話難以描述完全那就需要換行了。
維護者標籤
接下來是維護者標籤：
7 <!-- One maintainer tag required, multiple allowed, one person per tag --> 8 <!-- Example: --> 9 <!-- <maintainer email="[email protected]">Jane Doe</maintainer> --> 10 <maintainer email="[email protected]">user</maintainer>
這是package.xml中要求填寫的一個重要標籤，因為它能夠讓其他人聯絡到程式包的相關人員。至少需要填寫一個維護者名稱，但如果有需要的話你可以新增多個。除了在標籤裡面填寫維護者的名稱外，還應該在標籤的email屬性中填寫郵箱地址：
7 <maintainer email="[email protected]">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 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>
最後完成的 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="[email protected]">Your Name</maintainer> 8 <license>BSD</license> 9 <url type="website">http://wiki.ros.org/beginner_tutorials</url> 10 <author email="[email protected]">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>
自定義 CMakeLists.txt
到此，這個包含程式包元資訊的package.xml檔案已經按照需要完成了裁剪整理，現在你可以繼續下面的教程了。catkin_create_pkg命令生成的CMakeLists.txt檔案將在後續關於編譯ROS程式程式碼的教程中講述。
現在你已經建立了一個新的ROS程式包，接下來我們開始編譯這個程式包