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

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

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

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

ROS 2 カスタムメッセージをはじめて使用する場合は、ROS Toolbox システム要件を確認してください。

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

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

メモ

ROS Toolbox では、任意の時点で MATLAB パス上に複数のカスタムメッセージフォルダーが存在できます。これらのフォルダーには複数のカスタムメッセージパッケージを含めることができます。

msg フォルダーには、すべてのカスタムメッセージタイプ定義が含まれています。また、srv フォルダーには、すべてのカスタムサービスタイプ定義を追加し、action フォルダーにはすべてのカスタムアクションタイプ定義を追加する必要があります。たとえば、パッケージ matlab_msg_gen のフォルダーとファイルの構造は次のとおりです。

Custom message folder structure. The top level package ros2CustomMessages contains three folders- msg, srv, and action which contain the generated custom messages, services and actions respectively.

このパッケージでは、1 つのカスタムメッセージタイプが Num.msg に含まれ、1 つのカスタムサービスタイプが AddTwoInts.srv に含まれ、1 つのカスタムアクションタイプが Test.action に含まれています。MATLAB はこれらのファイルを使用して、パッケージに含まれるカスタムメッセージを使用するために必要なファイルを生成します。msg ファイルおよび srv ファイルの作成の詳細については、ROS 2 のドキュメンテーションの Creating ROS 2 msg and srv を参照してください。

メモ

ROS 2 用に生成されるカスタムメッセージライブラリは、内部の ROS ワークフローに統合されるユーザー作成のファイルです。これらのファイルを未承認のアクセスから守り、システムの整合性を維持するには、対象とするユーザーアカウントのみにアクセスを制限するように適切なディレクトリの権限を設定します。

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

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

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

ros2genmsg 関数によってこれらのファイルが作成された後、関数ファイルを MATLAB パスに追加しなければなりません。これらの手順は、MATLAB コマンドウィンドウのプロンプトとして示されます。ros2 msg list または ros2message 関数を使用して、新しいカスタムメッセージが使用可能であることを検証します。

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

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

ファイルのディレクトリが含まれる MATLAB パスを維持しなければなりません。

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

カスタムメッセージタイプ、カスタムサービスタイプ、およびカスタムアクションタイプを ROS 2 Simulink^® ブロックおよび MATLAB 関数とともに使用して、スタンドアロン ROS 2 ノード用の C++ コードを生成できます。生成されたコード (.tgz アーカイブ) には、カスタムメッセージ定義および ROS 2 カスタムメッセージパッケージが含まれます。生成されたコードが生成先の Linux システム内でビルドされると、それによってカスタムメッセージパッケージが colcon ワークスペースで自動的に使用可能になります。

アプリケーション用にカスタムメッセージ定義を MATLAB で変更した場合は、生成先の Linux システム上のカスタムメッセージパッケージを削除し、C++ コードを再生成して、再展開する必要があります。

組み込みメッセージ定義のカスタム定義との置き換え

MATLAB は、多くの組み込み ROS 2 メッセージタイプを提供しています。これらのメッセージタイプの定義を、上記で詳述した同じカスタムメッセージ作成ワークフローを使用して、新しい定義と置き換えることができます。組み込みのメッセージパッケージの定義を置き換える場合は、カスタムメッセージパッケージフォルダーに、対応する組み込みメッセージパッケージのすべてのメッセージタイプに対する新しい定義 (.msg ファイル) が含まれていることを確認する必要があります。

参考

ros2genmsg | rosgenmsg