インストール&管理ガイド

インデックス

インストール

JSON IoT Agent をインストールするには、Git または RPMs を使用する2つの方法があります。

GIT の使用

IoT Agent をインストールするには、プロジェクトをクローンして依存関係をインストールするだけです :

git clone https://github.com/telefonicaid/iotagent-json.git
npm install

IoT Agentを起動するには、プロジェクトのルートフォルダから次のように入力します :

bin/iotagent-json

RPMの使用

このプロジェクトには、Red Hat 6.5 互換のLinuxディストリビューションにインストールできる RPM を生成するためのスクリプトが含まれています。RPM は Node.js 0.10 バージョンに依存しているため、EPEL リポジトリが推奨されます。

RPM を作成するには、/rpm フォルダ内で次のスクリプトを実行します :

create-rpm.sh -v <versionNumber> -r <releaseNumber>

RPM が生成されたら、次のコマンドを使用して RPM をインストールできます :

yum localinstall --nogpg <nameOfTheRPM>.rpm

IoT Agent は Linux サービスとしてインストールされ、通常どおり service コマンドで使い始めることができます :

service iotaJSON start

使用法

JSON IoT Agent を実行するには、ルートフォルダから次のコマンドを実行してください :

bin/iotagentMqtt.js

これにより、フォアグラウンドで JSON IoT Agent が起動します。バックグラウンドで起動するには、標準の Linux コマンドを使用します。

引数を指定せずに起動すると、IoT Agent はルートフォルダ内の設定を含む config.js ファイルを検索します。引数は、デフォルトのパスの代わりに使用される新しい構成ファイル(アプリケーション・フォルダに相対)へのパスとともに渡すことができます。

設定

概要

IoT Agent のすべての設定は、単一の設定ファイルに保存されます。通常はルートフォルダにインストールされています。

この設定ファイルは JavaScript ファイルであり、3つの設定項目があります :

  • IoT Agent : このオブジェクトは IoT Agent のノースバウンドの設定を保存し、IoT Agent ライブラリによって完全に管理されます。このオプションの詳細については、こちらを参照してください
  • mqtt : このオブジェクトは MQTT の特定の設定を保管します。詳細な説明は次のセクションで見つけることができます
  • http : このオブジェクトは HTTP の特定の設定を保存します。詳細な説明は次のセクションで見つけることができます

いくつかのグローバル設定オプションもあります :

  • configRetrieval : このフラグは、IoT Agent への着信通知を、ライブラリの最新バージョンの双方向性プラグイン または JSON 固有の設定取得メカニズムを使用して処理する必要があるかどうかを示します。両方のメカニズムを同時に使用することはできません。ユーザ・マニュアルに記載しています
  • compressTimestamp : このフラグは、ユーザ・マニュアルで説明されているタイムスタンプ圧縮メカニズムを有効にします

MQTT 設定

現在、使用可能な MQTT 構成オプションは次のとおりです :

  • host : MQTT Broker のホスト
  • port : MQTT Broker がリスニングしているポート
  • defaultKey : 設定なしでデバイスがプロビジョニングされている場合に使用するデフォルトの API Key
  • username : MQTT Broker に対して IoT Agent を識別するユーザ名 (オプション)
  • password : ユーザ名が入力された場合に使用するパスワード (オプション)

環境変数による設定

より一般的な変数のいくつかは、環境変数を使用して構成できます。config.IoT Agent セット内の一般的なパラメータをオーバーライドするものは、IoTA Library Configuration manual に記載されています。

MQTT と HTTP バインディングに関連するものを次の表に示します :

環境変数 構成属性
IOTA_MQTT_HOST mqtt.host
IOTA_MQTT_PORT mqtt.port
IOTA_MQTT_USERNAME mqtt.username
IOTA_MQTT_PASSWORD mqtt.password
IOTA_HTTP_HOST http.host (まだ使用されていません)
IOTA_HTTP_PORT http.port (まだ使用されていません)

HTTP 関連の環境変数は、今後の HTTP バインディングで使用されます。