CMakeプログラムを登録する

エッジアプリとして、Node-REDフローなどから利用されるCMakeプログラム(CMakeを利用してビルド可能なプログラム)をIoTストアに登録することができます。

IoTストアに登録可能なCMakeプログラムの開発や仕様については、 My-IoT プラットフォーム仕様書 を参照してください。

CMakeプログラムファイルを選択する

CMakeプログラムを登録するには、 [ファイル] から [選択] ボタンを選択して、CMakeプログラムファイルを選択してください。登録可能なCMakeプログラムファイルは下記のとおりです。

  • zip形式のファイルであること

cmake_input

CMakeプログラムの基本情報を入力する

CMakeプログラムの基本情報を入力してください。

  • 名前(必須)

    • IoTストアに公開されるCMakeプログラムの名前を入力します。重複した名前は使用できません

  • 説明

    • CMakeプログラムの説明を入力します

  • バージョン(編集不可)

    • IoTストアで自動的に採番されたバージョン情報が表示されます

インプット / アウトプットプロトコルを選択する

CMakeプログラムが対応しているプロトコルを選択してください。
エッジアプリでは、フローファイルで使用されているノードに応じたプロトコルのエッジプログラムを設定することができます。フローファイルとエッジプログラムの関係については、 エッジアプリケーションを登録する を参照してください。

  • インプットプロトコル

    • CMakeプログラムがデータを受信する際に使用するプロトコルを選択します

  • アウトプットプロトコル

    • CMakeプログラムがデータを送信する際に使用するプロトコルを選択します

選択可能なプロトコルは下記のとおりです

  • 対応プロトコル無し

    • 送信、受信を行わないプログラムや、一覧に存在しないプロトコルを使用している場合に選択してください

  • UDP

  • TCP

  • HTTP

  • MQTT

スクリプトを入力する

エッジプログラムのインストール時などに実行されるスクリプトを入力してください。
スクリプトはシェルスクリプト形式で記述します。 [ファイル選択] ボタンを押下すると、スクリプトファイルを選択することができます。
スクリプトファイルの文字コードは UTF-8 としてください。

  • インストールスクリプト

    • CMakeプログラムをインストールする前に実行するスクリプトを入力します

    • スクリプトはroot権限で実行されます

  • アンインストールスクリプト

    • CMakeプログラムをアンインストールした後に実行するスクリプトを入力します。CMakeプログラムのアンインストールは、エッジアプリケーションのインストール失敗時、または新しいエッジアプリケーションをインストールする際に行われます

    • スクリプトはroot権限で実行されます

  • インストール後スクリプト

    • CMakeプログラムをインストールした後に実行するスクリプトを入力します

    • スクリプトはroot権限で実行されます

  • アンインストール前スクリプト

    • CMakeプログラムをアンインストールする前に実行するスクリプトを入力します。CMakeプログラムのアンインストールは、エッジアプリケーションのインストール失敗時、または新しいエッジアプリケーションをインストールする際に行われます

    • スクリプトはroot権限で実行されます

  • 開始スクリプト

    • My-IoTエッジの起動時など、エッジアプリが開始される際に実行するスクリプトを入力します

    • インストールしたCMakeプログラムをバックグラウンドで起動しておきたい場合などに利用します

    • スクリプトはユーザ権限(pi)で実行されます

  • 停止スクリプト

    • My-IoTエッジのシャットダウン時など、エッジアプリが停止される際に実行するスクリプトを入力します

    • バックグラウンドで起動しているCMakeプログラムの停止などに利用します

    • スクリプトはユーザ権限(pi)で実行されます

注意

CMakeアプリケーションは、アンインストール処理を手動で入力する必要があります。
アンインストールスクリプトにサービス自動起動の解除やバイナリ削除などを記載してください。

公開範囲を選択する

CMakeプログラムの公開範囲をラジオボタンで選択します。

  • [公開]

    • 全てのユーザにCMakeプログラムが公開されます

  • [テナント内のみ]

    • ログインしているユーザのテナント内のみでCMakeプログラムが公開されます

高度なオプションを設定する

CMakeプログラムの高度なオプションを設定することができます。
[高度なオプション] を選択すると設定欄が表示されます。

CMake実行コマンド

CMakeプログラムのインストール時に実行されるビルドコマンドを書き換えることができます。

CMakeプログラムはインストールの際、zipファイルの展開後に下記のデフォルトコマンドがroot権限で実行され、ビルドとインストールが行われます。

cmake . && cmake --build . && make install

cmakeコマンドに引数を付与したい場合など、デフォルト以外のコマンドを実行したい場合は、 [CMake実行コマンド] でCMake実行コマンドを置き換えることができます。
コマンドはroot権限で実行され、 && でつなげることで複数実行することも可能です。

例として、ビルドモードを切り替える引数を追加したい場合は、 [CMake実行コマンド] に下記のようにコマンドを入力してください。

cmake -DCMAKE_BUILD_TYPE=Release . && cmake --build . && make install

登録する

入力が完了したら、画面下部の [登録] ボタンを押下してください。
登録完了ダイアログが表示され、エッジプログラム詳細画面が表示されます。