Pynote

Python、機械学習、画像処理について

ROS - package.xml について

概要

package.xml はパッケージの名前、バージョン、作者などの情報が記載された XML ファイルである。
catkin 形式のパッケージのルートディレクトリに配置しなければならない。

試した環境

XMLのサンプル

catkin_create_pkg で作成される雛形は以下である。

catkin_create_pkg sample roscpp rospy std_msgs
<?xml version="1.0"?>
<package>
  <name>sample</name>
  <version>0.0.0</version>
  <description>The sample package</description>

  <!-- One maintainer tag required, multiple allowed, one person per tag -->
  <!-- Example:  -->
  <!-- <maintainer email="jane.doe@example.com">Jane Doe</maintainer> -->
  <maintainer email="root@todo.todo">root</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/sample</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 build_depend for packages you need at compile time: -->
  <!--   <build_depend>message_generation</build_depend> -->
  <!-- Use buildtool_depend for build tool packages: -->
  <!--   <buildtool_depend>catkin</buildtool_depend> -->
  <!-- Use run_depend for packages you need at runtime: -->
  <!--   <run_depend>message_runtime</run_depend> -->
  <!-- Use test_depend for packages you need only for testing: -->
  <!--   <test_depend>gtest</test_depend> -->
  <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>


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

  </export>
</package>

タグの意味

name (必須)

パッケージ名を記載する。

<name>sample</name>

version (必須)

パッケージのバージョンを Major.Minor.Patch で記載する。

<version>0.0.0</version>
version の付け方

StackVersionPolicy - ROS Wiki に参考例が載っている。

  • 0.1: 実験的
  • 0.2-0.3: 不安定版
  • 0.4-0.8: 安定版
  • 0.9: リリース候補
  • 1.0: リリース版
    • レビューやAPIの整備が完了していること
  • バージョン1以降
    • 安定版と開発版を交互にリリースしていく (例: 1.1 安定版、1.2 開発版...)

description (必須)

パッケージの説明を記載する。

<description>The sample package</description>

maintainer (必須)

パッケージの開発者を記載する。複数指定可。
email 属性でメールアドレスを設定できる。

<maintainer email="jane.doe@example.com">Jane Doe</maintainer>

license

パッケージのライセンスを記載する。複数指定可。(例: GPL, BSD, MIT)

<license>MIT</license>

url

パッケージに関連するウェブサイトを記載する。複数指定可。
type 属性で website, bugtracker, repository のいずれかを指定できる。

<url type="website">http://wiki.ros.org/sample</url>

author

パッケージの著者を指定する。複数指定可。
email 属性でメールアドレスを設定できる。

<author email="root@todo.todo">
maintainer と author の違い

maintainer は現在開発に関与している人。
author は開発に関与したことがある人。
上記2つは一致している必要はない。

buildtool_depend

使用するビルドシステムを記載する。通常 catkin を指定すればよい。

<buildtool_depend>catkin</buildtool_depend>

build_depend

ビルドに必要な依存パッケージを記載する。複数指定可。

<build_depend>message_generation</build_depend>

run_depend

実行に必要な依存パッケージを記載する。複数指定可。

<run_depend>message_runtime</run_depend>

test_depend

テストに必要な依存パッケージを記載する。複数指定可。

<test_depend>message_runtime</test_depend>