ROS カスタムメッセージのサポート

カスタムメッセージの概要

カスタムメッセージは、ROS Toolbox で現在サポートされているメッセージタイプのセットの拡張に使用できる、ユーザー定義のメッセージです。サポートされているメッセージタイプを送受信する場合は、カスタムメッセージを使用する必要はありません。サポートされているメッセージタイプのリストを表示するには、MATLAB^® コマンドウィンドウで rosmsg list を呼び出します。

カスタムメッセージの作成には ROS パッケージが必要です。ROS パッケージの詳細については、ROS Wiki の Packages で説明しています。カスタムメッセージ用の有効な ROS パッケージがあることを確認したら、カスタムメッセージパッケージへのファイルパスを指定して rosgenmsg を呼び出し、カスタムメッセージの使用に必要な MATLAB コードを生成します。MATLAB で ROS カスタムメッセージを生成する方法の例については、ROS パッケージからのカスタムメッセージの作成を参照してください。

ROS カスタムメッセージをはじめて使用する場合は、ROS System Requirementsを確認してください。

カスタムメッセージの内容

ROS カスタムメッセージは、msg および srv ディレクトリを含む ROS パッケージフォルダー内に指定されます。

メモ

どの時点でも、MATLAB パス上のカスタムメッセージフォルダーは 1 つのみでなければなりません。このフォルダーには複数のパッケージを含めることができます。すべてのパッケージを 1 つの固有のフォルダーに維持することを推奨します。

msg フォルダーには、すべてのカスタムメッセージタイプ定義が含まれています。また、srv フォルダーには、すべてのカスタムサービスタイプ定義を追加しなければなりません。たとえば、パッケージ custom_robot_msgs のフォルダーとファイルの構造は次のとおりです。

このパッケージでは、1 つのカスタムメッセージタイプが RobotTopic.msg に含まれ、1 つのカスタムサービスタイプが RobotService.srv に含まれています。MATLAB はこれらのファイルを使用して、パッケージに含まれるカスタムメッセージを使用するために必要なファイルを生成します。msg および srv ファイル作成の詳細については、ROS Wiki の Creating a ROS msg and srv と Defining Custom Messages を参照してください。これらのファイルの構文は、msg と srv についてのページで説明されています。

メモ

カスタムメッセージフォルダーに対する書き込みアクセス権限がなければなりません。
どの時点でも、MATLAB パス上のカスタムメッセージフォルダーは 1 つのみでなければなりません。このフォルダーには複数のパッケージを含めることができます。すべてのパッケージを 1 つの固有のフォルダーに維持することを推奨します。
ROS アクションはサポートされておらず、カスタムメッセージ生成の際に無視されます。

メッセージフィールドからのプロパティの命名

ROS メッセージ定義が MATLAB に変換されると、フィールド名がメッセージオブジェクトのプロパティに変換されます。オブジェクトプロパティは常に大文字で始まり、アンダースコアは含まれません。フィールド名はこの命名規則に従って変更されます。最初の文字と、アンダースコアの直後の文字が大文字になり、アンダースコアは削除されます。たとえば、sensor_msgs/Image メッセージには、ROS では次のフィールドがあります。

header
height
width
encoding
is_bigendian
step
data

変換された MATLAB プロパティは次のようになります。

Header
Height
Width
Encoding
IsBigendian
Step
Data

これは、ROS メッセージを Simulink^® で使用するときにも反映されます。ROS メッセージバスは、MATLAB と同じプロパティ名を使用します。

カスタムメッセージ作成ワークフロー

前の節で説明したとおりにカスタムメッセージ構造を設定したら、これらのカスタムメッセージを使用するために必要なコードを作成できます。まず、カスタムメッセージファイルへの既知のパスを使用して rosgenmsg を呼び出し、MATLAB コードを作成します。

関数 rosgenmsg は、カスタムメッセージファイル (.msg および .srv) を取り、それぞれのメッセージタイプを、動作する MATLAB コードに変換します。関数 rosgenmsg は msg フォルダーで .msg ファイルを検索し、srv フォルダーで .srv ファイルを検索します。このコードは、新しいカスタムメッセージを作成するときにメッセージプロパティを定義するクラスのグループです。この関数によって、さまざまなメッセージクラスに必要な MATLAB M ファイルが作成されます。

関数 rosgenmsg によってこれらのファイルが作成された後、クラスファイルを MATLAB パスに追加しなければなりません。これらの手順は、MATLAB コマンドウィンドウのプロンプトとして示されます。

クラスファイルの場所を MATLAB パスに追加: addpath を使用して、.m 拡張子のファイルの新しい場所を MATLAB パスに追加し、savepath を使用して変更を保存します。
すべてのメッセージクラス定義を更新します。これには、以下のとおりワークスペースをクリアする必要があります。
```
clear classes
rehash toolboxcache
```
メッセージが使用可能であることを確認: rosmsg list または関数 rosmessage を使用して、新しいカスタムメッセージが使用可能であることを確認します。

この手順の例については、ROS パッケージからのカスタムメッセージの作成を参照してください。この例では、サンプルカスタムメッセージファイルを使用して MATLAB でカスタムメッセージを作成しています。

この手順は、カスタムメッセージの特定のセットに対して 1 回だけ実行する必要があります。その後、新しいカスタムメッセージを MATLAB の他の ROS メッセージと同様に使用し、ROS Toolbox が提供する ROS のフル機能を活用することができます。メッセージタイプを更新する場合や、新しいメッセージタイプを作成する場合は、この生成手順を繰り返します。

ファイルのディレクトリが含まれる MATLAB パスを維持しなければなりません。MATLAB パスに、カスタムメッセージアーティファクトが含まれるフォルダーが一度に 1 つだけ存在することを確認してください。

カスタムメッセージを使用したコード生成

カスタムメッセージタイプとカスタムサービスタイプを ROS Simulink ブロックとともに使用して、スタンドアロン ROS ノード用の C++ コードを生成できます。生成されたコード (.tgz archive) には、カスタムメッセージの Simulink 定義が含まれますが、ROS カスタムメッセージパッケージは含まれません。生成されたコードが生成先の Linux システム内でビルドされる際には、カスタムメッセージパッケージが catkin ワークスペースまたは ROS_PACKAGE_PATH 上で使用できる必要があります。生成されたコードをビルドする前に、Linux システムにカスタムメッセージパッケージを確実にインストールまたはコピーします。

参考

ros2genmsg | rosgenmsg