このチュートリアルでは、IoT Agent の概念を紹介し、以前のチュートリアルで作成したダミーの UltraLight 2.0 IoT デバイスを接続し、Orion Context Broker に送信された NGSI-v2 リクエストを使用して測定値を読み取り、コマンドを送信できるようにします。

このチュートリアルでは、全体で cUrl コマンドを使用していますが、Postman documentation も利用できます。

IoT Agent とは何ですか？¶

"In every operation there is an above the line and a below the line. Above the line is what you do by the book. Below the line is how you do the job."

— John le Carré (A Perfect Spy)

IoT Agent は、デバイスのグループが独自のネイティブ・プロトコルを使用して Context Broker にデータを送信し、Context Broker から管理できるようにするコンポーネントです。また、IoT Agent は、FIWARE プラットフォームのセキュリティ面(チャネルの認証と認可)に対処し、他の共通サービスをデバイスのプログラマに提供できる必要があります。

Orion Context Broker は、すべての相互作用に対して排他的に NGSI-v2 リクエストを使用します。各 IoT Agent は、 Context Broker の対話に使用されるノース・ポート NGSI-v2 インターフェイスを提供し、このポートの下にあるすべての対話は、接続されたデバイスのネイティブ・プロトコルを使用して行われます。

実際には、コンテキスト情報管理レベルでのすべての IoT インタラクションに対する標準インタフェースを提供します。IoT デバイスの各グループは、独自の専有プロトコルとさまざまなトランスポート・メカニズムを内部で使用できますが、関連する IoT Agent はこの複雑さを処理する Facade パターンを提供します。

IoT Agent はすでに存在しているか、多くの IoT コミュニケーション・プロトコルとデータモデルのために開発中です。例には次のものがあります :

IoTAgent-JSON - JSON ペイロードを持つ HTTP/MQTT メッセージングと NGSI のブリッジ
IoTAgent-LWM2M - Lightweight M2M プロトコルと NGSI のブリッジ
IoTAgent-UL - UltraLight2.0 ペイロードを持つ HTTP/MQTT メッセージングと NGSI のブリッジ
IoTagent-LoRaWAN - LoRaWAN プロトコルと NGSI のブリッジ

サウス・バウンドのトラフィック (コマンド)¶

Context Broker から生成され、IoT Agent を介して、IoT デバイスに向けて下向きに渡された HTTP リクエストは、サウス・バウンド・トラフィックと呼ばれます。サウス・バウンドのトラフィックは、実際の動作の状態を動作によって変更するアクチュエータ・デバイスに対するコマンドで構成されています。

たとえば、実際の Ultra Light 2.0 スマート・ランプをオンに切り替えるには、次のようなやりとりが発生します :

Context Broker に NGSI PATCH リクエストが送信され、スマート・ランプの現在のコンテキストが更新されます
これは事実上、スマート・ランプの on コマンドを呼び出す間接的な要求です
Context Broker は、コンテキスト内でエンティティを見つけ、この属性のコンテキスト・プロビジョニングは IoT Agnet に委任されていることに注意します
Context Broker は、IoT Agnet のノース・ポートに NGSI リクエストを送信して、コマンドを呼び出します
IoT Agnet は、このサウス・バウンドのリクエストを受信し、UltraLight 2.0 の構文に変換し、それをスマート・ランプ に渡します
スマート・ランプはランプを点灯し、UltraLight 2.0 の構文で IoT Agnet にコマンドの結果を返します
IoT Agnet はこのノース・バウンドのリクエストを受け取り、それを解釈し、Context Broker に NGSI リクエストを行うことによって、インタラクションの結果をコンテキストに渡します
Context Broker は、このノース・バウンドのリクエストを受信して、コマンドの結果でコンテキストを更新します

ユーザ と Context Broker との間のリクエストは NGSI を使用します
Context Broker と IoT Agent の間のリクエストは NGSI を使用します
IoT Agent と IoT デバイス間のリクエストは、ネイティブ・プロトコルを使用します
IoT デバイス と IoT Agent の間のリクエストは、ネイティブ・プロトコルを使用します
IoT Agent と Context Broker 間のリクエストは NGSI を使用します

ノース・バウンドのトラフィック (測定)¶

IoT デバイスから生成され、IoT Agent を介して、Context Broker に向けて上向きに戻されたリクエストは、ノース・バウンドのトラフィックと呼ばれます。ノース・バウンドのトラフィックは、センサ・デバイスによって行われた測定からなり、現実世界の状態をシステムのコンテキスト・データに中継します。

たとえば、実際のモーション・センサがカウント測定値を送信するために、次のようなやり取りが行われます :

モーション・センサは測定を行い、その結果を IoT Agent に渡します
IoT Agent は、このノース・バウンドのリクエストを受け取り、その結果を Ultra Light2.0 の構文から変換し、Context Broker に対して NGSI リクエストを行うことで、インタラクションの結果をコンテキストに渡します
Context Broker は、このノース・バウンドのリクエストを受信し、測定結果でコンテキストを更新します

IoT デバイス と IoT Agent 間のリクエストはネイティブ・プロトコルを使用します
IoT Agent と Context Broker 間のリクエストは NGSI を使用します

注さらに複雑なやり取りも可能ですが、この概要は IoT Agent の基本原則を理解するのに十分です

共通の機能¶

前のセクションから分かるように、各 IoT Agent はさまざまなプロトコルを解釈するのでユニークになりますが、IoT Agent 間にはかなりの類似性があります。

デバイスのアップデートをリッスンする標準的な場所を提供
コンテキスト・データの更新をリッスンするための標準的な場所を提供
デバイスのリストを保持し、コンテキスト・データ属性をデバイス構文にマッピング
セキュリティ認証

この基本機能は、一般的な IoT Agent framework library に抽象化されています。

デバイス・モニタ¶

このチュートリアルの目的のために、一連のダミーの IoT デバイスを作成し、Context Broker に接続します。使用するアーキテクチャとプロトコルの詳細については、IoT Sensors tutorial を参照してください。各デバイスの状態は、次の UltraLight2.0 デバイスのモニタ Web ページで確認できます : http://localhost:3000/device/monitor

FIWARE Monitor

アーキテクチャ¶

このアプリケーションは、Orion Context Broker と IoT Agent for UltraLight 2.0 の 2 つの FIWARE コンポーネントを使用します。アプリケーションが “Powered by FIWARE” と認定されるには、Orion Context Broker を使用するだけで十分です。Orion Context Broker と IoT Agent はオープンソースの MongoDB 技術を利用して、保持している情報の永続性を保ちます。以前のチュートリアルで作成したダミーの IoT デバイスも使用します。

したがって、全体的なアーキテクチャは次の要素で構成されます :

NGSI-v2 を使用してリクエストを受信する、FIWARE Orion Context Broker
NGSI-v2 を使用してサウス・バウンドのリクエストを受信し、デバイスの UltraLight 2.0 コマンドに変換する、FIWARE IoT Agent for UltraLight 2.0
基礎となる MongoDB データベース :
- Orion Context Broker が、データ・エンティティ、サブスクリプション、レジストレーションなどのコンテキスト・データの情報を保持するために使用します
- IoT Agent が、デバイスの URL やキーなどのデバイス情報を保持するために使用します
コンテキスト・プロバイダの NGSI proxy は次のようになります :
- NGSI-v2 を使用してリクエストを受信します
- 独自の APIs を独自フォーマットで使用して、公開されているデータソースへのリクエストを行います
- NGSI-v2 形式でコンテキスト・データを Orion Context Broker に返します
在庫管理フロントエンドは以下を行います :
- 店舗情報を表示します
- 各店舗で購入できる商品を表示します
- ユーザが製品を購入して在庫数を減らすことを許可します
HTTP 上で動作する UltraLight 2.0 プロトコルを使用して、ダミーの IoT デバイスのセットとして機能する Web サーバ

要素間のすべての対話は HTTP リクエストによって開始されるため、エンティティはコンテナ化され、公開されたポートから実行されます。

IoT デバイスと IoT Agent を接続するために必要な構成情報は、関連する docker-compose.yml ファイルの services セクションにあります :

ダミー IoT デバイスの設定¶

tutorial:
    image: fiware/tutorials.context-provider
    hostname: iot-sensors
    container_name: fiware-tutorial
    networks:
        - default
    expose:
        - "3000"
        - "3001"
    ports:
        - "3000:3000"
        - "3001:3001"
    environment:
        - "DEBUG=tutorial:*"
        - "PORT=3000"
        - "IOTA_HTTP_HOST=iot-agent"
        - "IOTA_HTTP_PORT=7896"
        - "DUMMY_DEVICES_PORT=3001"
        - "DUMMY_DEVICES_API_KEY=4jggokgpepnvsb2uv4s40d59ov"
        - "DUMMY_DEVICES_TRANSPORT=HTTP"

tutorial コンテナは、2 つのポートでリッスンしています:

ポート3000 が公開されているので、ダミー IoT デバイスを表示する Web ページが表示されます
ポート3001 は純粋にチュートリアルのアクセスのために公開されているため、cUrl または Postman は同じネットワーク以外からも、UltraLight コマンドを作成できます

tutorial コンテナは、次のように環境変数によって設定値を指定できます :

キー	値	説明
DEBUG	`tutorial:*`	ロギングに使用するデバッグ・フラグ
WEB_APP_PORT	`3000`	ダミー・デバイスのデータを表示する web-app が使用するポート
IOTA_HTTP_HOST	`iot-agent`	Ultra Light 2.0 用 IoT Agent のホスト名 - 下記を参照
IOTA_HTTP_PORT	`7896`	Ultra Light 2.0 の IoT Agent がリッスンするポート。`7896` は、Ultra Light over HTTP の一般的なデフォルトです
DUMMY_DEVICES_PORT	`3001`	コマンドを受信するためにダミー IoT デバイスが使用するポート
DUMMY_DEVICES_API_KEY	`4jggokgpepnvsb2uv4s40d59ov`	UltraLight インタラクションに使用されるランダムなセキュリティキー - デバイスと IoT Agent 間のインタラクションの完全性を保証するために使用します
DUMMY_DEVICES_TRANSPORT	`HTTP`	ダミー IoT デバイスによって使用されるトランスポート・プロトコル

このチュートリアルでは、YAML ファイルで説明されている他の tutorial コンテナの設定値は使用しません。

IoT Agent for UltraLight 2.0 の設定¶

IoT Agent for UltraLight 2.0 は、Docker コンテナ内でインスタンス化できます。公式の Docker イメージは、Docker Hub で、fiware/iotagent-ul とタグ付けされています。必要な構成を以下に示します:

iot-agent:
    image: fiware/iotagent-ul:latest
    hostname: iot-agent
    container_name: fiware-iot-agent
    depends_on:
        - mongo-db
    networks:
        - default
    expose:
        - "4041"
        - "7896"
    ports:
        - "4041:4041"
        - "7896:7896"
    environment:
        - IOTA_CB_HOST=orion
        - IOTA_CB_PORT=1026
        - IOTA_NORTH_PORT=4041
        - IOTA_REGISTRY_TYPE=mongodb
        - IOTA_LOG_LEVEL=DEBUG
        - IOTA_TIMESTAMP=true
        - IOTA_CB_NGSI_VERSION=v2
        - IOTA_AUTOCAST=true
        - IOTA_MONGO_HOST=mongo-db
        - IOTA_MONGO_PORT=27017
        - IOTA_MONGO_DB=iotagentul
        - IOTA_HTTP_PORT=7896
        - IOTA_PROVIDER_URL=http://iot-agent:4041

iot-agent コンテナは、Orion Context Broker に依存し、MongoDB データベースを使用して、デバイスの URL やキーなどのデバイス情報を保持します。コンテナが 2 つのポートをリッスンしています:

ポート 7896 は、ダミー IoT デバイスから HTTP 経由で Ultralight の測定値を受けるために公開されています
ポート 4041 は、チュートリアルのアクセスのためだけに公開されているため、cUrl または Postman は同じネットワーク以外からも、UltraLight コマンドを作成できます

iot-agent コンテナは、次のように環境変数によって設定値を指定できます :

キー	値	説明
IOTA_CB_HOST	`orion`	コンテキストを更新する Context Broker のホスト名
IOTA_CB_PORT	`1026`	Context Broker がコンテキストを更新するためにリッスンするポート
IOTA_NORTH_PORT	`4041`	IoT Agent の設定および Context Broker からのコンテキスト更新の受信に使用されるポート
IOTA_REGISTRY_TYPE	`mongodb`	メモリまたはデータベースに IoT デバイス情報を保持するかどうかを指定
IOTA_LOG_LEVEL	`DEBUG`	IoT Agent のログレベル
IOTA_TIMESTAMP	`true`	接続されたデバイスから受信した各測定値にタイムスタンプ情報を提供するかどうかを指定
IOTA_CB_NGSI_VERSION	`v2`	アクティブな属性の更新を送信するときにNGSI v2 を使用するように指定するかどうか
IOTA_AUTOCAST	`true`	Ultralight の数値が文字列ではなく数値として読み取られるようにする
IOTA_MONGO_HOST	`context-db`	mongoDB のホスト名 - デバイス情報を保持するために使用
IOTA_MONGO_PORT	`27017`	mongoDB はリッスンしているポート
IOTA_MONGO_DB	`iotagentul`	mongoDB で使用されるデータベースの名前
IOTA_HTTP_PORT	`7896`	IoT Agent が HTTP 経由で IoT デバイスのトラフィックをリッスンするポート
IOTA_PROVIDER_URL	`http://iot-agent:4041`	コマンドが登録されたときに Context Broker に渡された URL。Context Broker がデバイスにコマンドを発行したときに転送 URL の場所として使用

前提条件¶

Docker¶

物事を単純にするために、両方のコンポーネントが Docker を使用して実行されます。Docker は、さまざまコンポーネントをそれぞれの環境に分離することを可能にするコンテナ・テクノロジです。

Docker Windows にインストールするには、こちらの手順に従ってください
Docker Mac にインストールするには、こちらの手順に従ってください
Docker Linux にインストールするには、こちらの手順に従ってください

Docker Compose は、マルチコンテナ Docker アプリケーションを定義して実行するためのツールです。YAML file ファイルは、アプリケーションのために必要なサービスを構成するために使用します。つまり、すべてのコンテナ・サービスは 1 つのコマンドで呼び出すことができます。Docker Compose は、デフォルトで Docker for Windows と Docker for Mac の一部としてインストールされますが、Linux ユーザはここに記載されている手順に従う必要があります。

次のコマンドを使用して、現在の Docker バージョンと Docker Compose バージョンを確認できます :

docker-compose -v
docker version

Docker バージョン 20.10 以降と Docker Compose 1.29 以上を使用していることを確認し、必要に応じてアップグレードしてください。

Cygwin for Windows¶

シンプルな bash スクリプトを使用してサービスを開始します。Windows ユーザは cygwin をダウンロードして、Windows 上の Linux ディストリビューションと同様のコマンドライン機能を提供する必要があります。

Start Up¶

開始する前に、必要な Docker イメージをローカルで取得または構築しておく必要があります。リポジトリを複製し、以下のコマンドを実行して必要なイメージを作成してください :

git clone https://github.com/FIWARE/tutorials.IoT-Agent.git
cd tutorials.IoT-Agent
git checkout NGSI-v2

./services create

その後、リポジトリ内で提供される、services Bash スクリプトを実行することによって、コマンドラインからすべてのサービスを初期化することができます :

./services start

注: クリーンアップしてやり直す場合は、次のコマンドを実行してください :
./services stop

IoT Agent のプロビジョニング¶

チュートリアルを正しく実行するには、ブラウザのデバイス・モニタ・ページが表示されていることを確認し、ページをクリックして cUrl コマンドを入力する前にオーディオを有効にしてください。デバイス・モニタには、Ultralight 2.0 構文を使用してダミー・デバイスのアレイの現在の状態が表示されます。

デバイス・モニタ¶

デバイス・モニタは次の場所にあります: http://localhost:3000/device/monitor

IoT Agent サービスの正常性の確認¶

IoT Agent が動作しているかどうかは、公開されているポートに対して HTTP リクエストを行うことで確認できます:

1 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/about'

レスポンスは次のようになります:

{
    "libVersion": "2.6.0-next",
    "port": "4041",
    "baseRoot": "/",
    "version": "1.6.0-next"
}

Failed to connect to localhost port 4041: Connection refused のレスポンスを受け取ったらどうしますか？

Connection refused のレスポンスを受け取った場合、IoT Agent がこのチュートリアルで期待される場所に見つからないためです。各 cUrl コマンドの URL とポートを訂正された IP アドレスで置き換える必要があります。すべての cUrl コマンドのチュートリアルでは、IoT Agent が localhost:4041 で使用可能であると想定しています。

以下の対策を試してください:

Docker コンテナが動作していることを確認するには、次のようにしてください:
docker ps
実行中の 4 つのコンテナが表示されます。IoT Agent が実行されていない場合は、必要に応じてコンテナを再起動できます。このコマンドは、開いているポート情報も表示します。

docker-machine と Virtual Box をインストールした場合、Context Broker, IoT Agent, IoT Agnet とダミー・デバイスの Docker コンテナが別の IP アドレスから実行されている可能性があります:
curl -X GET \
 'http://$(docker-machine ip default):4041/version'
または、コンテナ・ネットワーク内からすべての curl コマンドを実行します:
docker run --network fiware_default --rm appropriate/curl -s \
 -X GET 'http://iot-agent:4041/iot/about'

IoT デバイスの接続¶

IoT Agent は、IoT デバイスと Context Broker との間のミドルウェアとして機能します。したがって、ユニークな IDs を持つコンテキスト・データのエンティティを作成できる必要があります。サービスがプロビジョニングされ、未知のデバイスが測定を行うと、IoT Agent は、デバイスが認識され、既知の ID にマッピングされない限り、提供された <device-id> を使用して、これをコンテキストに追加します。

提供されたすべての IoT デバイス <device-id> が常に一意であるという保証はないため、IoT Agent へのすべてのプロビジョニング・リクエストには、2 つの必須ヘッダが必要です:

fiware-service ヘッダは、特定のサービスのエンティティを別の mongoDB データベースに保持できるように定義します
fiware-servicepath デバイスの配列間を区別するために使用できます

たとえば、スマートシティ・アプリケーションでは、さまざまな部門(パーク、交通機関、ごみ収集など)ごとに異なる fiware-service ヘッダが必要であり、各 fiware-servicepath が特定の公園などを参照します。これは、各サービスのデータとデバイスが必要に応じて識別され、分離されることを意味しますが、データはサイロ化されません。たとえば、公園内のスマート・ビンのデータは、ごみ収集車の GPS ユニット と組み合わせて、効率的な方法でトラックのルートを変更することができます。

スマート・ビンと GPS ユニットは、さまざまなメーカーのものを使用する可能性があり、使用される <device-id> に重複がないことを保証することはできません。fiware-service ヘッダと fiware-servicepath ヘッダの使用は、これが常に当てはまることを保証し、Context Broker がコンテキスト・データの元のソースを識別することを可能にします。

サービス・グループのプロビジョニング¶

各測定で認証キーを供給することが常に必要であり、IoT Agent は Context Broker がどの URL をレスポンスしているかを最初に知ることができないため、グループ接続の呼び出しは常にデバイス接続の第一歩です。

また、すべての匿名デバイスのデフォルトのコマンドと属性を設定することもできますが、このチュートリアルでは各デバイスを個別にプロビジョニングするため、これは行いません。

この例では、匿名のデバイス・グループをプロビジョニングします。これは、IoT Agent に、一連のデバイスが、IoT Agent がノース・バウンド通信をリッスンしている IOTA_HTTP_PORT クライアントにメッセージを送信することを通知します。

2 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/services' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
 "services": [
   {
     "apikey":      "4jggokgpepnvsb2uv4s40d59ov",
     "cbroker":     "http://orion:1026",
     "entity_type": "Thing",
     "resource":    "/iot/d"
   }
 ]
}'

この例では、/iot/d エンドポイントが使用され、デバイスがトークン 4jggokgpepnvsb2uv4s40d59ov を含めることによって自身を認証することが IoT Agent に通知されます。UltraLight IoT Agent の場合、これはデバイスが GET リクエストまたは POST リクエストを次の宛先に送信していることを意味します:

http://iot-agent:7896/iot/d?i=<device_id>&k=4jggokgpepnvsb2uv4s40d59ov

これは、以前のチュートリアルで Ultra Light 2.0 の構文に慣れているはずです。

IoT デバイスからの測定値がリソース url で受信されると、それを解釈して Context Broker に渡す必要があります。このentity_type 属性は、リクエストを行った各装置のデフォルト type を提供します。この場合、匿名の装置は Thing エンティティと呼ばれます。さらに、IoT Agent が受信した任意の測定値を正しい場所に渡すことができるように、Context Broker (cbroker) の位置が必要です。cbroker はオプションの属性です。IoT Agent が提供されていない場合、IoT Agent は設定ファイルで定義されている、Context Broker URL を使用しますが、完全性のためにここに含まれています。

センサのプロビジョニング¶

エンティティを作成するときは、NGSI-LD 仕様に従って URNs を使用するのが一般的な良い方法です。さらに、データ属性を定義するときに意味のある名前にするとわかりやすくなります。これらのマッピングは、デバイスを個別にプロビジョニングすることによって定義できます。

3 つのタイプの測定値の属性をプロビジョニングできます:

attributes デバイスからのアクティブな読み取り値
lazy リクエストに応じて送信されます - IoT Agent は測定結果を返すようにデバイスに通知
static_attributes Context Broker に渡される、リレーションシップなどのデバイスに関する静的なデータを示す名前

注: 個体 id が必要でないか、または集約されたデータが十分である場合は、個別にではなくプロビジョニング・サービス内で attributes を定義できます

3 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
 "devices": [
   {
     "device_id":   "motion001",
     "entity_name": "urn:ngsi-ld:Motion:001",
     "entity_type": "Motion",
     "timezone":    "Europe/Berlin",
     "attributes": [
       { "object_id": "c", "name": "count", "type": "Integer" }
     ],
     "static_attributes": [
       { "name":"refStore", "type": "Relationship", "value": "urn:ngsi-ld:Store:001"}
     ]
   }
 ]
}
'

リクエストでは、デバイス motion001 を URN urn:ngsi-ld:Motion:001 と関連付けて、デバイスの読み取り値 c を Integer として定義されているコンテキスト属性 count とマッピングしています。refStore は static_attribute として定義され、デバイスを Store urn:ngsi-ld:Store:001 内に配置します。

静的属性は、q パラメータを使用したクエリを有効にするエンティティの追加データとして役立ちます。たとえば、Smart Data Models Device モデルは、クエリを次のように実行できるようにする category や controledProperty などの属性を定義します:

現在どの Actuators の batteryLevel が低いですか？

/v2/entities?q=category=="actuator";batteryLevel<0.1

2020年1月より前にインストールされた fillingLevel を測定する Devices はどれですか？

/v2/entities?q=controlledProperty=="fillingLevel";dateInstalled<"2020-01-25T00:00:00.000Z"

明らかに、静的データは必要に応じて拡張でき、エンティティ ID がクエリに対して柔軟性がない場合は、デバイスごとに一意の name や serialNumber などの追加データを含めることもできます。

/v2/entities?q=serialNumber=="XS403001-002"

さらに、固定の location 静的属性を持つデバイスは、ジオフェンス・パラメータを使用してクエリすることもできます。

/v2/entities?georel=near;maxDistance:1500&geometry=point&coords=52.5162,13.3777

モーション・センサのデバイス motion001 からのダミー IoT デバイスの測定値をシミュレーションするには、次のリクエストを行います

4 リクエスト :¶

curl -iX POST \
  'http://localhost:7896/iot/d?k=4jggokgpepnvsb2uv4s40d59ov&i=motion001' \
  -H 'Content-Type: text/plain' \
  -d 'c|1'

IoT Agent が接続される前、以前のチュートリアルで同様のリクエストが行われ、ドアがロック解除されると、各モーション・センサの状態が変化し、デバイス・モニタにノース・バウンドのリクエストが記録されます。

今度は、IoT Agent が接続され、サービス・グループは IoT Agent が (iot/d) をリッスンしているリソースと、リクエスト(4jggokgpepnvsb2uv4s40d59ov)を認証するために使用された API キーを定義しました。これらの両方が認識されるので測定は有効です。

IoT Agent はデバイス(motion001)を特別にプロビジョニングしたため、Orion Context Broker でリクエストを発行する前に属性をマップできます。

Context Broker からエンティティのデータを取得することによって、測定値が記録されていることがわかります。fiware-service と fiware-service-path ヘッダを追加することを忘れないでください。

5 リクエスト :¶

curl -X GET \
  'http://localhost:1026/v2/entities/urn:ngsi-ld:Motion:001?type=Motion' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

{
    "id": "urn:ngsi-ld:Motion:001",
    "type": "Motion",
    "TimeInstant": {
        "type": "ISO8601",
        "value": "2018-05-25T10:51:32.00Z",
        "metadata": {}
    },
    "count": {
        "type": "Integer",
        "value": "1",
        "metadata": {
            "TimeInstant": {
                "type": "ISO8601",
                "value": "2018-05-25T10:51:32.646Z"
            }
        }
    },
    "refStore": {
        "type": "Relationship",
        "value": "urn:ngsi-ld:Store:001",
        "metadata": {
            "TimeInstant": {
                "type": "ISO8601",
                "value": "2018-05-25T10:51:32.646Z"
            }
        }
    }
}

レスポンスは、id = motion001のモーション・センサのデバイスが IoT Agnet によって正常に識別され、エンティティ id=urn:ngsi-ld:Motion:001 にマッピングされていることを示します。この新しいエンティティは、コンテキスト・データ内で作成されました。ダミー・デバイスの測定リクエストからの c 属性はコンテキスト内のより意味のある count 属性にマップされています。お気づきのように、TimeInstant 属性がエンティティと属性のメタデータの両方に追加されました。これはエンティティと属性が最後に更新された時刻を表し、IOTA_TIMESTAMP 環境変数が IoT Agent の起動時に設定されます。refStore 属性は、デバイスがプロビジョニングされたときにセットされた static_attributes から来ます。

コマンドを介したアクチュエータのプロビジョニング¶

アクチュエータのプロビジョニングは、センサのプロビジョニングと同様です。今回、endpoint 属性には、IoT Agent が UltraLight コマンドを送信する必要がある場所が格納され、commands 配列には呼び出すことができる各コマンドのリストが含まれています。以下の例では、deviceId=bell001 のベルがプロビジョニングされています。エンドポイントは http://iot-sensors:3001/iot/bell001 であり、ring コマンドを受け入れることができます。

6 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "devices": [
    {
      "device_id": "bell001",
      "entity_name": "urn:ngsi-ld:Bell:001",
      "entity_type": "Bell",
      "protocol": "PDI-IoTA-UltraLight",
      "transport": "HTTP",
      "endpoint": "http://iot-sensors:3001/iot/bell001",
      "commands": [
        { "name": "ring", "type": "command" }
       ],
       "static_attributes": [
         {"name":"refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:001"}
      ]
    }
  ]
}
'

双方向属性 (bidirectional attribute) を介したアクチュエータのプロビジョニング¶

アクチュエータは、双方向属性を使用してプロビジョニングすることもできます。ここでも、endpoint 属性は、IoT Agent が UltraLight コマンドを送信する必要がある場所を保持します。ring 属性は expression を使用して定義され、reverse 方向にそれ自体にマップされます。 ring 属性の更新を受信すると、それはデバイス自体にも送信されます。内部的な違いは、この方法がレジストレーションではなくサブスクリプションに依存していることです。

7 リクエスト :¶

curl -L -X POST 'http://localhost:4041/iot/devices' \
-H 'fiware-service: openiot' \
-H 'fiware-servicepath: /' \
-H 'Content-Type: application/json' \
-H 'Cookie: _csrf=MAPTGFPcoPnewsGCWklHi4Mq' \
--data-raw '{
  "devices": [
    {
      "device_id": "bell002",
      "entity_name": "urn:ngsi-ld:Bell:002",
      "entity_type": "Bell",
      "protocol": "PDI-IoTA-UltraLight",
      "transport": "HTTP",
      "endpoint": "http://iot-sensors:3001/iot/bell002",
      "attributes": [
          {
          "name":"ring",
          "type":"Text",
          "expression": "${@ring}",
          "reverse": [
            {
              "object_id":"ring",
              "type": "Text",
              "expression": "${@ring}"
            }
          ]
        }
      ],
       "static_attributes": [
         {"name":"refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:002"}
        ]
    }
  ]
}
'

Context Broker を接続する前に、/v2/op/update エンドポイントを使用して IoT Agent のノース・ポートに REST リクエストを直接送信することで、コマンドをデバイスに送信できることをテストできます。Context Broker が接続すると、最終的に Context Broker によって呼び出されるのはこのエンドポイントです。設定をテストするには、次のようにコマンドを直接実行します :

8 リクエスト :¶

curl -iX POST \
  http://localhost:4041/v2/op/update \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
    "actionType": "update",
    "entities": [
        {
            "type": "Bell",
            "id": "urn:ngsi-ld:Bell:001",
            "ring" : {
                "type": "command",
                "value": ""
            }
        }
    ]
}'

デバイス・モニタ・ページを表示している場合は、ベル変更の状態も表示できます。

ベルを鳴らすコマンドの結果は、Orion Context Broker 内のエンティティにクエリすることによって読み取ることができます。

9 リクエスト :¶

curl -X GET \
  'http://localhost:1026/v2/entities/urn:ngsi-ld:Bell:001?type=Bell&options=keyValues' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

{
    "id": "urn:ngsi-ld:Bell:001",
    "type": "Bell",
    "TimeInstant": "2018-05-25T20:06:28.00Z",
    "refStore": "urn:ngsi-ld:Store:001",
    "ring_info": " ring OK",
    "ring_status": "OK",
    "ring": ""
}

TimeInstant は、エンティティに関連付けられたコマンドが呼び出された時刻を最後に表示します。リング・コマンドの結果は、ring_info 属性の値で見ることができます。

スマート・ドアのプロビジョニング¶

コマンドと測定の両方を提供するデバイスのプロビジョニングは、リクエストの本文に attributes と command 属性の両方を含む、HTTP POST リクエストを作成するだけです。

10 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "devices": [
    {
      "device_id": "door001",
      "entity_name": "urn:ngsi-ld:Door:001",
      "entity_type": "Door",
      "protocol": "PDI-IoTA-UltraLight",
      "transport": "HTTP",
      "endpoint": "http://iot-sensors:3001/iot/door001",
      "commands": [
        {"name": "unlock","type": "command"},
        {"name": "open","type": "command"},
        {"name": "close","type": "command"},
        {"name": "lock","type": "command"}
       ],
       "attributes": [
        {"object_id": "s", "name": "state", "type":"Text"}
       ],
       "static_attributes": [
         {"name":"refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:001"}
       ]
    }
  ]
}
'

スマート・ランプのプロビジョニング¶

同様に、2 つのコマンド(on および off)と 2 つの属性を持つスマート・ランプは、次のようにプロビジョニングできます:

11リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "devices": [
    {
      "device_id": "lamp001",
      "entity_name": "urn:ngsi-ld:Lamp:001",
      "entity_type": "Lamp",
      "protocol": "PDI-IoTA-UltraLight",
      "transport": "HTTP",
      "endpoint": "http://iot-sensors:3001/iot/lamp001",
      "commands": [
        {"name": "on","type": "command"},
        {"name": "off","type": "command"}
       ],
       "attributes": [
        {"object_id": "s", "name": "state", "type":"Text"},
        {"object_id": "l", "name": "luminosity", "type":"Integer"}
       ],
       "static_attributes": [
         {"name":"refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:001"}
      ]
    }
  ]
}
'

プロビジョニングされたデバイスの完全なリストは、/iot/devices エンドポイントに GET リクエストを行うことで取得できます。

12 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/devices' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

Context Broker コマンドの有効化¶

IoT Agent を IoT デバイスに接続すると、Orion Context Broker にコマンドが利用可能になったことが通知されました。つまり、IoT Agent は、コマンド属性のコンテキスト・プロバイダとして自身を登録しました。

コマンドが登録されていたら、以前のチュートリアルで行ったように、IoT デバイスから直接 Ultra Light 2.0 リクエストを送信するのではなく、ベルに呼び出し音を出したり、スマート・ドアを開閉したり、スイッチスマート・ランプをオン/オフに切り替えることができます。

ベルを鳴らす¶

ring コマンドを呼び出すには、コンテキスト内で ring 属性を更新する必要があります。

13 リクエスト :¶

curl -iX PATCH \
  'http://localhost:1026/v2/entities/urn:ngsi-ld:Bell:001/attrs' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "ring": {
      "type" : "command",
      "value" : ""
  }
}'

デバイス・モニタ・ページを表示している場合は、ベル変更の状態も表示できます。

スマート・ドアを開く¶

open コマンドを呼び出すには、コンテキスト内で open 属性を更新する必要があります。

14 リクエスト :¶

curl -iX PATCH \
  'http://localhost:1026/v2/entities/urn:ngsi-ld:Door:001/attrs' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "open": {
      "type" : "command",
      "value" : ""
  }
}'

スマート・ランプをオンにする¶

スマート・ランプをオンにするには、その on 属性をコンテキストで更新する必要があります。

15 リクエスト :¶

curl -iX PATCH \
  'http://localhost:1026/v2/entities/urn:ngsi-ld:Lamp:001/attrs' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "on": {
      "type" : "command",
      "value" : ""
  }
}'

サービス・グループの CRUD アクション¶

サービス・グループをプロビジョニングするための CRUD 操作は、/iot/services エンドポイントの下にある期待される HTTP 動詞にマップされます。

Create - HTTP POST
Read - HTTP GET
Update - HTTP PUT
Delete - HTTP DELETE

resource と apikey パラメータを使用して、サービス・グループを一意に識別します。

サービス・グループの作成¶

この例では、匿名のデバイス・グループをプロビジョニングします。IoT Agent は、一連のデバイスが、 IoT Agent がノース・バウンド通信をリッスンしている IOTA_HTTP_PORT にメッセージを送信することを通知します。

16 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/services' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
 "services": [
   {
     "apikey":      "4jggokgpepnvsb2uv4s40d59ov",
     "cbroker":     "http://orion:1026",
     "entity_type": "Thing",
     "resource":    "/iot/d"
   }
 ]
}'

サービス・グループの詳細を読み込む¶

この例では、指定された resource パスを持つプロビジョニングされたサービスの完全な詳細を取得します。

サービス・グループの詳細は、/iot/services エンドポイントへの GET リクエストと resource パラメータの提供によって読み取ることができます。

17 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/services?resource=/iot/d' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

{
    "_id": "5b07b2c3d7eec57836ecfed4",
    "subservice": "/",
    "service": "openiot",
    "apikey": "4jggokgpepnvsb2uv4s40d59ov",
    "resource": "/iot/d",
    "attributes": [],
    "lazy": [],
    "commands": [],
    "entity_type": "Thing",
    "internal_attributes": [],
    "static_attributes": []
}

レスポンスには、entity_type などの各サービス・グループに関連付けられているすべてのデフォルトや、デフォルトのコマンド、または属性のマッピングなどが含まれます。

すべてのサービス・グループを一覧表示¶

この例では、/iot/services エンドポイントに GET リクエストを行うことによって、プロビジョニングされたすべてのサービスを一覧表示します。

18 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/services' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

{
    "_id": "5b07b2c3d7eec57836ecfed4",
    "subservice": "/",
    "service": "openiot",
    "apikey": "4jggokgpepnvsb2uv4s40d59ov",
    "resource": "/iot/d",
    "attributes": [],
    "lazy": [],
    "commands": [],
    "entity_type": "Thing",
    "internal_attributes": [],
    "static_attributes": []
}

レスポンスには、entity_type などの各サービス・グループに関連付けられているすべてのデフォルトや、デフォルトのコマンド、または属性のマッピングなどが含まれます。

サービス・グループを更新¶

この例では、既存のサービス・グループを特定の resource パスおよび apikey で更新します。

サービス・グループの詳細は、/iot/services エンドポイントへの PUT リクエストを行い、resource および apikey パラメータを提供することによって更新できます。

19 リクエスト :¶

curl -iX PUT \
  'http://localhost:4041/iot/services?resource=/iot/d&apikey=4jggokgpepnvsb2uv4s40d59ov' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "entity_type": "IoT-Device"
}'

サービス・グループを削除¶

この例では、/iot/services/ エンドポイントに DELETE リクエストを行うことによって、プロビジョニングされたサービス・グループを削除します。

つまり、IoT Agent がノース・バウンド通信をリスンしている http://iot-agent:7896/iot/d?i=<device_id>&k=4jggokgpepnvsb2uv4s40d59ov へのリクエストは、IoT Agent によって処理されなくなります。削除するサービス・グループを識別するには、apiKey パラメータと resource パラメータを指定する必要があります。

20 リクエスト :¶

curl -iX DELETE \
  'http://localhost:4041/iot/services/?resource=/iot/d&apikey=4jggokgpepnvsb2uv4s40d59ov' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

デバイスの CRUD アクション¶

個々のデバイスをプロビジョニングするための CRUD 操作は、/iot/devices エンドポイントの下にある期待される HTTP 動詞にマッピングされます

Create - HTTP POST
Read - HTTP GET
Update - HTTP PUT
Delete - HTTP DELETE

<device-id> を使用して、デバイスを一意に識別します。

プロビジョニングされたデバイスの作成¶

この例では個々のデバイスをプロビジョニングします。device_id=bell002 をエンティティ urn:ngsi-ld:Bell:002 にマップし、エンティティに Bell 型を与えます。IoT Agent は、デバイスが単一の ring command を提供し、HTTP を使用して http://iot-sensors:3001/iot/bell002 でリッスンしていることを通知されました。attributes, lazy 属性と、static_attributes もプロビジョニングできます。

21 リクエスト :¶

curl -iX POST \
  'http://localhost:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "devices": [
    {
      "device_id": "bell002",
      "entity_name": "urn:ngsi-ld:Bell:002",
      "entity_type": "Bell",
      "protocol": "PDI-IoTA-UltraLight",
      "transport": "HTTP",
      "endpoint": "http://iot-sensors:3001/iot/bell002",
      "commands": [
        {
          "name": "ring",
          "type": "command"
        }
       ],
       "static_attributes": [
         {"name":"refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:002"}
      ]
    }
  ]
}'

プロビジョニングされたデバイスの詳細を読み込む¶

この例では、指定された <device-id> パスを持つプロビジョニングされたデバイスの完全な詳細を取得します。

プロビジョニングされたデバイスの詳細は、/iot/devices/<device-id> エンドポイントに GET リクエストを行うことで読み取ることができます。

22 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/devices/bell002' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

レスポンスには、デバイスに関連付けられているすべてのコマンドと属性のマッピングが含まれています。

{
    "device_id": "bell002",
    "service": "openiot",
    "service_path": "/",
    "entity_name": "urn:ngsi",
    "entity_type": "Bell",
    "endpoint": "http://iot-sensors:3001/iot/bell002",
    "transport": "HTTP",
    "attributes": [],
    "lazy": [],
    "commands": [
        {
            "object_id": "ring",
            "name": "ring",
            "type": "command"
        }
    ],
    "static_attributes": [
        {
            "name": "refStore",
            "type": "Relationship",
            "value": "urn:ngsi-ld:Store:002"
        }
    ],
    "protocol": "PDI-IoTA-UltraLight"
}

プロビジョニングされたすべてのデバイスを一覧表示¶

この例では、/iot/devices エンドポイントに GET リクエストを行うことによって、プロビジョニングされたすべてのデバイスを一覧表示します。

23 リクエスト :¶

curl -X GET \
  'http://localhost:4041/iot/devices' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

レスポンス :¶

レスポンスには、すべてのデバイスに関連付けられているすべてのコマンドと属性のマッピングが含まれます。

{
    "count": 5,
    "devices": [
      {
          "device_id": "bell002",
          "service": "openiot",
          "service_path": "/",
          "entity_name": "urn:ngsi",
          "entity_type": "Bell",
          "endpoint": "http://iot-sensors:3001/iot/bell002",
          "transport": "HTTP",
          "attributes": [],
          "lazy": [],
          "commands": [
              {
                  "object_id": "ring",
                  "name": "ring",
                  "type": "command"
              }
          ],
          "static_attributes": [
              {
                  "name": "refStore",
                  "type": "Relationship",
                  "value": "urn:ngsi-ld:Store:002"
              }
          ],
          "protocol": "PDI-IoTA-UltraLight"
      },
      etc...
    ]
}

プロビジョニングされたデバイスを更新¶

この例では、/iot/devices/<device-id> エンドポイントに PUT リクエストを行うことによって、既存のプロビジョニングされたデバイスを更新します。

24 リクエスト :¶

curl -iX PUT \
  'http://localhost:4041/iot/devices/bell002' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
  "entity_type": "IoT-Device"
}'

プロビジョニングされたデバイスを削除¶

この例では、/iot/devices/<device-id> エンドポイントに DELETE リクエストを行うことによって、プロビジョニングされたデバイスを削除します。

デバイスの属性はマップされなくなり、コマンドはデバイスに送信できなくなります。デバイスがアクティブな測定を行っていると、関連付けられたサービスが削除されていない場合でも、デフォルト値で処理されます。

25 リクエスト :¶

curl -iX DELETE \
  'http://localhost:4041/iot/devices/bell002' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /'

IoT Agent とは何ですか？¶

サウス・バウンドのトラフィック (コマンド)¶

ノース・バウンドのトラフィック (測定)¶

共通の機能¶

デバイス・モニタ¶

アーキテクチャ¶

ダミー IoT デバイスの設定¶

IoT Agent for UltraLight 2.0 の設定¶

前提条件¶

Docker¶

Cygwin for Windows¶

Start Up¶

IoT Agent のプロビジョニング¶

デバイス・モニタ¶

IoT Agent サービスの正常性の確認¶

1 リクエスト :¶

IoT デバイスの接続¶

サービス・グループのプロビジョニング¶

2 リクエスト :¶

センサのプロビジョニング¶

3 リクエスト :¶

4 リクエスト :¶

5 リクエスト :¶

レスポンス :¶

コマンドを介したアクチュエータのプロビジョニング¶

6 リクエスト :¶

双方向属性 (bidirectional attribute) を介したアクチュエータのプロビジョニング¶

7 リクエスト :¶

8 リクエスト :¶

9 リクエスト :¶

レスポンス :¶

スマート・ドアのプロビジョニング¶

10 リクエスト :¶

スマート・ランプのプロビジョニング¶

11リクエスト :¶

12 リクエスト :¶

Context Broker コマンド の有効化¶

ベルを鳴らす¶

13 リクエスト :¶

スマート・ドアを開く¶

14 リクエスト :¶

スマート・ランプをオンにする¶

15 リクエスト :¶

サービス・グループの CRUD アクション¶

サービス・グループの作成¶

16 リクエスト :¶

サービス・グループの詳細を読み込む¶

17 リクエスト :¶

レスポンス :¶

すべてのサービス・グループを一覧表示¶

18 リクエスト :¶

レスポンス :¶

サービス・グループを更新¶

19 リクエスト :¶

サービス・グループを削除¶

20 リクエスト :¶

デバイスの CRUD アクション¶

プロビジョニングされたデバイスの作成¶

21 リクエスト :¶

プロビジョニングされたデバイスの詳細を読み込む¶

22 リクエスト :¶

レスポンス :¶

プロビジョニングされたすべてのデバイスを一覧表示¶

23 リクエスト :¶

レスポンス :¶

プロビジョニングされたデバイスを更新¶

24 リクエスト :¶

プロビジョニングされたデバイスを削除¶

25 リクエスト :¶

License¶

Context Broker コマンドの有効化¶