• 動作環境
• RTC 作成の流れ (C++ 言語の場合)
• 制限

動作環境

RTCBuilder の動作に必要な環境は以下のとおりです。

また以下の開発を行う言語によっては以下の環境をインストールしておくと便利です。

RTC 作成の流れ (C++ 言語の場合)

• CMake
• Visual Studio(Windows)

また以下のソフトウェアを導入することでドキュメントの生成、インストーラーの生成ができるようになります。

• Doxygen
• WiX(Windows)

1. RTCBuilder のコード生成により ソースコードの雛型と CMake の入力に必要なファイルを出力します。
2. RTCBuilder が生成したコードから CMake により、ユーザーの開発環境にあったビルドファイル(Visual Studio ソリューションファイルや GCC の Unix Makefiles など ) を生成します。
3. CMake によって生成されたビルドファイルとソースコードからコンポーネント(dll や so)を生成します。

制限

RTCBuilder は、OpenRTM-aist を対象に開発されたものです。その他の RTC プラットフォームに対する動作は想定しておりません。

• RTCBuilder のインストール
• RTCBuilder の起動
  • RTC プロファイルエディタの起動

RTCBuilder のインストール

RTCBuilder の起動

インストール後、Eclipse を初めて起動すると、以下のような「ようこそ」画面が表示されます。

この「ようこそ」画面左上の「X」ボタンをクリックすると、以下のページが表示されます。 右上の [Open Perspective] ボタンをクリックし、プルダウンから「その他」を選択します。

「RTC Builder」を選択し、[OK] ボタンをクリックします。

RTCBuilder が起動します。

RTC プロファイルエディタの起動

RTC プロファイルエディタを開くには、ツールバーの [Open New RtcBuilder Editor] ボタンをクリックするか、メニューバーの [ファイル] > [Open New Builder Editor] を選択します。

ツールバーから Open New RtcBuilder Editor	ファイル メニューから Open New Builder Editor

表示された新規プロジェクト作成ダイアログにて、プロジェクト名を入力します｡

ここで作成したプロジェクト配下に RTCBuilder を用いて生成したコード､ RTCProfile などが保存されます｡ プロジェクトは､デフォルトでは使用しているワークスペース配下に(｢ロケーション｣に設定されたディレクトリー内)作成されます｡ 任意の場所にプロジェクトを作成したい場合には､｢デフォルト・ロケーションの使用｣チェックボックスを OFF にし､｢ロケーション｣にて場所を指定してください｡

指定した名称のプロジェクトが生成され、パッケージエクスプローラー内に追加されます。

生成したプロジェクト内には、デフォルト値が設定された RTC プロファイル XML(RTC.xml) が自動的に生成されます。

RTCBuilder では、以下のような画面構成となっています。

• 基本プロファイル入力ページ
• アクティビティ・プロファイル入力ページ
• データポート・プロファイル入力ページ
• サービスポート・プロファイル入力ページ
• コンフィギュレーション・プロファイル入力ページ
• ドキュメント情報設定ページ
• 言語・環境情報入力ページ
• RTC プロファイル XML 編集ページ
• 制約情報の記述方式

ここでは、RTプロファイルエディタについて説明します。

　RTプロファイルエディタは、以下のページから構成されています。

基本プロファイル入力ページ

RTコンポーネントのプロファイル情報など、コンポーネントの基本情報を入力するページです。

以下に各入力項目について説明いたします。

アクティビティ・プロファイル入力ページ

生成対象の RTコンポーネントがサポートしているアクティビティに関する情報を入力するページです。

Documentation セクションの内容は、アクティビティ毎に設定します。Documentation セクションには、選択中のアクティビティに対応した内容が表示されます。
以下に各入力項目について説明いたします。

データポート・プロファイル入力ページ

RTコンポーネントに付属するデータポートの情報を入力するページです。

各ポート (InPort/OutPort) を新規に追加する場合は、各セクションの [Add] ボタンをクリックしてください。 また、各セクションの [Delete] ボタンをクリックすると、選択中のポートを削除することができます。 ドキュメントセクションの内容はポート毎に設定することが可能です。ドキュメントセクションには、選択中のポートに対応した内容が表示されます。 以下に各入力項目について説明いたします。

サービスポート・プロファイル入力ページ

RTコンポーネントに付属するサービスポートの情報を入力するページです。

新規サービスポートは、画面左側「 RT-Component Service Ports 」欄の｢ Add Port ｣を選択することで追加することができます。 画面左側「 RT-Component Service Ports 」にてサービスポートを選択した状態で、｢Add Interface ｣を選択することで新規サービスインターフェースを追加することができます。 画面左側「 RT-Component Service Ports 」にて、サービスポートもしくはサービスインターフェースを選択した状態で [Delete] を選択することで、選択したポート／インターフェースを削除することができます。 以下に各入力項目について説明いたします。

コンフィギュレーション・プロファイル入力ページ

RT コンポーネントに設定するユーザー定義のコンフィギュレーション・パラメーター情報およびその他システムのコンフィギュレーション情報を入力するページです。

ユーザー定義コンフィギュレーション・パラメーター情報およびシステム・コンフィギュレーション情報を新規に追加する場合は、各セクションの [Add] ボタンをクリックしてください。 また、各セクションの [Delete] ボタンをクリックすると、選択中のコンフィギュレーション情報を削除することができます。
Detail セクションおよび Documentation セクションの内容は、ユーザー定義コンフィギュレーション・パラメーター毎に設定することが可能です。 各セクションには、選択中のユーザー定義コンフィギュレーション・パラメーターに設定した内容が表示されます。
以下に各入力項目について説明いたします。

ドキュメント情報設定ページ

生成対象のRTコンポーネントに関する各種ドキュメント情報を入力します。

このページで入力された情報は、生成されたコードに doxygen 形式で埋め込まれます。
以下に各入力項目について説明いたします。

言語・環境情報入力ページ

入力した RT コンポーネント仕様に基づき生成するテンプレート・ソースコードの言語選択や、OS 等の実行環境、依存ライブラリなどを入力するページです。

生成対象の言語ごとにセクションが分かれています。生成したい言語のセクションを選択し、各言語固有の設定情報を入力してください。 あるセクションを選択した場合には、他のセクションは全て閉じるようになっています。 コード生成実行時（基本プロファイル入力ページの [コード生成] ボタンクリック時）に選択されていたセクションの言語用テンプレートコードが生成されます。 以下に各入力項目について説明いたします。

RTC プロファイル XML 編集ページ

入力した RTコンポーネント仕様を記した XML ファイル (RTC.xml) の内容確認、編集を行うページです。 他のページで設定した内容を確認したり、GUI 画面からは入力できない項目を直接編集するために使用します。

表示される RTコンポーネント仕様の内容は、このページに切り替えた時に他ページで設定されている内容を基に作成されます。
画面右上の [Update] ボタンをクリックすると、このページで設定、変更した内容を他のページに反映させることができます (他のページへ反映させるのみで、ファイルへの書き込みは行いません) 。 また、以下のような画面が表示され、変更点を確認することができます。修正内容を他ページへ反映する場合には [OK] をクリックしてください。

このページで直接入力した内容は、このページを表示している状態で保存した場合のみ保存されます。 このページにて内容編集後、他ページを開いた状態で保存すると、他のページにて入力した項目が優先されます。 このページの内容を保存する場合には、RTC.xml のスキーマ定義に従ったバリデーションが行われます。 バリデーション時にエラーが発見された場合は、以下のようなエラーメッセージが表示されますので、表示内容を参考に該当箇所を修正してください。

制約情報の記述方式

データポートおよびユーザ定義コンフィギュレーション・パラメーターへの制約条件は以下の書式で設定します。

• ビルドビューの表示

ビルドビューは作成中の RTコンポーネントの設定内容をグラフィカルに表示するためのビューです。 ビルドビューの表示例を以下に示します。

ビルドビューの表示

｢RTCBuilder｣ パースペクティブ切り替え時にビルドビューが表示されていない場合、以下の手順にて表示することができます。 画面上部のメニューから [ウィンドウ] > [ビューの表示] > [その他] を選択。表示された ｢ビューの表示｣ 画面にて、[OpenRTP Tools] > [BuildView] を選択。

ビルドビューの表示

• コード生成
  • 出力選択
  • パースペクティブ切り替え
• 生成ファイルのパッケージング機能
• 設定内容のセーブとロード
  • セーブ
  • ロード

コード生成

生成対象 RTコンポーネントの各種プロファイル情報を設定した後、テンプレートコードの生成を行います。 基本プロファイル入力ページの [コード生成] ボタンをクリックすると、入力したプロファイル情報に応じたテンプレートコードの生成が行われます。

各言語を選択した際のコード生成実行時に生成されるテンプレートファイルは以下のとおりです。

• C++ ( 「 Use old build environment. 」のチェックボックスを ON しない場合 )

• C++ ( [Use old build environment.] のチェックボックスを ON した場合 )

• Java

• Python

• プリプロセッサにおいて、#include ディレクティブのみ使用可能。（#ifdef などは単に無視される）
• 生成されるオペレーションは直接指定されたインタフェースのオペレーションのみで、親から継承したオペレーションは含まれない。

出力選択

RtcBuilder は、生成したファイルと同名のファイルが出力先に既に存在し、既存ファイルと生成ファイルの間で出力内容に差異が存在する場合、どちらの出力を利用するかを選択する確認画面が表示されます。

• Original ： 既に存在するファイルをそのまま残す
• Merge ： マージブロックを利用したマージを行う（※１）
• Generate ： 新たに生成した内容で上書きする

※１ Mergeでは、<rtc-template block=”block”>タグで囲まれた範囲のみを最新の生成内容で上書します。生成したテンプレートは、ユーザーが変更しない範囲をあらかじめこのタグで囲んでいます。 このタグの中は変更後もマージすることで消えてしまいますので、修正しないようにしてください。

パースペクティブ切り替え

生成対象言語の開発環境用プラグインがインストールされている場合、コード生成実行後にパースペクティブ切り替えの確認メッセージが表示されます。 対象のプラグインがインストールされている場合には以下のようなメッセージが表示されますので、パースペクティブの切り替えを行うかどうかを選択してください。

• Java ： JDT(Java Development Tools) → あらかじめ Eclipse に含まれている開発環境です。
• C++ ： CDT(C/C++ Development Tooling)
• Python ： PyDev

※各言語用の開発環境用プラグインがインストールされており、出力対象プロジェクトが新規作成プロジェクトの場合は、各プロジェクトのプロパティに対象言語の属性が設定されます。

生成ファイルのパッケージング機能

生成したテンプレートファイル、テンプレートファイルを基に作成した RT コンポーネントの実行用バイナリファイルなどを各種形式でアーカイブする機能です。 基本プロファイル入力ページの [パッケージ化] ボタンをクリックすると、パッケージング内容を設定するための「RTコンポーネント パッケージ化」画面が表示されます。

以下、各項目について説明いたします。

※アーカイブ方式(｢ソース｣｢バイナリ｣｢ソース＋バイナリ｣)ごとに、どのファイル種類をアーカイブに含めるかは、後述の｢設定画面｣にて設定することができます。

設定内容のセーブとロード

RTCBuilder では、RTC プロファイルエディタで入力した内容を RTC プロファイル XML(RTC.xml) に保存したり、保存した内容を再度読み込むことが可能です。

セーブ

• エディタを右クリックし、表示されたコンテクストメニューから [Save] もしくは [Save As…] を選択
• メニューバーの [File] > [Save…] もしくは [File] > [Save As…] を選択

※[Save As…] を選んだ場合、任意のプロジェクト内に保存することが可能です。

セーブ

ロード

• エディタを右クリックし、コンテクストメニューから [Open] を選択
• メニューバーの [ファイル] > [ファイルを開く…] を選択
  

ロード

RTC プロファイルエディタで入力、設定した内容を XML形式、 YAML形式で外部ファイルにエクスポート、エクスポートしたファイルをインポートする機能です。 基本プロファイル入力ページの [エクスポート] ボタンをクリックすると、プロファイル情報をエクスポートする先を選択するファイルダイアログが、[インポート] ボタンをクリックすると、インポート元のプロファイル情報を選択するファイルダイアログが表示されます。

　※エクスポート処理時の形式は、｢エクスポート｣ ダイアログの ｢ファイルの種類｣ によって選択することが可能です。

• データ型
• コード生成
• Port
• Configuration
• Export
• Build View
• Document

ここでは RTCBuilder の各種設定について説明します。 RTCBuilder の設定画面は、画面上部メニューの [ウィンドウ] > [設定....] を選択して表示される「設定」画面から ｢RTCBuilder｣ を選択すると表示されます。

データ型

Data Port および Configuration パラメーターで設定するデータ型を定義した IDL ファイルの位置を設定することができます。 IDL 格納ディレクトリーを新規に追加する場合は、[新規] ボタンをクリックしてください。また、[除去] ボタンをクリックすると、選択中の IDL 格納ディレクトリーを削除することができます。 IDL 格納ディレクトリーの実際の位置は、｢IDL File Directories｣ 欄内をクリックして表示されるディレクトリー選択画面にて選択してください。

コード生成

RTC プロファイルエディタの基本プロファイル入力ページおよびコンフィギュレーション・プロファイル入力ページにて新規エディタ表示時、新規項目追加時にデフォルトで設定される内容を設定することができます。

なお、この設定画面中のデフォルト設定([デフォルトの復元] ボタンをクリックした際に設定される内容)は以下のとおりです。

Port

RTC プロファイルエディタのデータポート・プロファイル入力ページおよびサービスポート・プロファイル入力ページにて新規項目を追加した際にデフォルトで設定される内容を設定することができます。

なお、この設定画面中のデフォルト設定([デフォルトの復元] ボタンをクリックした際に設定される内容)は以下のとおりです。

Configuration

RTC プロファイルエディタのコンフィギュレーション・プロファイル入力ページのシステム・コンフィギュレーション情報に表示される項目を設定することができます。

なお、この設定画面中のデフォルト設定([デフォルトの復元] ボタンをクリックした際に設定される内容)は以下のとおりです。

Export

RT コンポーネントのパッケージング機能の各アーカイブ形式に含めるファイルを設定することができます。

設定画面はアーカイブ形式ごとのセクション（Source Export，Binary Export，Source+Binary Export）に分かれています。また、各セクションは拡張子指定部と、ファイル名指定部から構成されています。

拡張子指定部では、各アーカイブ形式に含めるファイルの拡張子を設定することができます。[タイプの選択] ボタンをクリックすると、以下のようなタイプ選択画面が表示されますので、アーカイブに含めたいファイルタイプを選択してください。

※ファイル拡張子リストには登録済みの拡張子のみ表示されます。リスト内に存在しないファイルを選択したい場合は、画面下部の｢他の拡張子｣欄に該当する拡張子を「，」区切りで入力してください。

ファイル設定部ではアーカイブに含めるファイル名を設定することができます。「ファイル名」リスト下部の [Add] ボタンをクリックすると新しい行が追加されますので、アーカイブに含めたいファイル名を直接入力してください。また、[Delete] ボタンをクリックすると、選択している行を削除することができます。 上図の Export 設定画面(セクション)の例では、アーカイブ方式として ｢Source+Binary｣ を選択した際に、拡張子が ｢cpp｣ ｢h」であるファイルと、ファイル名が ｢Makefile｣ ｢README｣ であるファイルをアーカイブに含める設定となります。 なお、この設定画面中のデフォルト設定([デフォルトの復元] ボタンをクリックした際に設定される内容)は以下のとおりです。

Build View

Build View 内に表示されるアイコンの色情報を設定することができます。

それぞれの色設定ボタンにより、コンポーネント本体、DataInPort、DataOutPort、ServicePort、ServiceInterface の色設定を変更することが可能です。

Document

各アクティビティの有効無効属性（ON/OFF）を設定することができます。

• OpenRTP の更新
• 既存のコンポーネントへの反映方法

ここでは、OpenRTP（RTCBuilder、RTSystemEditorの総称）をアップデートする手順を説明します。OpenRTP は Eclipse のプラグインとして提供しているので、Eclipse 上で操作します。

OpenRTP の更新

Eclipse のメニューで、[ヘルプ] > [新規ソフトウエアのインストール] を選択します。

• 名前 : OpenRTP
• ロケーション : http://openrtm.org/pub/openrtp/stable/updates/
  

OpenRTP 1.1.0 をチェックし [次へ] または [完了] ボタンをクリックします。
インストール途中で証明書の信頼についての問い合わせ画面が開きますので、レ点を入れて [OK] ボタンをクリックしてください。

インストール後は指示に従い再始動すると更新が反映されます。

既存のコンポーネントへの反映方法

すでに、生成したコンポーネントのプロジェクトに関しては、次の手順等で対処してください。

• eclipse にもう一度読み込んでコードを再生成します（eclipse 上でいったんプロジェクトを削除し、改めてインポートする）
• eclipse のパッケージ・エクスプローラ画面で、プロジェクト内の RTC.xml をダブルクリックし、[コード生成] ボタンをクリックします
• この時 diff 画面が表示されるので、idl/CMakeLists.txt のみを更新します

Linux や Mac なら単純に sed で置換します。

 $ sed -ie 's/\"\${ALL_IDL_SRCS}\"/ALL_IDL_SRCS/' idl/CMakeLists.txt

Windows でのビルド方法を説明します。

• 環境準備
  • 環境
• ビルド手順
  • Cmake の設定
  • Configure の実行
  • BUILD_DOCUMENTATIONを有効にする
  • Generate の実行
  • VC++ の実行
  • ビルドの実行
• ドキュメント生成手順
  • doxygen の実行
  • ドキュメント
• パッケージ生成手順
  • PACKAGE ビルドの実行
  • パッケージ

環境準備

環境

Wix、Graphvizをインストールしたディレクトリ(C:\Program Files (x86)\WiX Toolset v3.11\bin、C:\Program Files (x86)\Graphviz2.44.1\bin)が環境変数PATHに設定されていない場合は設定してください。

Graphvizはインストール後にプラグインの登録状況を dot -v コマンドで確認して下さい。　手順については こちら のページをご覧ください。

ビルド手順

ビルド手順を示します。 図は VC++ 2017 、CMake 3.14.1 です。

Cmake の設定

GUI 版 Cmake を起動してディレクトリーを指定します。

Configure の実行

[Configure] ボタンをクリックして実行します。その後、使用するプラットフォームを選択します。 例では「Visual Studio 15 2017」を選択しています。

BUILD_DOCUMENTATIONを有効にする

ドキュメント生成のためにBUILD_DOCUMENTATIONオプションを有効にします。

Generate の実行

Configure が正常終了したら、[Generate] ボタンをクリックします。

VC++ の実行

[Open Project]ボタンを押してソリューションファイル(*.sln)を開きます。

ビルドの実行

[ビルド] > [ソリューションのビルド] を実行してソリューションをビルドします。

ドキュメント生成手順

doxygen の実行

ソリューションエクスプローラで「doc」を選び、右クリックします。 そこで「ビルド」を選択して実行します。

ドキュメント

「Where to build the binaries」で指定したフォルダー配下の doc/html/doxygen/html にドキュメントが生成されます。

パッケージ生成手順

パッケージ生成には、CMake に同梱されている cpack と Wix を使用しています。

PACKAGE ビルドの実行

ソリューションエクスプローラで「PACKAGE」を選び、右クリックします。 そこで「ビルド」を選択して実行します。

パッケージ

「Where to build the binaries」で指定したフォルダー配下に msi 形式のイントールパッケージが生成されます。

<パッケージ名>_rtm120_win64.msi

このイントールパッケージを実行すると下記へインストールされます。

C:\Program Files\OpenRTM-aist\1.2.0\Components\<言語>\<カテゴリ名>\<パッケージ名>

• 準備
• RTC Builder からのビルド手順
• コマンドプロンプトからのビルド手順

準備

事前に Java Development Kit 6 をインストールする必要があります。(注意：Java1.5(5.0)では動作しません。)

RTC Builder からのビルド手順

1. RTCプロファイルエディタ画面で、[言語・環境] タブを開き、 [Java] を選択します。
   
   
   
   
   
   
2. [基本タブ] を開き、[コードの生成] ボタンをクリックしてコードを生成します。
   
   
   
   
   
   
3. コード生成対象言語の開発環境用プラグインがインストールされている場合、以下の確認メッセージが表示されるので [はい] をクリックします。その後、表示されたダイアログで [Java(デフォルト)] を選択し [OK] ボタンをクリックします。
   Java 言語の場合は、JDT(Java Development Tools) があらかじめ Eclipse に含まれています。
   
   
   
   
   
   
   
   
   
4. パッケージエクスプローラー内に、プロジェクトの情報が表示されますが、一部表示されていないため、メニューから [ファイル] > [更新] を選択するか、パッケージエクスプローラー内で [F5] キーをクリックして情報を更新します。
   
   
5. [build_モジュール名.xml] のファイルを右クリックし、[実行] > [1 Ant ビルド] を選択します。
   
   
   
   
   
   
6. ビルドが実行され、コンソール画面にビルド結果が表示されます。
   
   
   
   
   
   

• もしコンソール画面にエラーが表示された場合は、JDK が正常にインストールされているか確認します。メニューから [ウィンドウ] > [設定] > [インストール済の JRE] を選択します。 インストール済みの JDK が選択されているかを確認します。もし表示されていなければ、[追加] または [検索] ボタンからインストールした JDK を追加します。
  
  
  
  
  
  参照
• 新規 Java プロジェクトが JDK6(1.6)準拠として作成できない
• 任意のフォルダーにクラスパスを設定して Ant ビルドを行う方法は？
• Java で Ant を使ってコマンドラインからビルドするときに例外が表示される

コマンドプロンプトからのビルド手順

1. Apache Ant を以下のサイトからダウンロードします。Apache Ant とはビルドを実行するためのソフトウェアです。Eclipse には Ant プラグインが標準で内蔵されていますが、コマンドプロンプトからビルドを実行するためにはダウンロードする必要があります。
   
   ダウンロード：the Apache Ant Website
   
   
2. Zipファイルを解凍して、フォルダー名を任意に変更します。(例：apache-ant-x.xx.x → ant )
   
   
3. 任意のフォルダーに移動します。(例：C:\Program Files\ant )
   
   
4. 環境変数を設定します。(画面は Windows10 のものです)
   
   1. システムのプロパティ画面を開き、[環境変数] ボタンをクリックします。
      
      
      
      
      
      
   2. 「システム環境変数」で [新規] ボタンをクリックします。
      
      
      
      
      
      
   3. 変数名に「ANT_HOME」、変数値に「C:\Program Files\ant」を入力し [OK] ボタンをクリックします。 ※変数値は ant フォルダーのパスを指定します。
      
      
      
      
      
      
   4. 「システム環境変数」一覧から、変数名「Path」を選択し、[編集] ボタンをクリックします。
      
      
      
      
      
      
   5. [新規] ボタンをクリックして、「%ANT_HOME%\bin」と入力し [OK] ボタンをクリックします。
      
      
      
      
      
      
   6. JAVA_HOME を設定します。すでに設定されている場合は不要です。
      「システム環境変数」で [新規] ボタンをクリックします。
      
      
      
      
      
      
   7. 変数名に「JAVA_HOME」、変数値に「C:\Program Files\Java\jdkx.x.x.x_xxx」を入力し [OK] ボタンをクリックします。
      ※変数値は Java のインストール先フォルダーのパスを指定します。
      
      
      
      
      
      
   8. システムのプロパティ画面に戻り、[OK] ボタンをクリックして画面を閉じます。
      
      
5. PC を再起動します。
   
   
6. 再起動後、コマンドプロンプトを起動し、「ant -version」と入力して Apache Ant のバージョンを確認してください。
   
   
   
   
   
   
7. 同様に「java -version」と入力し、Java のバージョンを確認してください。
   
   
   
   
   
   
8. コマンドプロンプトからビルドします。
   指定した RTCプロジェクトのフォルダーで、以下のコマンドを入力するとビルドが開始されます。

    ant -f  build_*****.xml  (***** はモジュール名)

   ビルドに成功すると、以下の表示となります。
   
   
   
   
   
   

• はじめに
• 事前準備
  • Windows 環境
    • WiX Toolset のインストール
    • Graphviz のインストール
  • Linux 環境
    • 一括インストール
• Windows/Linux での共通設定
  • インストーラーパッケージ名
  • インストール先ディレクトリーの指定
  • パッケージメンテナー情報

はじめに

CMake には CPack によるインストーラーパッケージを作成する機能があります。 OpenRTP 1.2.0版 以降を使って生成した RTコンポーネントは、RTCBuilder で生成された CMake の設定を変更することなく、インストーラーパッケージを作成することができます。 Windows 環境なら msi 形式のインストーラーを、Linux の Ubuntu、または Debian 環境なら deb パッケージを、Fedora 環境なら rpm パッケージを作成することができます。

（注）ただし、OpenRTP 1.2.0版 でこのパッケージを作成することができるのは C++ または Python の RTC のみで、Java の RTC では対応しておりません。

OpenRTP 1.2.0版 のインストールは、OpenRTM-aist 1.2.0版 のダウンロードページで紹介しています。

事前準備

インストーラー、パッケージ作成に必要なソフトウエアをインストールします。

Windows 環境

OpenRTM-aist のインストール時に表示しているソフトウエア以外に、下記のソフトウエアをインストールする必要があります。

WiX Toolset のインストール

1. インストーラーを起動し、[install] ボタンをクリックしてインストールを開始します。
   
   
   
   
   
2. [install] ボタンに「Complete」と表示されるとインストール完了です。[Exit] ボタンをクリックします。
   
   
   

Graphviz のインストール

1. インストーラーを起動し、[Next] ボタンをクリックします。
   
   
   
   
   
2. インストールフォルダーを任意に変更して、[Next] ボタンをクリックします。
   
   
   
   
   
3. [Next] ボタンをクリックし、インストールを開始します。
   
   
   
   
   
   
   
   
4. インストール完了後、[Close] ボタンをクリックします。
   
   
   
   
   
   
5. msi からインストールするとパスを通してくれないため、手動で環境変数にパスを追加する必要があります。コマンドプロンプトを右クリックし、[管理者として実行] を選択します。
   
   
6. コマンドプロンプトに以下のコマンドを入力して実行します。
   
   ＞setx /M PATH "%PATH%;[インストールフォルダーのパス]"
   
   
   
   
   成功すると「成功：指定した値は保存されました」と表示されます。
   
   
7. 一度、コマンドプロンプトを閉じて、再度、開き直します。
   
   
8. Graphviz の各コマンドが使用できるか確認するため、以下のコマンドを入力します。
   
   ＞dot -V
   
   
   バージョンが表示されれば完了となります。
   
   

Linux 環境

OpenRTM-aist を インストールする際に使ったスクリプトで必要なパッケージをインストールできます。

一括インストール

Ubuntu、Debian、Fedora、Raspbian の 一括インストール手順はこちら をご覧ください。

Windows/Linux での共通設定

インストーラーパッケージ名

Windows の場合、「RTCプロジェクト名＋RTCのバージョン番号_OpenRTM-aist のバージョン番号_アーキテクチャ」で構成されます。 バージョン番号はドットを省いた形式で、[1.0.0] は [100] となります。
Linux の場合、「RTCプロジェクト名_RTCのバージョン番号_アーキテクチャ」で構成されます。

• プロジェクト名：RobotController
• バージョン番号：1.0.0
• OpenRTM-aist のバージョン：1.2.0

• Windows の場合
  • 32bit：RobotController100_rtm120_win32.msi
  • 64bit：RobotController100_rtm120_win64.msi

• Ubuntu、Debian の場合
  • 32bit：robotcontroller_1.0.0_i386.deb
  • 64bit：robotcontroller_1.0.0_amd64.deb

• Fedora の場合
  • 32bit：RobotController-1.0.0-i686.rpm
  • 64bit：RobotController-1.0.0-x86_64.rpm

「RTCのバージョン番号」は、RTCBuilder の「基本」タブで指定した値になります。

インストール先ディレクトリーの指定

作成したインストーラーパッケージを実行してインストールされる場所は、デフォルトで OpenRTM-aist のインストール先となります。 Windows 環境のみ、OpenRTM-aist をインストールする時のGUI画面で、任意にインストール先に変更することができます。

• インストーラーパッケージを作成した環境にインストールされている OpenRTM-aist のパス
• RTC の言語
• RTC 生成時、基本タブで指定したモジュールカテゴリ（デフォルトは Category）

モジュールカテゴリは任意の文字列入力が可能です。

このRTCが「C++」の場合、Windows で OpenRTM-aist 1.2.0 の 32bit 版がインストールされている環境でインストーラーを作成すると、デフォルトのインストール先は以下となります。

 C:\Program Files (x86)\OpenRTM-aist\1.2.0\Components\C++\Category\RobotController

Linux 環境でパッケージを作成すると、インストール先は以下となります。この例はモジュールカテゴリを「Controller」とした場合です。

 /usr/share/openrtm-1.2/components/c++/Controller/RobotController

パッケージメンテナー情報

パッケージのメンテナー情報は、RTCBuilderの「ドキュメント生成」タブの「作成者・連絡先」で入力された内容が反映されます。 書式は「name <mail address>」で入力する必要があります。名前はローマ字表記、メールアドレスは ＜ ＞ で括る必要があります。 空欄の場合は「unknown」となります。(デフォルトは空欄です)

• はじめに
• doxygen ドキュメントを含めない場合の作成手順
• doxygen ドキュメントを含める場合の作成手順
• msi インストーラーの保存場所、ファイル名
• msi のインストール・アンインストール
  • インストール
  • アップグレードの GUID 設定
  • アンインストール
    • コントロールパネルから削除する方法
    • インストーラーから削除する方法
• サービスポートを持つ Python RTC の IDLコンパイル処理

はじめに

msi インストーラーは Visual Studio でビルドして作成します。

doxygen ドキュメントを含めない場合の作成手順

※デフォルトでは、ドキュメントビルドは OFF になっているため生成されません。

Visual Studio のソリューション エクスプローラーから「PACKAGE」を右クリックして「ビルド」を選択し実行します。

doxygen ドキュメントを含める場合の作成手順

プロジェクトフォルダー直下にある CMakeLists.txt の下記の行を、OFF → ON に書き換えます。
C++ RTC の場合は 86行目あたり、Python RTC の場合は 77行目あたりです。

 option(BUILD_DOCUMENTATION "Build the documentation" ON) ※この行の OFF を ON に書き換えます。(デフォルトは OFF)

1. Visual Studio のソリューション エクスプローラーから「doc」を右クリックして「ビルド」を選択し実行します。
   
   
   
   
   
2. 「doc」でビルド完了後、「PACKAGE」を右クリックして、「ビルド」を選択します。
   
   
   
   
   

• CMake の configure で「BUILD_DOCUMENTATION」にチェックが入っているのを確認すること。
• 先に「doc」のビルドをしてから、「PACKAGE」のビルドを行うこと。「doc」のビルドをせずに「PACKAGE」のビルドを行うとエラーになります 。

msi インストーラーの保存場所、ファイル名

正常に作成できた場合は、プロジェクトディレクトリーの [build] 内に保存されます。
ファイル名は、「RTCプロジェクト名＋RTCのバージョン番号_OpenRTM-aist のバージョン番号_アーキテクチャ」となります。

(例) Flip100_rtm120_win64.msi
※アーキテクチャは、[win32] または [win64] となります。
　バージョン番号は、ドットを省いた形式で、[1.0.0] は [100] となります。

msi のインストール・アンインストール

インストール

1. 作成した msi インストーラーをダブルクリックします。
   
   
2. [次へ] をクリックします。
   
   
   
   
   
3. [使用許諾契約書に同意します] にチェックを入れ、[次へ] をクリックします。
   
   
   
   
   
4. [次へ] をクリックします。
   デフォルトのインストールパスは以下になります。
   (例) C:\Program Files\OpenRTM-aist\1.2.0\Components\c++\ImageProcessing\
   ※ImageProcessing は、RTCBuilderの「モジュールカテゴリ」で指定した名前
   
   
   
   
   
5. [インストール] をクリックすると、インストールが開始されます。
   
   
   
   
   
   
   
   
6. [完了] をクリックし、インストーラーを終了します。インストール後、スタートメニューに登録されます。
   
   
   
   
   

アップグレードの GUID 設定

1. Visual Studio のソリューション エクスプローラーから「PACKAGE」を右クリックし、「ビルド」を選択し実行します。
   
   
   
   
   
2. ビルドが完了すると、以下の出力画面に GUID が表示されるので、選択してコピーします。
   
   
   
   
   
3. ソリューション エクスプローラーから「ALL_BILD」を展開し、CMakeLists.txt をクリックします。
   
   
   
   
   
4. 手順２でコピーした GUID を以下の画面のように貼り付け、CMakeLists.txt を上書き保存します。
   
   
   
   
   
5. 再度、ソリューション エクスプローラーから「PACKAGE」を右クリックし、「ビルド」を選択し実行します。
   
   
   
   
   

1. [GUID 形式] で、[4. レジストリ形式・・・] を選択します。
   
2. [新規 GUID] ボタンをクリックします。
   
3. [コピー] ボタンをクリックします。
   
4. [終了] ボタンをクリックして、ダイアログを閉じます。
   
   
   
   
   
5. 以下の画面のように、CMakeLists.txt に貼り付けて、上書き保存します。※数字のみを貼り付けます。
   
   
   
   
   

アンインストール

コントロールパネルから削除する方法

1. [コントロールパネル] を開き、[プログラムのアンインストール] をクリックします。
   
   
   
   
   
2. インストールしたパッケージ名を選択し、[アンインストール] をクリックします。
   
   
   
   
   
3. コントロールパネルの一覧から表示が消えていればアンインストール完了です。
   
   

   インストーラーから削除する方法

1. 作成した msi インストーラーをダブルクリックします。
   
   
2. [削除] をクリックします。
   
   
   
   
   
3. [削除]をクリックします。
   
   
   
   
   
   
   
   
4. [完了] をクリックし、インストーラーを終了します。
   
   
   
   
   

サービスポートを持つ Python RTC の IDLコンパイル処理

サービスポートを持つ Python RTC は、パッケージインストール時に IDL コンパイルを実行します。 IDL コンパイル実行時にプロジェクトフォルダー内にある idlcompile.bat、delete.bat でこの動作を実現させているため、これらのファイルを削除してしまうと機能しなくなってしまうので注意が必要です。
コントロールパネルからアンインストールすることで、IDL コンパイル実行後に生成したファイルも削除されます。

以下、msi インストーラーによりインストールされるファイル一覧です。★マークが IDL コンパイルで生成されるファイルです。

 tree /f インストールディレクトリー\OpenRTM-aist\1.2.0\Components\Python\Category\FlipGUI
 C:\インストールディレクトリー\OpenRTM-aist\1.2.0\Components\Python\Category\FlipGUI
 │  BasicDataType_idl.py ★
 │  CalibrationService_idl.py ★
 │  delete.bat
 │  ExtendedDataTypes_idl.py ★
 │  idlcompile.bat
 │  InterfaceDataTypes_idl.py ★
 │  RTC.xml
 │  rtutil.py
 │  setup.py
 │  flipgui.py
 │  FlipGUIComp.py
 │
 ├─idl
 │   BasicDataType.idl
 │   CalibrationService.idl
 │   CMakeLists.txt
 │   ExtendedDataTypes.idl
 │   InterfaceDataTypes.idl
 │
 ├─ImageCalibService ★
 │   __init__.py ★
 │
 ├─ImageCalibService__POA ★
 │   __init__.py ★
 │
 ├─RTC ★
 │   __init__.py ★
 │
 └─RTC__POA ★
       __init__.py ★

• はじめに
• doxygen ドキュメントを含めない場合の作成手順
• doxygen ドキュメントを含める場合の作成手順
• deb パッケージの保存場所、ファイル名
• deb パッケージの確認方法
• deb パッケージのインストール・アンインストール
  • インストール
  • アンインストール
• サービスポートを持つ Python RTC の IDL コンパイル処理

はじめに

deb パッケージの作成方法を以下に示します。

doxygen ドキュメントを含めない場合の作成手順

※デフォルトでは、ドキュメントビルドは OFF になっているため生成されません。

• C++ RTC の場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ cpack

• Pyrhon RTC での場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ cpack

doxygen ドキュメントを含める場合の作成手順

プロジェクトディレクトリー直下にある CMakeLists.txt の下記の行を、OFF → ON に書き換えます。
C++ RTC の場合は 86行目あたり、Python RTC の場合は 77行目あたりです。

 option(BUILD_DOCUMENTATION "Build the documentation" ON) ※この行の OFF を ON に書き換えます。(デフォルトは OFF)

• C++ RTC の場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ make doc
 $ cpack

• Pyrhon RTC での場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make doc
 $ cpack

【注意事項】
ドキュメントビルドを ON にして、「make doc」 をせずに 「cpack」 を実行すると以下のようなエラーになります。

 CMake Error at /home/プロジェクトディレクトリー/build/doc/cmake_install.cmake:36 (file):
 file INSTALL cannot find
 "/home/プロジェクトディレクトリー/build/doc/html/doxygen/html".

deb パッケージの保存場所、ファイル名

正常に作成できた場合は、プロジェクトディレクトリーの [build] 内に保存されます。
ファイル名は、「RTCプロジェクト名_RTCのバージョン番号_アーキテクチャ」となります。

(例) Flip_1.2.0_amd64.deb
※アーキテクチャは、[i386] または [amd64] となります。

deb パッケージの確認方法

• less コマンドで、deb パッケージの確認をする場合

 $ cd プロジェクトディレクトリー/build 
 $ less Flip_1.2.0_amd64.deb
 Flip_1.2.0_amd64.deb
 新形式 debian パッケージ、バージョン 2.0。
 サイズ 258304 バイト: コントロールアーカイブ = 2797 バイト。
     162 バイト、    9 行      control              
   10062 バイト、   92 行      md5sums              
 Package: affine
 Version: 1.2.0
 Section: devel
 Priority: optional
 Architecture: amd64
 Installed-Size: 884
 Maintainer: unknown　※パッケージメンテナー情報を定義していないと「unknown」になります
 Description: Flip image component

less を終了させるには「q」を押します。

• deb パッケージの内容を抽出して確認する場合
  tree コマンドがインストールされていない場合は、インストールします。

 $ sudo apt-get install tree

 $ cd プロジェクトディレクトリー/build 
 $ dpkg -x Flip_1.2.0_amd64.deb .
 $ tree usr
 usr
 └─ share
    　└─ openrtm-1.2
        　　└─ components
            　　　└─ python
               　　　 　└─ Category　※指定したインストール先ディレクトリー
                    　　　　　└─ FlipGUI
                        　　　　　　├─ RTC.xml
                        　　　　　　├─ FlipGUIComp.py
                        　　　　　　├─ idl
                        　　　　　　│    ├─ BasicDataType.idl
                        　　　　　　│    ├─ CMakeLists.txt
                     　　　　　　   │    ├─ CalibrationService.idl
                  　　　　　　      │    ├─ ExtendedDataTypes.idl
                        　　　　　　│    └─ InterfaceDataTypes.idl
                        　　　　　　├─ idlcompile.sh
                      　　　　　　  ├─ rtutil.py
                        　　　　　　├─ setup.py
                        　　　　　　└─ flipgui.py

deb パッケージのインストール・アンインストール

インストール

インストールは以下のコマンドを実行します。

 $ cd プロジェクトディレクトリー/build 
 $ sudo dpkg -i Flip_1.2.0_amd64.deb 

アンインストール

アンインストールは以下のコマンドを実行します。

 $ sudo dpkg -ｒ Flip

サービスポートを持つ Python RTC の IDL コンパイル処理

サービスポートを持つ Python RTC は、パッケージインストール時に IDL コンパイルを実行します。 IDL コンパイル実行時に、プロジェクトディレクトリー内にある postinst.in、prerm.in でこの動作を実現させているため、これらのファイルを削除してしまうと機能しなくなるので注意が必要です。

以下、debパッケージからインストールされるファイル一覧です。★マークが IDL コンパイルで生成されるファイルです。

 $ tree /usr/share/openrtm-1.2/components/python/Category/FlipGUI/
 /usr/share/openrtm-1.2/components/python/Category/FlipGUI/
   ├─ BasicDataType_idl.py  ★
   ├─ CalibrationService_idl.py  ★
   ├─ ExtendedDataTypes_idl.py  ★
   ├─ ImageCalibService  ★
   │   └─ __init__.py  ★
   ├─ ImageCalibService__POA  ★
   │   └─ __init__.py  ★
   ├─ InterfaceDataTypes_idl.py  ★
   ├─ RTC  ★
   │   └─ __init__.py  ★
   ├─ RTC.xml
   ├─ RTC__POA  ★
   │   └─ __init__.py  ★
   ├─ FlipGUIComp.py
   ├─ idl
   │   ├─ BasicDataType.idl
   │   ├─ CMakeLists.txt
   │   ├─ CalibrationService.idl
   │   ├─ ExtendedDataTypes.idl
   │   └─ InterfaceDataTypes.idl
   ├─ idlcompile.sh
   ├─ rtutil.py
   ├─ setup.py
   └─ flipgui.py

• はじめに
• doxygen ドキュメントを含めない場合の作成手順
• doxygen ドキュメントを含める場合の作成手順
• rpm パッケージの保存場所、ファイル名
• rpm パッケージの確認方法
• rpm パッケージのインストール・アンインストール
  • インストール
  • アンインストール
• サービスポートを持つ Python RTC の IDL コンパイル処理

はじめに

rpm パッケージの作成方法を以下に示します。

doxygen ドキュメントを含めない場合の作成手順

※デフォルトでは、ドキュメントビルドは OFF になっているため生成されません。

• C++ RTC の場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ cpack

• Pyrhon RTC での場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ cpack

doxygen ドキュメントを含める場合の作成手順

プロジェクトディレクトリー直下にある CMakeLists.txt の下記の行を、OFF → ON に書き換えます。
C++ RTC の場合は 86行目あたり、Python RTC の場合は 77行目あたりです。

 option(BUILD_DOCUMENTATION "Build the documentation" ON) ※この行の OFF を ON に書き換えます。(デフォルトは OFF)

• C++ RTC の場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ make doc
 $ cpack

• Pyrhon RTC での場合

 $ cd プロジェクトディレクトリー
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make doc
 $ cpack

【注意事項】
ドキュメントビルドを ON にして、「make doc」 をせずに 「cpack」 を実行すると以下のようなエラーになります。

 CMake Error at /home/プロジェクトディレクトリー/build/doc/cmake_install.cmake:36 (file):
 file INSTALL cannot find
 "/home/プロジェクトディレクトリー/build/doc/html/doxygen/html".

rpm パッケージの保存場所、ファイル名

正常に作成できた場合は、プロジェクトディレクトリー内の [build] に保存されます。
ファイル名は、「RTCプロジェクト名-RTCのバージョン番号-アーキテクチャ」となります。

(例) Flip-1.2.0-x86_64.rpm
※アーキテクチャは、[i686] または [x86_64] となります。

rpm パッケージの確認方法

• less コマンドで、rpm パッケージの確認をする場合

 $ cd プロジェクトディレクトリー/build 
 $ less Flip-1.2.0-x86_64.rpm
 Name        : Flip
 Version     : 1.2.0
 Release     : 1
 Architecture: x86_64
 Install Date: (not installed)
 Group       : unknown
 Size        : 506080
 License     : unknown
 Signature   : (none)
 Source RPM  : Flip-1.2.0-1.src.rpm
 Build Date  : 2017年xx月xx日 xx時xx分x秒
 Build Host  : localhost
 Relocations : /usr 
 Vendor      : AIST
 Summary     : Flip image component
 Description :
 DESCRIPTION

less を終了させるには「q」を押します。

• rpm パッケージの内容を抽出して確認する場合
  tree コマンドがインストールされていない場合は、インストールします。

 $ sudo apt-get install tree

 $ cd プロジェクトディレクトリー/build 
 $ dpkg -x Flip-1.2.0-x86_64.rpm .
 $ tree usr
 usr
 └─ share
    　└─ openrtm-1.2
        　　└─ components
            　　　└─ python
               　　　 　└─ Category　※指定したインストール先ディレクトリー
                    　　　　　└─ FlipGUI
                        　　　　　　├─ RTC.xml
                        　　　　　　├─ FlipGUIComp.py
                        　　　　　　├─ idl
                        　　　　　　│    ├─ BasicDataType.idl
                        　　　　　　│    ├─ CMakeLists.txt
                     　　　　　　   │    ├─ CalibrationService.idl
                  　　　　　　      │    ├─ ExtendedDataTypes.idl
                        　　　　　　│    └─ InterfaceDataTypes.idl
                        　　　　　　├─ idlcompile.sh
                      　　　　　　  ├─ rtutil.py
                        　　　　　　├─ setup.py
                        　　　　　　└─ flipgui.py

rpm パッケージのインストール・アンインストール

インストール

インストールは以下のコマンドを実行します。

 $ cd プロジェクトディレクトリー/build 
 $ sudo rpm -i Flip-1.2.0-x86_64.rpm

アンインストール

アンインストールは以下のコマンドを実行します。

 $ sudo rpm -e Flip

サービスポートを持つ Python RTC の IDL コンパイル処理

サービスポートを持つ Python RTC は、パッケージインストール時に IDL コンパイルを実行します。 IDL コンパイル実行時に、プロジェクトディレクトリー内にある postinst.in、prerm.in でこの動作を実現させているため、これらのファイルを削除してしまうと機能しなくなるので注意が必要です。

以下、rpm パッケージからインストールされるファイル一覧です。★マークが IDL コンパイルで生成されるファイルです。

 $ tree /usr/share/openrtm-1.2/components/python/Category/FlipGUI/
 /usr/share/openrtm-1.2/components/python/Category/FlipGUI/
  ├─ BasicDataType_idl.py  ★
  ├─ CalibrationService_idl.py  ★
  ├─ ExtendedDataTypes_idl.py  ★
  ├─ ImageCalibService  ★
  │   └─ __init__.py  ★
  ├─ ImageCalibService__POA  ★
  │   └─ __init__.py  ★
  ├─ InterfaceDataTypes_idl.py  ★
  ├─ RTC  ★
  │   └─ __init__.py  ★
  ├─ RTC.xml
  ├─ RTC__POA  ★
  │   └─ __init__.py  ★
  ├─ FlipGUIComp.py
  ├─ idl
  │   ├─ BasicDataType.idl
  │   ├─ CMakeLists.txt
  │   ├─ CalibrationService.idl
  │   ├─ ExtendedDataTypes.idl
  │   └─ InterfaceDataTypes.idl
  ├─ idlcompile.sh
  ├─ rtutil.py
  ├─ setup.py
  └─ flipgui.py

• その他
  • 謝辞

その他

謝辞

• Apache Velocity 1.5 ~Copyright (C) 2000-2007 The Apache Software Foundation This product includes software developed by The Apache Software Foundation ( http://www.apache.org/ ).
• Apache Jakarta Commons CLI 1.1 ~Copyright 2001-2007 The Apache Software Foundation This product includes software developed by The Apache Software Foundation ( http://www.apache.org/ ).
• JYaml 1.3 ~Copyright (c) 2005, Yu Cheung Ho All rights reserved.
• Java CC (生成されたソースコードを利用しています) https://javacc.dev.java.net/