cpack で msi 作成（windows）

✏️ Edit this page on GitHub

#contents(4)

はじめに

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」を右クリックして「ビルド」を選択し実行します。


  1. 「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. [次へ] をクリックします。


  1. [使用許諾契約書に同意します] にチェックを入れ、[次へ] をクリックします。


  1. [次へ] をクリックします。
    デフォルトのインストールパスは以下になります。
    (例) C:\Program Files\OpenRTM-aist\1.2.0\Components\c++\ImageProcessing<br> ※ImageProcessing は、RTCBuilderの「モジュールカテゴリ」で指定した名前


  1. [インストール] をクリックすると、インストールが開始されます。



  1. [完了] をクリックし、インストーラーを終了します。インストール後、スタートメニューに登録されます。


アップグレードの GUID 設定

アップグレードをするときに、すでにインストールされているバージョンを確認するため GUID を設定する必要があります。 GUID は、デフォルトで設定されていないため、Visual Studio で PACKAGE をビルドをする度に新しい GUID が割り当てられてしまいます。 事前に GUID を設定しておくことで、アップグレードなのか、新規インストールなのかを判断することができます。
以下に、GUID の設定手順を示します。

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


  1. ビルドが完了すると、以下の出力画面に GUID が表示されるので、選択してコピーします。


  1. ソリューション エクスプローラーから「ALL_BILD」を展開し、CMakeLists.txt をクリックします。


  1. 手順２でコピーした GUID を以下の画面のように貼り付け、CMakeLists.txt を上書き保存します。


  1. 再度、ソリューション エクスプローラーから「PACKAGE」を右クリックし、「ビルド」を選択し実行します。


[補足]
GUID の作成には上記のほかに、GUID を新規に作成する方法もあります。
Visual Studio のメニューから [ツール] > [GUID の作成] を選択し、「GUID の作成」ダイアログを表示させます。

  1. [GUID 形式] で、[4. レジストリ形式・・・] を選択します。
  2. [新規 GUID] ボタンをクリックします。
  3. [コピー] ボタンをクリックします。
  4. [終了] ボタンをクリックして、ダイアログを閉じます。


  1. 以下の画面のように、CMakeLists.txt に貼り付けて、上書き保存します。※数字のみを貼り付けます。


アンインストール

以下、アンインストール手順です。

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

  1. [コントロールパネル] を開き、[プログラムのアンインストール] をクリックします。


  1. インストールしたパッケージ名を選択し、[アンインストール] をクリックします。


  1. コントロールパネルの一覧から表示が消えていればアンインストール完了です。

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

  2. 作成した msi インストーラーをダブルクリックします。

  3. [削除] をクリックします。


  1. [削除]をクリックします。



  1. [完了] をクリックし、インストーラーを終了します。


サービスポートを持つ 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 ★