ノードプログラムを登録する

Node-REDフローで利用されるノードを、ノードプログラムとしてIoTストアに登録することができます。
エッジアプリのNode-REDフローで、npmに公開されていない自作したノードなどを使用している場合は、IoTストアにノードプログラムとして登録しておく必要があります。
ノードプログラムは、エッジアプリのNode-REDフローで使用されている場合に自動で一緒にインストールされます。

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

ノードプログラムファイルを選択する

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

  • ファイル名が [<ノードプログラム名>-<バージョン>.tgz] であること

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

node_file

ノードプログラムファイルを選択すると、ノードプログラム情報の入力欄が表示されます。

03

ノードプログラムの基本情報を確認する

ノードプログラムの基本情報は、選択したノードプログラムの内容に応じて自動で入力されます。

  • 名前（編集不可）

    • IoTストアに公開されるノードプログラムの名前が表示されます。package.jsonに設定されているnameが表示されます

  • バージョン（編集不可）

    • ノードプログラムのバージョンが表示されます。package.jsonに設定されているversionが表示されます

  • 説明（編集不可）

    • ノードプログラムの説明が表示されます。package.jsonに設定されているdescriptionが表示されています

  • README.md（編集不可）

    • 選択したtgzファイル中のREADME.mdファイルの内容が表示されます。

接続可能デバイスを設定する

ノードプログラムが接続可能なデバイスが存在する場合は、デバイス情報を入力してください。
入力形式は下記のとおりです。

  • USBデバイス

    • vid:xxxx , pid:xxxx

[+] ボタンを選択することで、複数の接続可能デバイス情報を設定することができます。接続可能デバイス情報を削除する場合は、削除したい行の [-] ボタンを選択してください。

導入ライブラリを設定する

ノードプログラムには、Pythonスクリプトを含めることが可能になっています。
選択したtgzファイルに、拡張子が.pyのPythonスクリプトが含まれる場合のみ、 [導入ライブラリ] が表示されます。同梱されているPythonスクリプトが対象とするPythonのバージョン指定と、導入するPythonライブラリの指定を行うことができます。

Pythonバージョンの指定

ノードプログラムが対象とするPythonのバージョンを指定します。
指定なしの場合は、バージョン制限を行いません。
[設定] ボタンを押下すると、バージョン指定画面が表示されます。

node_py_ver_01

[符号] と [バージョン] を組み合わせて対象のバージョンを指定してください。

項目

説明

超過(>)

設定したバージョンより大きいバージョンのみインストール対象とします

以上(>=)

設定したバージョン以上のバージョンのみインストール対象とします

未満(<)

設定したバージョンより小さいバージョンのみインストール対象とします

以下(<=)

設定したバージョン以下のバージョンのみインストール対象とします

入力できるバージョンの形式は下記のとおりです。

  • メジャーバージョン（必須）
    0以上の整数

  • マイナーバージョン
    0以上の整数またはワイルドカード(*)

  • パッチバージョン
    0以上の整数またはワイルドカード(*)

マイナーバージョンとパッチバージョンを省略した場合は、下記のように扱われます。

  • 超過(>)、以上(>=)の場合
    {メジャーバージョン}.0.0として扱う

  • 未満(<)または以下(<=)の場合
    < {メジャーバージョン + 1}.0.0として扱う

パッチバージョンを省略した場合は、下記のように扱われます。

  • 超過(>)、以上(>=)の場合
    {メジャーバージョン}.{マイナーバージョン}.0として扱う

  • 未満(<)または以下(<=)の場合
    < {メジャーバージョン + 1}.{マイナーバージョン}.0として扱う

例として、 Python3.7以上 を指定したい場合は [符号] に [以上(>=)]、バージョン欄に [3.7] を入力してください。

node_py_ver_02

バージョン指定は 3.7以上3.9以下 のように、複数条件を組み合わせることも可能です。
複数条件を組み合わせる場合は、[+ボタン] を押して条件行を追加し、組み合わせる条件を設定してください。

node_py_ver_03

条件行を削除する場合は、 削除したい条件行の [-ボタン] を押して条件行を削除してください。

条件の設定が完了したら [設定] ボタンを選択し、 [Pythonバージョン] に指定した条件が表示されていることを確認してください。

注釈

同一の条件や、超過と以上または未満と以下の組み合わせを設定した場合は、設定ボタン押下時に適切な入力内容になるように自動で修正されます。

注意

有効なバージョン指定でない場合は、設定時にエラーとなります。

導入ライブラリの指定とバージョン指定

必要に応じて、ノードプログラムとともに導入するPythonライブラリの指定とバージョン指定を行います。

node_lib_ver_01

tgzファイル中に存在する.pyファイルを解析して抽出されたライブラリが一覧表示されます。
導入するライブラリを選択するには、導入するライブラリ名の横にあるチェックボックスにチェックを入れます。
導入するライブラリのバージョン指定を行う場合は、 [設定] ボタンを選択してください。

node_lib_ver_02

[符号] と [バージョン] を組み合わせて対象のバージョンを指定してください。

項目

説明

等号(==)
設定したバージョンのみインストール対象とします。
マイナーバージョンやパッチバージョンにワイルドカードを使用し、特定のメジャーバージョンをすべて許可や特定のマイナーバージョンをすべて許可などの設定も可能です。

超過(>)

設定したバージョンより大きいバージョンのみインストール対象とします

以上(>=)

設定したバージョン以上のバージョンのみインストール対象とします

未満(<)

設定したバージョンより小さいバージョンのみインストール対象とします

以下(<=)

設定したバージョン以下のバージョンのみインストール対象とします

以外(!==)

設定したバージョン以外のバージョンのみインストール対象とします

互換(~=)
設定したバージョン以上のバージョンかつ、最下位のバージョン以外が同一のバージョンのみインストール対象とします。
マイナーバージョンまでの指定の場合はメジャーバージョンが同一のバージョンのみインストール対象となります。
パッチバージョンまでの指定の場合、メジャーバージョンとマイナーバージョンが同一のバージョンのみインストール対象となります。

入力できるバージョンの形式は下記のとおりです。

  • メジャーバージョン（必須）
    0以上の整数

  • マイナーバージョン
    0以上の整数またはワイルドカード(*)

  • パッチバージョン
    0以上の整数またはワイルドカード(*)

ワイルドカード指定は等号の場合のみ使用可能です。
マイナーバージョンにワイルドカードを使用した場合は、パッチバージョンの指定はできません。

[超過(>)]、 [以上(>=)] 、 [未満(<)] 、 [以下(<=)] は複数条件が設定可能です。 複数条件を組み合わせる場合は、[+ボタン] を押して条件行を追加し、組み合わせる条件を設定してください。
条件行を削除する場合は、 削除したい条件行の [-ボタン] を押して条件行を削除してください。

条件の設定が完了したら、 [設定] を選択し、 [バージョン指定] 欄に指定した条件が表示されていることを確認してください。

注釈

同一の条件や、超過と以上または未満と以下の組み合わせを設定した場合は、設定ボタン押下時に適切な入力内容になるように自動で修正されます。

注意

有効なバージョン指定でない場合、またはライブラリに有効なバージョンが存在しないバージョン指定が入力されている場合は設定時にエラーとなります。

公開範囲を選択する

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

node_openrange

  • [公開]

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

  • [テナント内のみ]

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

登録する

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