本記事では、液晶ディスプレイ (LCD) が接続された、JSON-MQTT 対応デバイス を作成し、これを Orion から制御して、LCD にイメージの表示を行います。
FIWARE IoT Agent for Ultralight 2.0 (MQTT) 対応デバイス
FIWARE には、IoT Agent と呼ばれる、既存の IoT プロトコルと NGSI の橋渡しをする Generic Enabler があります。これを利用すると、既存 IoT プロトコルを使用して、エンティティ情報を更新することができます。各種 IoT プロトコルに対応した、複数の IoT Agent があり、IDAS と呼ばれています。
FIWARE は、センサからコンテキスト情報を収集するだけでなく、デバイスを制御することもできます。Orion のコンテキスト情報の属性値を変更することで、デバイスの状態を変更できます。本記事では、LCD が接続された、JSON-MQTT 対応デバイス を作成し、これを Orion から制御して、LCD にイメージの表示を行います。
サーバ側には、Orion と IoT Agent for JSON をデプロイします。JSON-MQTT に対応した IoT デバイスには、Raspberry Pi を使用します。
前提条件
次の環境が必要となります。
- FIWARE Orion, IoT Agent が稼働する Linux サーバ環境
- Raspberry Pi
- 環境センサ Enviro for Raspberry Pi (Pimoroni)
Raspberry Pi の種類は、Raspberry Pi Zero WH, 3, 4 等です。Raspberry Pi 4 を使用すると、FIWARE Orion と 環境情報を収集するプログラムを1台で稼働できます。環境センサの Enviro は、発売元の Pimoroni から購入するか、国内では秋月電子通商、スイッチサイエンス等から購入できるようです。
ソースコード
使用するソースコードは、Github の https://github.com/lets-fiware/lets-fiware.tutorials から入手できます。git コマンドで、リポジトリをクローンして、”raspberrypi/09.json-mqtt-lcd” ディレクトリに移動してください。
git clone https://github.com/lets-fiware/lets-fiware.tutorials.git
cd ./lets-fiware.tutorials/raspberrypi/09.json-mqtt-lcd
システム構成
Linux サーバには、Orion と IoT Agent for JSON, Mosquitto をデプロイします。Raspberry Pi は、JSON-MQTT に対応した FIWARE IoT Device として動作します。
サーバ環境の作成
docker-compose ファイル
Orion, IoT Agent for JSON, Mosquitto は、Docker コンテナを利用して、サーバ上にデプロイします。クローンしたリポジトリには、x86_64 (amd64) 用 と Raspberry Pi (aarch64) 用の dokcer-compose.yml ファイルがあります。環境に応じて、以下の設定を行います。
x86_64 (amd64)
ln -s docker-compose-arm64.yml docker-compose.yml
Raspberry Pi (aarch64)
ln -s docker-compose-aarch64.yml docker-compose.yml
Docker コンテナの起動
次のコマンドで、Docker コンテナを起動します。これで、Orion, Iot Agent, Mosquitto に関連する一連のコンテナが実行されます。
docker-compose up -d
Raspberry Pi での環境変数の設定
Orion と IoT agent, Mosquitte にアクセスするための環境変数を設定します。コンテナが稼働するサーバの IP アドレスを 192.168.1.1 として説明しています。環境に合わせて、値を変更してください。
export IOTA_IP=192.168.1.1
export MQTT_IP=192.168.1.1
export ORION_URL=http://192.168.1.1:1026
正常性の確認
Raspberry Pi から Orion や IoT Agent のバージョン取得を実行して、正しくデプロイされたことを確認してください。IoT Agent の場合、以下のクエリで正常性を確認できます。
GET /iot/about
次のコマンドを実行して、レスポンスが返ってくることを確認してください。
./00.version.sh
結果
|
1 2 3 4 5 6 |
{ "libVersion": "2.12.0", "port": "4041", "baseRoot": "/", "version": "1.13.0" } |
JSON-MQTT 対応デバイスの作成
プログラム全体
Raspberry Pi を利用して、MQTT ベースの JSON-MQTT 対応デバイスの作成します。プログラムは次のとおりです。プログラムは MQTT Client として動作し、IoT Agent からのリクエストを MQTT Broker の Mosquitto を介して待ち受けます。MQTT のメッセージは、JSON 形式で、LED の ON/OFF の状態を表すパラメータが含まれてます。これにしたがって、LED の状態を変更します。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
#!/usr/bin/env python3 # -*- coding: utf-8 -*- import os import sys import signal import json import paho.mqtt.client as mqtt import ST7735 from PIL import Image, ImageDraw def handler(signum, frame): sys.exit(0) def on_connect(client, userdata, flags, response_code): print('Connected') topic = '/{}/{}/cmd'.format(key, device) client.subscribe(topic) def on_message(client, userdata, message): print(message.topic + ' ' + str(message.payload,'utf-8')) cmd = json.loads(str(message.payload,'utf-8')) if (debug): print(cmd) if cmd.get('on') != None: cmd['on'] = 'OK' disp.display(fiware_img) if cmd.get('off') != None: cmd['off'] = 'OK' disp.display(blank_img) topic = '/json/{}/{}/cmdexe'.format(key, device) client.publish(topic, json.dumps(cmd)) if __name__ == '__main__': signal.signal(signal.SIGTERM, handler) signal.signal(signal.SIGINT, handler) print('Start Lcd device server') host = os.environ.get('MQTT_IP', '192.168.11.1') port = os.environ.get('MQTT_PORT', 1883) key = os.environ.get('IOTA_KEY', '8f9z57ahxmtzx21oczr5vaabot') device = os.environ.get('DEVICE_ID', 'lcd002') debug = not not os.environ.get('DEBUG_FLAG', '') # Create LCD class instance. disp = ST7735.ST7735( port=0, cs=1, dc=9, backlight=12, rotation=270, spi_speed_hz=10000000 ) # Initialize LCD disp.begin() fiware_img = Image.open('./fiware.png') blank_img = Image.new('RGB', (disp.width, disp.height), color=(0, 0, 0)) # Initialize MQTT client = mqtt.Client() client.on_connect = on_connect client.on_message = on_message client.connect(host, port, 60) client.loop_forever() |
JSON-MQTT 対応デバイスの実行
Docker コンテナ内での実行
Docker コンテナ・イメージの取得
JSON-MQTT 対応デバイス用のコンテナ・イメージを Docker Hubから取得します。次のコマンドで、fisuda/json-mqtt-lcd-01 という名前のコンテナ・イメージを取得できます。
./pull.sh
Docker コンテナのビルド
プログラムをDocker コンテナ内で実行するため、JSON-MQTT 対応デバイス用コンテナをビルドします。ビルドには以下のコマンドを実行してい下さい。fisuda/json-mqtt-lcd-01 という名前のコンテナ・イメージが作成されます。
./build.sh
Docker コンテナの起動
Dokcer コンテナを起動することで、プログラムを実行できます。
./run.sh
コンソールの出力
次のコマンドを実行することで、コンソールの出力を確認できます。
./logs.sh
コンテナの停止
次のコマンドを実行することで、コンテナを停止できます。
./stop.sh
JSON-MQTT 対応デバイスの接続
JSON-MQTT 対応デバイスをIoT Agentに登録します。このため、最初にサービス・グループをプロビジョニングし、次にデバイスをプロビジョニングします。
サービス・グループのプロビジョニング
次のようなクエリを IoT Agent の ポート 4041 に POST することで、サービス・グループのプロビジョニングができます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
#!/bin/sh curl -iX POST \ 'http://192.168.1.1:4041/iot/services' \ -H 'Content-Type: application/json' \ -H 'fiware-service: openiot' \ -H 'fiware-servicepath: /' \ -d '{ "services": [ { "apikey": "8f9z57ahxmtzx21oczr5vaabot", "cbroker": "http://192.168.1.1:1026", "entity_type": "Thing", "resource": "" } ] }' |
次のコマンドを実行して、サービス・グループをプロビジョニングしてください。正常に実行できると、201 Created のステータス・コードが返されます。
./01.create_service_group.sh
次のコマンドを実行すると、プロビジョニングされたサービス・グループの一覧を表示できます。
./02.list_service_group.sh
結果
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
{ "count": 1, "services": [ { "commands": [], "lazy": [], "attributes": [], "_id": "5ed1bc911828dc0006657322", "resource": "", "apikey": "8f9z57ahxmtzx21oczr5vaabot", "service": "openiot", "subservice": "/", "__v": 0, "static_attributes": [], "internal_attributes": [], "entity_type": "Thing" } ] } |
JSON-MQTT 対応デバイスのプロビジョニング
次のようなクエリで、JSON-MQTT 対応デバイスをプロビジョニングします。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
#!/bin/bash : ${IOTA_IP:?Not found} : ${DEVICE_ID:=lcd002} curl -iX POST \ "http://$IOTA_IP:4041/iot/devices" \ -H 'Content-Type: application/json' \ -H 'fiware-service: openiot' \ -H 'fiware-servicepath: /' \ -d "{ \"devices\": [ { \"device_id\": \"$DEVICE_ID\", \"entity_name\": \"urn:ngsi-ld:Lcd:$DEVICE_ID\", \"entity_type\": \"Lcd\", \"timezone\": \"Asia/Tokyo\", \"protocol\": \"PDI-IoTA-Json\", \"transport\": \"MQTT\", \"commands\": [ {\"name\": \"on\",\"type\": \"command\"}, {\"name\": \"off\",\"type\": \"command\"} ] } ] }" |
次のコマンドを実行して、JSON-MQTT 対応デバイスをプロビジョニングしてください。正常に実行できると、201 Created のステータス・コードが返されます。
./11.create_device.sh
次のコマンドを実行すると、プロビジョニングされたデバイスの一覧を表示できます。
./12.list_device.sh
結果
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
{ "count": 1, "devices": [ { "device_id": "lcd002", "service": "openiot", "service_path": "/", "entity_name": "urn:ngsi-ld:Lcd:lcd002", "entity_type": "Lcd", "transport": "MQTT", "attributes": [], "lazy": [], "commands": [ { "object_id": "on", "name": "on", "type": "command" }, { "object_id": "off", "name": "off", "type": "command" } ], "static_attributes": [] } ] } |
LCDの制御
JSON-MQTT 対応デバイスの起動
サーバ環境の作成、デバイスのプロビジョニングが完了したら、JSON-MQTT 対応デバイスのコンテナを起動するため、Raspberry Pi で、./run.sh コマンドを実行します。./logs.sh コマンドでコンソール出力を確認します。次のような出力があれば、コンテナが起動して、MQTT Broker と接続ができています。
|
1 2 |
Start Lcd device server Connected |
イメージの表示
Orion に次のような PATCH リクエストをすることで、LCD にイメージを表示します。
PATCH /v2/entities/urn:ngsi-ld:Lcd:lcd001/attrs
|
1 2 3 4 5 6 7 8 9 10 |
curl -iX PATCH "http://192.168.1.1:1026/v2/entities/urn:ngsi-ld:Lcd:lcd001/attrs" \ -H 'Content-Type: application/json' \ -H 'fiware-service: openiot' \ -H 'fiware-servicepath: /' \ -d '{ "on": { "type" : "command", "value" : "" } }' |
31.on.sh コマンドを実行することで、実際に LCD にイメージが表示されます。
./31.on.sh
イメージの非表示
イメージの表示と同様に、Orion に PATCH リクエストをすることで、LCD のイメージを非表示にできます。
|
1 2 3 4 5 6 7 8 9 10 |
curl -iX PATCH "http://192.168.1.1:1026/v2/entities/urn:ngsi-ld:Lcd:lcd001/attrs" \ -H 'Content-Type: application/json' \ -H 'fiware-service: openiot' \ -H 'fiware-servicepath: /' \ -d '{ "off": { "type" : "command", "value" : "" } }' |
32.off.sh コマンドを実行することで、 LCD のイメージが非表示になります。
./32.off.sh
ログの確認
./log.sh コマンドで、ログを確認すると、On, Off のリクエストを受けると、次のようなログが記録されます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
Start Lcd device server Connected /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"on":""} {'on': ''} /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"off":""} {'off': ''} /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"on":""} {'on': ''} /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"off":""} {'off': ''} /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"on":""} {'on': ''} /8f9z57ahxmtzx21oczr5vaabot/lcd002/cmd {"off":""} {'off': ''} |
エンティティの確認
Orion に対して次のようなクエリを実行して、エンティティ lcd002 のコンテキスト情報を確認します。
GET /v2/entities/urn:ngsi-ld:Lcd:lcd002
クエリの実行
次のコマンドを実行して、コンテキスト情報を確認します。
./21.get_entity.sh
実行結果
On, Off コマンドの実行した時刻や実行結果のステータスが確認できます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
{ "id": "urn:ngsi-ld:Lcd:lcd002", "type": "Lcd", "TimeInstant": { "type": "DateTime", "value": "2020-05-31T00:07:30.00Z", "metadata": {} }, "off_info": { "type": "commandResult", "value": "OK", "metadata": { "TimeInstant": { "type": "DateTime", "value": "2020-05-31T00:07:30.00Z" } } }, "off_status": { "type": "commandStatus", "value": "OK", "metadata": { "TimeInstant": { "type": "DateTime", "value": "2020-05-31T00:07:30.00Z" } } }, "on_info": { "type": "commandResult", "value": "OK", "metadata": { "TimeInstant": { "type": "DateTime", "value": "2020-05-31T00:06:55.00Z" } } }, "on_status": { "type": "commandStatus", "value": "OK", "metadata": { "TimeInstant": { "type": "DateTime", "value": "2020-05-31T00:06:55.00Z" } } }, "on": { "type": "command", "value": "", "metadata": {} }, "off": { "type": "command", "value": "", "metadata": {} } } |
環境設定のクリーンアップ
JSON-MQTT 対応デバイス用コンテナの停止
次のコマンドで、JSON-MQTT 対応デバイス用コンテナを停止できます。
./stop.sh
デバイスの削除
次のコマンドで、Iot Agent にプロビジョニングしたデバイスを削除できます。
./13.delete_device.sh
サービス・グループの削除
次のコマンドで、Iot Agent にプロビジョニングしたサービス・グループを削除できます。
./03.delete_service_group.sh
エンティティの削除
次のコマンドで、Orion にある、lcd002 のエンティティを削除できます。
./22.delete_entity.sh
