FIWARE IoT Agent for JSON (http) によるデバイス制御 -Raspberry Pi

本記事では、液晶ディスプレイ (LCD) が接続された、JSON-http 対応デバイスを作成し、これを Orion から制御して、LCD にイメージの表示を行います。

FIWARE IoT Agent for JSON (http) 対応デバイス

FIWARE には、IoT Agent と呼ばれる、既存の IoT プロトコルと NGSI の橋渡しをする　Generic Enabler があります。これを利用すると、既存 IoT プロトコルを使用して、エンティティ情報を更新することができます。各種 IoT プロトコルに対応した、複数の IoT Agent があり、IDAS と呼ばれています。

FIWARE は、センサからコンテキスト情報を収集するだけでなく、デバイスを制御することもできます。Orion のコンテキスト情報の属性値を変更することで、デバイスの状態を変更できます。本記事では、LCD が接続された、JSON-http 対応デバイスを作成し、これを Orion から制御して、LCD にイメージの表示を行います。

サーバ側には、Orion と IoT Agent for JSON をデプロイします。JSON-http に対応した IoT デバイスには、Raspberry Pi を使用します。

前提条件

次の環境が必要となります。

FIWARE Orion, IoT Agent が稼働する Linux サーバ環境
Raspberry Pi (i2c, spi を有効化)
環境センサ Enviro for Raspberry Pi (Pimoroni)
git, curl, jq コマンド

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/07.json-http-lcd” ディレクトリに移動してください。

git clone https://github.com/lets-fiware/lets-fiware.tutorials.git
cd ./lets-fiware.tutorials/raspberrypi/07.json-http-lcd

システム構成

Linux サーバには、Orion と IoT Agent for JSON をデプロイします。Raspberry Pi は、JSON-http に対応した FIWARE IoT Device として動作します。

サーバ環境の作成

docker-compose ファイル

Orion, IoT Agent for JSON は、Docker コンテナを利用して、サーバ上にデプロイします。クローンしたリポジトリには、x86_64 (amd64) 用と Raspberry Pi (aarch64) 用の dokcer-compose ファイルがあります。環境に応じて、以下の設定を行います。

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 に関連する一連のコンテナが実行されます。

docker-compose up -d

Raspberry Pi での環境変数の設定

Raspberry Pi で Orion と IoT Agent にアクセスするための環境変数を設定します。コンテナが稼働するサーバの IP アドレスを 192.168.1.1 として説明しています。環境に合わせて、値を変更してください。

export IOTA_IP=192.168.1.1
export ORION_URL=http://192.168.1.1:1026

正常性の確認

Raspberry Pi から Orion のバージョン取得や、IoT Agent に次のクエリを実行して、正しくデプロイされたことを確認してください。IoT Agent の場合、以下のクエリで正常性を確認できます。

GET /iot/about

次のコマンドを実行して、Iot Agent からレスポンスが返ってくることを確認してください。

./00.version.sh

結果

{
  "libVersion": "2.12.0",
  "port": "4041",
  "baseRoot": "/",
  "version": "1.14.0"
}

{

"libVersion": "2.12.0",

"port": "4041",

"baseRoot": "/",

"version": "1.14.0"

}

JSON 対応デバイスの作成

プログラム全体

Raspberry Pi を利用して、JSON-http 対応デバイスの作成します。プログラムは次のとおりです。IoT Agent からのリクエストをポート 8080 で待ち受ける Web サーバで、IoT Agent から /iot/led001 へ POST リクエストを受け付けます。POST の Payload は、JSON 形式で、LED の ON/OFF の状態を表すパラメータが含まれてます。これにしたがって、LED の状態を変更します。

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import os
import sys
import signal
from http.server import BaseHTTPRequestHandler, HTTPServer
from urllib.parse import parse_qs, urlparse
import json
import ST7735
from PIL import Image, ImageDraw

def handler(signum, frame):
  sys.exit(0)

class LcdHTTPRequestHandler(BaseHTTPRequestHandler):
  def do_POST(self):
    parsed_path = urlparse(self.path)

    content_length = int(self.headers['content-length'])
    body = '{}'.format(self.rfile.read(content_length).decode('utf-8'))

    cmd = json.loads(body)

    if (debug):
      print('path = {}'.format(self.path))
      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)

    self.send_response(200)
    self.send_header('Content-Type', 'application/json; charset=utf-8')
    self.end_headers()
    self.wfile.write(json.dumps(cmd).encode('utf-8'))

if __name__ == '__main__':
  signal.signal(signal.SIGTERM, handler)
  signal.signal(signal.SIGINT, handler)

  device_id = 'urn:ngsi-ld:Lcd:' + os.environ.get('DEVCIE_ID', 'lcd001')
  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 display.
  disp.begin()
  fiware_img = Image.open('./fiware.png')
  blank_img = Image.new('RGB', (disp.width, disp.height), color=(0, 0, 0))

  print('Start Lcd device server')
  address = ('0.0.0.0', 8080)
  with HTTPServer(address, LcdHTTPRequestHandler) as server:
    server.serve_forever()

#!/usr/bin/env python3

# -*- coding: utf-8 -*-

import os

import sys

import signal

from http.server import BaseHTTPRequestHandler, HTTPServer

from urllib.parse import parse_qs, urlparse

import json

import ST7735

from PIL import Image, ImageDraw

def handler(signum, frame):

sys.exit(0)

class LcdHTTPRequestHandler(BaseHTTPRequestHandler):

def do_POST(self):

parsed_path = urlparse(self.path)

content_length = int(self.headers['content-length'])

body = '{}'.format(self.rfile.read(content_length).decode('utf-8'))

cmd = json.loads(body)

if (debug):

print('path = {}'.format(self.path))

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)

self.send_response(200)

self.send_header('Content-Type', 'application/json; charset=utf-8')

self.end_headers()

self.wfile.write(json.dumps(cmd).encode('utf-8'))

if __name__ == '__main__':

signal.signal(signal.SIGTERM, handler)

signal.signal(signal.SIGINT, handler)

device_id = 'urn:ngsi-ld:Lcd:' + os.environ.get('DEVCIE_ID', 'lcd001')

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 display.

disp.begin()

fiware_img = Image.open('./fiware.png')

blank_img = Image.new('RGB', (disp.width, disp.height), color=(0, 0, 0))

print('Start Lcd device server')

address = ('0.0.0.0', 8080)

with HTTPServer(address, LcdHTTPRequestHandler) as server:

server.serve_forever()

JSON-http 対応デバイスの実行

Docker コンテナ内での実行

Docker コンテナ・イメージの取得

JSON-http 対応デバイス用のコンテナ・イメージを Docker Hubから取得します。次のコマンドで、fisuda/json-http-lcd-01 という名前のコンテナ・イメージを取得できます。

./pull.sh

Docker コンテナのビルド

プログラムをDocker コンテナ内で実行するため、JSON-http 対応デバイス用コンテナをビルドします。ビルドには以下のコマンドを実行してい下さい。fisuda/json-http-lcd-01 という名前のコンテナ・イメージが作成されます。

./build.sh

Docker コンテナの起動

Dokcer コンテナを起動することで、プログラムを実行できます。

./run.sh

コンソールの出力

次のコマンドを実行することで、コンソールの出力を確認できます。

./logs.sh

コンテナの停止

次のコマンドを実行することで、コンテナを停止できます。

./stop.sh

環境変数の設定

IoT Agent が Raspberry Pi で稼働する JSON-http 対応デバイスのコンテナにアクセスできるよう、Raspberry Pi で環境変数を設定します。Raspberry Pi の IP アドレスが、192.168.1.2 の場合、次のように設定します。IP アドレスは環境に合わせて変更してください。

export DEVICE_URL=http://192.168.1.2:8080

JSON-http 対応デバイスの接続

JSON-http 対応デバイスを IoT Agent に登録します。このため、最初にサービス・グループをプロビジョニングし、次にデバイスをプロビジョニングします。

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

次のようなクエリを IoT Agent のポート 4041 に POST することで、サービス・グループのプロビジョニングができます。

#!/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":      "4jggokgpepnvsb2uv4s40d59ov",
     "cbroker":     "http://192.168.1.1:1026",
     "entity_type": "Thing",
     "resource":    "/iot/json"
   }
 ]
}'

#!/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": "4jggokgpepnvsb2uv4s40d59ov",

"cbroker": "http://192.168.1.1:1026",

"entity_type": "Thing",

"resource": "/iot/json"

}

]

次のコマンドを実行して、サービス・グループをプロビジョニングしてください。正常に実行できると、201 Created のステータス・コードが返されます。

./01.create_service_group.sh

次のコマンドを実行すると、プロビジョニングされたサービス・グループの一覧を表示できます。

./02.list_service_group.sh

結果

{
  "count": 1,
  "services": [
    {
      "commands": [],
      "lazy": [],
      "attributes": [],
      "_id": "5ed2eb9e5a08c60006fe57fa",
      "resource": "/iot/json",
      "apikey": "4jggokgpepnvsb2uv4s40d59ov",
      "service": "openiot",
      "subservice": "/",
      "__v": 0,
      "static_attributes": [],
      "internal_attributes": [],
      "entity_type": "Thing"
    }
  ]
}

{

"count": 1,

"services": [

{

"commands": [],

"lazy": [],

"attributes": [],

"_id": "5ed2eb9e5a08c60006fe57fa",

"resource": "/iot/json",

"apikey": "4jggokgpepnvsb2uv4s40d59ov",

"service": "openiot",

"subservice": "/",

"__v": 0,

"static_attributes": [],

"internal_attributes": [],

"entity_type": "Thing"

}

]

}

JSON-http 対応デバイスのプロビジョニング

次のようなクエリで、JSON-http 対応デバイスをプロビジョニングできます。

#!/bin/sh
curl -iX POST \
  'http://192.168.1.1:4041/iot/devices' \
  -H 'Content-Type: application/json' \
  -H 'fiware-service: openiot' \
  -H 'fiware-servicepath: /' \
  -d '{
 "devices": [
   {
     "device_id":   "lcd001",
     "entity_name": "urn:ngsi-ld:Lcd:lcd001",
     "entity_type": "Lcd",
     "timezone":    "Asia/Tokyo",
     "transport":   "HTTP",
     "endpoint":    "http://192.168.1.1:8080/iot/lcd001",
     "commands": [
        {"name": "on", "type": "command"},
        {"name": "off", "type": "command"}
     ]
   }
 ]
}
'

#!/bin/sh

curl -iX POST \

'http://192.168.1.1:4041/iot/devices' \

-H 'Content-Type: application/json' \

-H 'fiware-service: openiot' \

-H 'fiware-servicepath: /' \

-d '{

"devices": [

{

"device_id": "lcd001",

"entity_name": "urn:ngsi-ld:Lcd:lcd001",

"entity_type": "Lcd",

"timezone": "Asia/Tokyo",

"transport": "HTTP",

"endpoint": "http://192.168.1.1:8080/iot/lcd001",

"commands": [

{"name": "on", "type": "command"},

{"name": "off", "type": "command"}

]

}

]

}

次のコマンドを実行して、JSON-http 対応デバイスをプロビジョニングしてください。正常に実行できると、201 Created のステータス・コードが返されます。

./11.create_device.sh

次のコマンドを実行すると、プロビジョニングされたデバイスの一覧を表示できます。

./12.list_device.sh

結果

{
  "count": 1,
  "devices": [
    {
      "device_id": "lcd001",
      "service": "openiot",
      "service_path": "/",
      "entity_name": "urn:ngsi-ld:Lcd:lcd001",
      "entity_type": "Lcd",
      "endpoint": "http://192.168.11.210:8080/iot/lcd001",
      "transport": "HTTP",
      "attributes": [],
      "lazy": [],
      "commands": [
        {
          "object_id": "on",
          "name": "on",
          "type": "command"
        },
        {
          "object_id": "off",
          "name": "off",
          "type": "command"
        }
      ],
      "static_attributes": []
    }
  ]
}

{

"count": 1,

"devices": [

{

"device_id": "lcd001",

"service": "openiot",

"service_path": "/",

"entity_name": "urn:ngsi-ld:Lcd:lcd001",

"entity_type": "Lcd",

"endpoint": "http://192.168.11.210:8080/iot/lcd001",

"transport": "HTTP",

"attributes": [],

"lazy": [],

"commands": [

{

"object_id": "on",

"name": "on",

"type": "command"

{

"object_id": "off",

"name": "off",

"type": "command"

}

"static_attributes": []

}

]

}

LCD の制御

JSON-http 対応デバイスの起動

サーバ環境の作成、デバイスのプロビジョニングが完了したら、JSON-http 対応デバイスのコンテナを起動するため、Raspberry Pi で、./run.sh コマンドを実行します。./logs.sh コマンドでコンソール出力を確認します。次のような出力があれば、コンテナが起動できています。

Start Lcd device server

1	Start Lcd device server

イメージの表示

Orion に次のような PATCH リクエストをすることで、LCD にイメージを表示します。

PATCH /v2/entities/urn:ngsi-ld:Lcd:lcd001/attrs

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" : ""
  }
}'

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 のイメージを非表示にできます。

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" : ""
  }
}'

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 のリクエストを受けると、次のようなログが記録されます。

Start Lcd device server
path = /iot/lcd001
{'on': ''}
192.168.1.1 - - [31/May/2020 00:06:53] "POST /iot/lcd001 HTTP/1.1" 200 -
path = /iot/lcd001
{'on': ''}
192.168.1.1 - - [31/May/2020 00:06:56] "POST /iot/lcd001 HTTP/1.1" 200 -
path = /iot/lcd001
{'off': ''}
192.168.1.1 - - [31/May/2020 00:07:31] "POST /iot/lcd001 HTTP/1.1" 200 -
path = /iot/lcd001
{'on': ''}
192.168.1.1 - - [31/May/2020 00:18:06] "POST /iot/lcd001 HTTP/1.1" 200 -
path = /iot/lcd001
{'off': ''}
192.168.1.1 - - [31/May/2020 00:18:08] "POST /iot/lcd001 HTTP/1.1" 200 -
path = /iot/lcd001
{'on': ''}
192.168.1.1 - - [31/May/2020 00:18:11] "POST /iot/lcd001 HTTP/1.1" 200 -

Start Lcd device server

path = /iot/lcd001

{'on': ''}

192.168.1.1 - - [31/May/2020 00:06:53] "POST /iot/lcd001 HTTP/1.1" 200 -

path = /iot/lcd001

{'on': ''}

192.168.1.1 - - [31/May/2020 00:06:56] "POST /iot/lcd001 HTTP/1.1" 200 -

path = /iot/lcd001

{'off': ''}

192.168.1.1 - - [31/May/2020 00:07:31] "POST /iot/lcd001 HTTP/1.1" 200 -

path = /iot/lcd001

{'on': ''}

192.168.1.1 - - [31/May/2020 00:18:06] "POST /iot/lcd001 HTTP/1.1" 200 -

path = /iot/lcd001

{'off': ''}

192.168.1.1 - - [31/May/2020 00:18:08] "POST /iot/lcd001 HTTP/1.1" 200 -

path = /iot/lcd001

{'on': ''}

192.168.1.1 - - [31/May/2020 00:18:11] "POST /iot/lcd001 HTTP/1.1" 200 -

エンティティの確認

Orion に対して次のようなクエリを実行して、エンティティ lcd001 のコンテキスト情報を確認します。

GET /v2/entities/urn:ngsi-ld:Lcd:lcd001

クエリの実行

次のコマンドを実行して、コンテキスト情報を確認します。

./21.get_entity.sh

実行結果

On, Off コマンドの実行した時刻や実行結果のステータスが確認できます。

{
  "id": "urn:ngsi-ld:Lcd:lcd001",
  "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": {}
  }
}

{

"id": "urn:ngsi-ld:Lcd:lcd001",

"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-http 対応デバイス・コンテナの停止

次のコマンドで、JSON-http 対応デバイス・コンテナを停止できます。

./stop.sh

デバイスの削除

次のコマンドで、Iot Agent にプロビジョニングしたデバイスを削除できます。

./13.delete_device.sh

サービス・グループの削除

次のコマンドで、Iot Agent にプロビジョニングしたサービス・グループを削除できます。

./03.delete_service_group.sh

エンティティの削除

次のコマンドで、Orion にある、lcd001 のエンティティを削除できます。

./22.delete_entity.sh

Let’s FIWARE Tutorialsセットアップ WireCloud のセットアップオープンデータの可視化避難場所のオープンデータを可視化 ...

FIWARE IoT Agent for JSON (http) 対応デバイス

前提条件

ソースコード

システム構成

サーバ環境の作成

docker-compose ファイル

x86_64 (amd64)

Raspberry Pi (aarch64)

Docker コンテナの起動

Raspberry Pi での環境変数の設定

正常性の確認

結果

JSON 対応デバイスの作成

プログラム全体

JSON-http 対応デバイスの実行

Docker コンテナ内での実行

Docker コンテナ・イメージの取得

Docker コンテナのビルド

Docker コンテナの起動

コンソールの出力

コンテナの停止

環境変数の設定

JSON-http 対応デバイスの接続

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

結果

JSON-http 対応デバイスのプロビジョニング

結果

LCD の制御

JSON-http 対応デバイスの起動

イメージの表示

イメージの非表示

ログの確認

エンティティの確認

クエリの実行

実行結果

環境設定のクリーンアップ

JSON-http 対応デバイス・コンテナの停止

デバイスの削除

サービス・グループの削除

エンティティの削除

FIWARE IoT Agent for JSON (http) 対応デバイスの作成...

sakura.io を利用した FIWARE デジタルツイン・システムの構築 (We...

FIWARE IoT Agent for JSON (MQTT) 対応デバイスの作成...

マラガの FIWARE Global Summit ’18 へのご参加、ありがとうございました

Towards a Digital Single Market for Smart Cities

FIWARE はスマート・シティをトランスフォーメーションの旅に導きます

FIWARE による IDS コンセプトの実装