自作メッセージ

これまで使ってきたメッセージの型は誰かが既に定義したものを使っていました。 ですが、使っているロボットなどに応じて独自のメッセージを定義して、トピック通信やサービス通信、アクション通信に使うことも可能です。

今回作ったメッセージファイルは以降の トピック通信サービス通信アクション通信 の講義で使うので、この部分は飛ばさないようにお願いします。

パッケージの作成

ros2 pkg create --build-type ament_cmake hello_msgs

メッセージの定義

.msgファイル

.msgファイルの形式は以下のようになっています。

型 foo
型 bar

トピック通信で使うメッセージファイルはパッケージのmsgフォルダで.msgファイルで定義します。

mkdir msg

msg/Person.msgを以下の内容で保存してください。

string name
uint8 age

.srvファイル

.srvファイルの形式は以下のようになっています。

型 request
---
型 response

---より上の部分はサービスサーバに送るもので、下の部分はサービスサーバから送られてくるものです。 今回は送受信するメッセージをそれぞれ1つしか定義していませんが、複数定義することも出来ます。

サービス通信で使うメッセージファイルはパッケージのsrvフォルダで.srvファイルで定義します。

mkdir srv

srv/Order.srvを以下の内容で保存してください。

string menu
---
string message

.actionファイル

.actionファイルの形式は以下のようになっています。

型 goal
---
型 result
---
型 feedback

goalの部分はアクションサーバに送るもので、resultの部分はアクションサーバかた送られてくるものです。 下のfeedbackの部分はresultが送られるまでの間に途中経過としてアクションサーバから送られてくるものです。

アクション通信で使うメッセージファイルはパッケージのactionフォルダで.actionファイルで定義します。

mkdir action

action/Sum.actionを以下の内容で保存してください。

uint64 goal
---
uint64 sum
---
uint64 tmp_sum

CMakelists.txtの編集

CMakelists.txtに以下を追加してください。

find_package(rosidl_default_generators REQUIRED)

rosidl_generate_interfaces(${PROJECT_NAME}
  "msg/Person.msg"
  "srv/Order.srv"
  "action/Sum.action"
)

最終的に以下のようなCMakelists.txtになります。

cmake_minimum_required(VERSION 3.8)
project(hello_msgs)

if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  add_compile_options(-Wall -Wextra -Wpedantic)
endif()

# find dependencies
find_package(ament_cmake REQUIRED)
# uncomment the following section in order to fill in
# further dependencies manually.
# find_package(<dependency> REQUIRED)
find_package(rosidl_default_generators REQUIRED)

rosidl_generate_interfaces(${PROJECT_NAME}
  "msg/Person.msg"
  "srv/Order.srv"
  "action/Sum.action"
)

if(BUILD_TESTING)
  find_package(ament_lint_auto REQUIRED)
  # the following line skips the linter which checks for copyrights
  # comment the line when a copyright and license is added to all source files
  set(ament_cmake_copyright_FOUND TRUE)
  # the following line skips cpplint (only works in a git repo)
  # comment the line when this package is in a git repo and when
  # a copyright and license is added to all source files
  set(ament_cmake_cpplint_FOUND TRUE)
  ament_lint_auto_find_test_dependencies()
endif()

ament_package()

package.xmlの編集

以下をpackage.xmlに追加して依存関係を定義してください。

<buildtool_depend>rosidl_default_generators</buildtool_depend>
<exec_depend>rosidl_default_runtime</exec_depend>
<member_of_group>rosidl_interface_packages</member_of_group>

最終的に以下のようなpackage.xmlになります。

<?xml version="1.0"?>
<?xml-model href="http://download.ros.org/schema/package_format3.xsd" schematypens="http://www.w3.org/2001/XMLSchema"?>
<package format="3">
  <name>hello_msgs</name>
  <version>0.0.0</version>
  <description>TODO: Package description</description>
  <maintainer email="ri-one@todo.todo">ri-one</maintainer>
  <license>TODO: License declaration</license>

  <buildtool_depend>ament_cmake</buildtool_depend>

  <test_depend>ament_lint_auto</test_depend>
  <test_depend>ament_lint_common</test_depend>

  <!-- この3行を追加 -->
  <buildtool_depend>rosidl_default_generators</buildtool_depend>
  <exec_depend>rosidl_default_runtime</exec_depend>
  <member_of_group>rosidl_interface_packages</member_of_group>

  <export>
    <build_type>ament_cmake</build_type>
  </export>
</package>

ビルド

cd ~/my_ws
colcon build
source install/setup.bash

ros2 interface showコマンドで作ったメッセージの型を確認しましょう。

$ ros2 interface show hello_msgs/msg/Person 
string name
uint8 age
$ ros2 interface show hello_msgs/srv/Order
string menu
---
string message
$ ros2 interface show hello_msgs/action/Sum 
uint64 goal
---
uint64 sum
---
uint64 tmp_sum

参照