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

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

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

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

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

ROS カスタムメッセージは、ROS パッケージフォルダー内に指定されます。このフォルダーには package.xml ファイルと、オプションの msg および srv ディレクトリが含まれています。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 についてのページで説明されています。

すべてのパッケージでは、package.xml ファイルを定義しなければなりません。このファイルの内容は次のとおりです。

名前 — custom_robot_msgs
バージョン — 1.1.01
依存関係 — message_generation
メッセージパッケージに対するその他の依存関係 (オプション) — geometry_msgs、std_msgs

以下に、前述の内容が含まれる package.xml のサンプルファイルを示します。

<package>
	<name>custom_robot_msgs</name>
	<version>1.1.01</version>
	
	<build_depend>message_generation</build_depend>
	<build_depend>geometry_msgs</build_depend>
	<build_depend>std_msgs</build_depend>
</package>

メモ

カスタムメッセージフォルダーに対する書き込みアクセス権限がなければなりません。
どの時点でも、MATLAB パス上のカスタムメッセージフォルダーは 1 つのみでなければなりません。このフォルダーには複数のパッケージを含めることができますが、すべてのパッケージを 1 つの固有のフォルダーに維持することを推奨します。
ROS アクションは現在サポートされておらず、カスタムメッセージ生成の際に無視されます。
次の両方の条件が満たされている場合、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 によって 2 つの主な作成手順が処理されます。この関数はカスタムメッセージファイル (.msg、.srv、package.xml) を取り、それぞれのメッセージタイプを、動作する MATLAB コードに変換します。関数 rosgenmsg は msg フォルダーで .msg ファイルを検索し、srv フォルダーで .srv ファイルを検索します。このコードは、新しいカスタムメッセージを作成するときにメッセージプロパティを定義するクラスのグループです。基本的な手順としては、カスタムメッセージファイルを取り、.jar ファイルに変換してから、各トピックおよびサービスについて MATLAB プログラムを作成します。MATLAB で内部的に使用されるため、.jar ファイルを変更しないでください。

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

ファイルの場所を javaclasspath.txt に追加: 指定されたパスを新しいテキスト行として javaclasspath.txt ファイルに追加します。このファイルが存在しない場合、コマンドウィンドウに、ファイルを作成するように求めるメッセージが表示されます。このテキストファイルは、Java クラスの静的クラスパスを定義します。Java クラスパスの詳細については、Java クラスパス (MATLAB)を参照してください。
クラスファイルの場所を MATLAB パスに追加: addpath を使用して、.m 拡張子のファイルの新しい場所を MATLAB パスに追加し、savepath を使用して変更を保存します。
MATLAB を再起動して、メッセージが使用可能であることを確認: MATLAB を再起動してから、rosmsglist または rosmessage を呼び出して、メッセージを意図どおりに使用できることを確認します。

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

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

ファイルのディレクトリが含まれる Java クラスパスと MATLAB パスを維持しなければなりません。MATLAB パスに、カスタムメッセージアーティファクトが含まれるフォルダーが一度に 1 つだけ存在することを確認してください。また、プロンプトの指示に従い、javaclasspath.txt への正しいパスを必ず追加してください。パスを変更しないでください。このファイルは、各 MATLAB セッションの開始時に Java ファイルを読み込むのに使用されます。

カスタムメッセージの共有

カスタムメッセージファイルを作成したら、他のユーザーと共有できます。他のユーザーは、メッセージにアクセスするために rosgenmsg を呼び出す必要はありません。その代わりに、メッセージを共有するには、_matlab_gen フォルダーにアクセスし、前述のパスを指定するための 3 つの手順に従います。ネットワークまたは共有ドライブを介してこれらのファイルへのアクセス権がある場合、javaclasspath.txt ファイルに matlab_gen/jar フォルダーパスを追加し、MATLAB パスに matlab_gen/msggen パスを追加します。MATLAB を再起動すると、他のユーザーが、他の ROS メッセージと同じようにカスタムメッセージを使用できるようになります。

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

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

参考

ros2genmsg | rosAddons | rosgenmsg