Switch to JSON IoT Agent

Author: jason-fox

.env

@@ -22,8 +22,8 @@ CURL_VERSION=8.4.0
 MONGO_DB_PORT=27017
 MONGO_DB_VERSION=6.0
 
-# IoT Agent Ultralight Variables
-ULTRALIGHT_VERSION=3.6.0-distroless
+# IoT Agent JSON Variables
+JSON_VERSION=3.14.0-distroless
 IOTA_NORTH_PORT=4041
 IOTA_SOUTH_PORT=7896
 

.github/test/iot_device_smoke_test

@@ -0,0 +1,73 @@
+#!/bin/bash
+#
+# Smoke test: verify IoT device provisioning by sending an 'on' command to each
+# water sprinkler and confirming the context broker reflects the updated
+# on_status attribute after the full command round-trip:
+#   Orion → IoT Agent → iot-sensors simulator → IoT Agent → Orion
+#
+
+set -e
+
+export $(cat .env | grep "#" -v)
+
+BROKER="http://orion:1026"
+CONTEXT="http://context/user-context.jsonld"
+TENANT="openiot"
+DEVICES=("water001" "water002" "water003" "water004")
+
+failures=0
+
+run_curl () {
+    docker run --rm --network fiware_default quay.io/curl/curl:"${CURL_VERSION}" "$@"
+}
+
+send_on_command () {
+    local device="$1"
+    local status
+    status=$(run_curl -s -o /dev/null -w "%{http_code}" \
+        -L -X PATCH \
+        "${BROKER}/ngsi-ld/v1/entities/urn:ngsi-ld:Device:${device}/attrs/on" \
+        -H "NGSILD-Tenant: ${TENANT}" \
+        -H 'Content-Type: application/json' \
+        -H "Link: <${CONTEXT}>; rel=\"http://www.w3.org/ns/json-ld#context\"; type=\"application/ld+json\"" \
+        --data-raw '{"type":"Property","value":" "}')
+    if [ "${status}" != "204" ]; then
+        echo "FAIL [${device}]: on command returned HTTP ${status} (expected 204)"
+        return 1
+    fi
+    echo "PASS [${device}]: on command accepted (204)"
+}
+
+check_on_status () {
+    local device="$1"
+    local response
+    response=$(run_curl -s \
+        "${BROKER}/ngsi-ld/v1/entities/urn:ngsi-ld:Device:${device}" \
+        -H "NGSILD-Tenant: ${TENANT}" \
+        -H "Link: <${CONTEXT}>; rel=\"http://www.w3.org/ns/json-ld#context\"; type=\"application/ld+json\"" \
+        -H 'Accept: application/json')
+    if ! echo "${response}" | grep -q '"on_status"'; then
+        echo "FAIL [${device}]: on_status attribute missing from context broker"
+        echo "  Response: ${response}"
+        return 1
+    fi
+    echo "PASS [${device}]: on_status confirmed in context broker"
+}
+
+for device in "${DEVICES[@]}"; do
+    send_on_command "${device}" || failures=$((failures + 1))
+done
+
+echo "Waiting 5s for command round-trip..."
+sleep 5
+
+for device in "${DEVICES[@]}"; do
+    check_on_status "${device}" || failures=$((failures + 1))
+done
+
+echo ""
+if [ "${failures}" -gt 0 ]; then
+    echo "Smoke test FAILED: ${failures} assertion(s) did not pass"
+    exit 1
+fi
+echo "Smoke test PASSED: all water devices are responding and context broker is updated"

.github/workflows/ci.yml

@@ -28,8 +28,12 @@ jobs:
       run: |
         ./services create || true
     - name: Run Orion
-      run: |
-        ./services orion && ./services stop
+      run: ./services orion
+    - name: Smoke Test (Orion)
+      run: ./.github/test/iot_device_smoke_test
+    - name: Stop (Orion)
+      if: always()
+      run: ./services stop
     - name: Run Stellio
       run: |
         ./services stellio && ./services stop

README.ja.md

@@ -205,7 +205,7 @@ API を使いやすくし、開発者の負担を軽減するために、NGSI-LD
 このチュートリアルの目的のために、一連のダミーの農業用 IoT デバイスが作成され、Context Broker に接続されます。使用
 されているアーキテクチャとプロトコルの詳細は、
 [IoT センサ・チュートリアル](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-LD)にあります。各デバイスの
-状態は、 UltraLight デバイス・モニタの Web ページは次の場所にあります: `http://localhost:3000/device/monitor`
+状態は、 JSON デバイス・モニタの Web ページは次の場所にあります: `http://localhost:3000/device/monitor`
 
 ![FIWARE Monitor](https://fiware.github.io/tutorials.Concise-Format/img/farm-devices.png)
 
@@ -217,7 +217,7 @@ API を使いやすくし、開発者の負担を軽減するために、NGSI-LD
 
 このアプリケーションは、[以前のチュートリアル](https://github.com/FIWARE/tutorials.IoT-Agent/)で作成したコンポーネント
 とダミーの IoT デバイスに基づいて構築されています。[Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/)
-と [IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) の2つの FIWARE コンポーネントを
+と [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) の2つの FIWARE コンポーネントを
 使用します。
 
 したがって、アーキテクチャ全体は次の要素で構成されます:
@@ -227,10 +227,10 @@ API を使いやすくし、開発者の負担を軽減するために、NGSI-LD
     -   [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) は、
         [NGSI-LD](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/generated/full_api.json)
         を使用してリクエストを受信します
-    -   FIWARE [IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) は、
+    -   FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) は、
         [NGSI-LD](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/generated/full_api.json)
         を使用してサウスバウンド・リクエストを受信し、それらをデバイスの
-        [UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
+        [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
        コマンドに変換します
 
 -   [MongoDB](https://www.mongodb.com/) データベース:
@@ -243,7 +243,7 @@ API を使いやすくし、開発者の負担を軽減するために、NGSI-LD
 
 -   **チュートリアル・アプリケーション**は、以下のことを行います:
     -   HTTP を介して実行される
-        [UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
+        [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
         プロトコルを使用して、ダミーの[農業 IoT デバイス](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-LD)
         のセットとして機能します
 

README.md

@@ -207,7 +207,7 @@ designed to bridge the gap between the two.
 For the purpose of this tutorial, a series of dummy agricultural IoT devices have been created, which will be attached
 to the context broker. Details of the architecture and protocol used can be found in the
 [IoT Sensors tutorial](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-LD) The state of each device can be
-seen on the UltraLight device monitor web page found at: `http://localhost:3000/device/monitor`.
+seen on the JSON device monitor web page found at: `http://localhost:3000/device/monitor`.
 
 ![FIWARE Monitor](https://fiware.github.io/tutorials.Concise-Format/img/farm-devices.png)
 
@@ -218,19 +218,19 @@ seen on the UltraLight device monitor web page found at: `http://localhost:3000/
 This application builds on the components and dummy IoT devices created in
 [previous tutorials](https://github.com/FIWARE/tutorials.IoT-Agent/). It will use two FIWARE components: the
 [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) and the
-[IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/).
+[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/).
 
 Therefore the overall architecture will consist of the following elements:
 
 -   The **FIWARE Generic Enablers**:
 
     -   The [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests using
         [NGSI-LD](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/generated/full_api.json)
-    -   The FIWARE [IoT Agent for UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will
+    -   The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will
         receive southbound requests using
         [NGSI-LD](https://forge.etsi.org/swagger/ui/?url=https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/spec/updated/generated/full_api.json)
         and convert them to
-        [UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
+        [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
         commands for the devices
 
 -   A [MongoDB](https://www.mongodb.com/) database:
@@ -243,7 +243,7 @@ Therefore the overall architecture will consist of the following elements:
 -   The **Tutorial Application** does the following:
     -   Acts as set of dummy [agricultural IoT devices](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-LD)
         using the
-        [UltraLight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
+        [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
         protocol running over HTTP.
 
 Since all interactions between the elements are initiated by HTTP requests, the entities can be containerized and run

docker-compose/common.yml

@@ -59,7 +59,7 @@ services:
   iot-agent:
     labels:
       org.fiware: 'tutorial'
-    image: quay.io/fiware/iotagent-ul:${ULTRALIGHT_VERSION}
+    image: quay.io/fiware/iotagent-json:${JSON_VERSION}
     hostname: iot-agent
     container_name: fiware-iot-agent
     depends_on:
@@ -84,10 +84,9 @@ services:
       - IOTA_LOG_LEVEL=DEBUG # The log level of the IoT Agent
       - IOTA_TIMESTAMP=true # Supply timestamp information with each measurement
       - IOTA_AUTOCAST=true # Ensure Ultralight number values are read as numbers not strings
-      - IOTA_MONGO_HOST=mongo-db # The host name of MongoDB
-      - IOTA_MONGO_PORT=${MONGO_DB_PORT} # The port mongoDB is listening on
-      - IOTA_MONGO_DB=iotagentul # The name of the database used in mongoDB
-      - IOTA_HTTP_PORT=${IOTA_SOUTH_PORT} # The port used for device traffic over HTTP
+      - IOTA_MONGO_URI=mongodb://mongo-db:${MONGO_DB_PORT}/iotagentjson
+      - IOTA_HTTP_PORT=${IOTA_SOUTH_PORT}
+      - IOTA_DEFAULT_RESOURCE=/iot/json # The port used for device traffic over HTTP
       - IOTA_PROVIDER_URL=http://iot-agent:${IOTA_NORTH_PORT}
       - IOTA_CB_NGSI_VERSION=ld # use NGSI-LD when sending updates for active attributes
       - IOTA_JSON_LD_CONTEXT=http://context/user-context.jsonld
@@ -120,6 +119,8 @@ services:
       - IOTA_JSON_LD_CONTEXT=http://context/user-context.jsonld
 
 
+      - IOTA_DEFAULT_RESOURCE=/iot/json
+      - DUMMY_DEVICES_PAYLOAD=JSON
 networks:
   default:
     labels:

docker-compose/orion-ld.yml

@@ -53,6 +53,6 @@ services:
       - IOTA_DEFAULT_RESOURCE=/iot/d
       - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
       - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
-      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - DUMMY_DEVICES_PAYLOAD=JSON
       - CONTEXT_BROKER=http://orion:${ORION_LD_PORT}/ngsi-ld/v1 # URL of the context broker to update context
 

docker-compose/scorpio.yml

@@ -65,7 +65,7 @@ services:
       - IOTA_DEFAULT_RESOURCE=/iot/d
       - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
       - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
-      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - DUMMY_DEVICES_PAYLOAD=JSON
       - CONTEXT_BROKER=http://scorpio:${SCORPIO_PORT}/ngsi-ld/v1 # URL of the context broker to update context
 
 volumes:

docker-compose/stellio.yml

@@ -139,7 +139,7 @@ services:
       - IOTA_DEFAULT_RESOURCE=/iot/d
       - DUMMY_DEVICES_PORT=${TUTORIAL_DUMMY_DEVICE_PORT} # Port used by the dummy IOT devices to receive commands
       - DUMMY_DEVICES_TRANSPORT=HTTP # Default transport used by dummy Io devices
-      - DUMMY_DEVICES_PAYLOAD=ULTRALIGHT
+      - DUMMY_DEVICES_PAYLOAD=JSON
       - CONTEXT_BROKER=http://stellio:${STELLIO_PORT}/ngsi-ld/v1 # URL of the context broker to update context
 
 volumes: