AddOn構成ファイル仕様

1. ファイルのエンコーディング要件

UTF-8 エンコーディングを使用することを要求します

2. ファイル名の要件

"AddOnName"+"_config.ini"、例えば JAKA_Command_config.ini のようにします。

ご注意：

ここでの「AddOnName」は対応する AddOn フォルダ名と同じである必要があります。そうでない場合、AddOn は正常に起動できません。

3. ファイル内容

典型的な AddOn 構成ファイルは次のようになります：

[AddOnInfo]
convention = 3.0
name = JAKA_Command
description = "ログに情報を出力します"
version = 1.0
type = 1
portal = 10006
url = http://localhost/myAddOnUi
languagetype = node-red
service = AddOn.json
serviceenabled = 1

4. フィールド説明：

convention AddOn パッケージパーサーのバージョン。入力しないか、または入力したパーサーバージョンが正しくない場合、アプリがこの AddOn を起動する際に「操作が無効 AddOn 失敗」というメッセージが表示されます。 name AddOnパッケージ名。AddOnを起動すると、自動的にAddOnフォルダー名と同期されます。APPのアドオン画面では対応する「プログラム名」として表示されます。 description AddOnの機能説明。APPのアドオン画面では対応する「説明」として表示されます。長さは35文字以内に制限されています。APPのアドオン画面の「バージョン番号」を超える場合、「INVALID」と表示され、「説明」は空欄になります。APPがこのAddOnを有効にする際には「操作無効 AddOn失敗」というメッセージが表示されます。 version AddOn自身のバージョン番号。任意に設定できます。APPのアドオン画面では対応する「バージョン番号」として表示されます。

type AddOnのタイプ：1はカスタムコマンド、2はカスタムサービス、3はカスタムページを示します。1または2を入力するとAPPのアドオン画面に地球アイコンは表示されません。3を入力すると地球アイコンが表示されます。未入力またはその他の数値・文字を入力すると無効になります。APPのアドオン画面の「バージョン番号」は「INVALID」と表示され、「説明」は空欄になります。APPがこのAddOnを有効にすると「操作無効 AddOn失敗」というメッセージが表示されます。 portal コントローラ内部で現在のAddOnに自動的に割り当てられるポート。ユーザー設定は不要で、空欄のままで構いません。 url アドオンページの操作メニューにある地球アイコンをクリックすると移動するURLです。つまり、AddOnフロントエンドプロジェクトのエントリーファイルindex.htmlのパスです。例えばAddOnフロントエンドプロジェクトのindex.htmlがフォルダーJAKA_Command/clientにある場合、url = http://localhost/JAKA_Command/client と記入します。localhostフィールドは解析時に自動的に現在のロボットのIPアドレスに置き換えられます。未入力の場合、APPがこのAddOnを有効にする際に「操作無効 AddOn失敗」というメッセージが表示されます。入力したパスが誤っている場合、地球アイコンをクリックすると「読み込みに失敗しました。パスが正しいか確認してください」というメッセージが表示されます。 languagetype バックエンドで使用する言語。現在はnode-redのみをサポートしています。 service json形式のデータファイル名を入力します。このファイルは AddOn ファイルディレクトリ内の json ファイルに由来し、node-red 内で定義されたフローおよびノード情報を含みます。ファイル名は自由に設定できますが、両者は一致している必要があります。名前が一致していない場合、APP がこの AddOn を起動すると「AddOn サービスが存在しません」というメッセージが表示されます。 serviceenabled AddOn の起動設定。0 はこの AddOn パッケージが起動時に無効であることを示し、1 は起動時に有効であることを示します。未入力または他の数値・文字を入力した場合は無効となり、APP がこの AddOn を起動すると「操作無効 AddOn 失敗」というメッセージが表示されます。