Switch to JSON IoT Agent

jason-fox · jason-fox · commit ab64925237b2 · 2026-04-29T00:34:31.000+02:00
diff --git a/.env b/.env
@@ -9,8 +9,8 @@ ORION_VERSION=4.1.0
 MONGO_DB_PORT=27017
 MONGO_DB_VERSION=6.0
 
-# IoT Agent Ultralight Variables
-ULTRALIGHT_VERSION=3.7.0-distroless
+# IoT Agent JSON Variables
+JSON_VERSION=3.14.0-distroless
 IOTA_NORTH_PORT=4041
 IOTA_SOUTH_PORT=7896
 
diff --git a/.github/test/iot_device_smoke_test b/.github/test/iot_device_smoke_test
@@ -0,0 +1,96 @@
+#!/bin/bash
+#
+# Smoke test: verify IoT device provisioning by sending a 'ring' command to each
+# bell and confirming the context broker reflects the updated
+# ring_status attribute after the full command round-trip:
+#   Orion → IoT Agent → iot-sensors simulator → IoT Agent → Orion
+#
+
+set -e
+
+# Load environment variables if available
+if [ -f .env ]; then
+    export $(cat .env | grep "#" -v)
+fi
+
+BROKER="http://orion:1026"
+TENANT="openiot"
+DEVICES=("Bell:001" "Bell:002")
+
+failures=0
+
+run_curl () {
+    # If CURL_VERSION is not set, use latest
+    local curl_img="quay.io/curl/curl:${CURL_VERSION:-latest}"
+    docker run --rm --network fiware_default "${curl_img}" "$@"
+}
+
+send_ring_command () {
+    local device="$1"
+    local status
+    echo "Sending ring command to ${device}..."
+    status=$(run_curl -s -o /dev/null -w "%{http_code}" \
+        -X POST \
+        "${BROKER}/v2/op/update" \
+        -H "fiware-service: ${TENANT}" \
+        -H "fiware-servicepath: /" \
+        -H 'Content-Type: application/json' \
+        --data-raw '{
+          "actionType": "update",
+          "entities": [
+            {
+              "id": "'"${device}"'",
+              "type": "Bell",
+              "ring": {
+                "type": "command",
+                "value": ""
+              }
+            }
+          ]
+        }')
+    if [ "${status}" != "204" ]; then
+        echo "FAIL [${device}]: ring command returned HTTP ${status} (expected 204)"
+        return 1
+    fi
+    echo "PASS [${device}]: ring command accepted (204)"
+}
+
+check_ring_status () {
+    local device="$1"
+    local response
+    echo "Checking ring_status for ${device}..."
+    response=$(run_curl -s \
+        "${BROKER}/v2/entities/${device}?attrs=ring_status" \
+        -H "fiware-service: ${TENANT}" \
+        -H "fiware-servicepath: /" \
+        -H 'Accept: application/json')
+    if ! echo "${response}" | grep -q '"ring_status"'; then
+        echo "FAIL [${device}]: ring_status attribute missing from context broker"
+        echo "  Response: ${response}"
+        return 1
+    fi
+    if ! echo "${response}" | grep -q '"value":"OK"'; then
+         echo "FAIL [${device}]: ring_status is not OK"
+         echo "  Response: ${response}"
+         return 1
+    fi
+    echo "PASS [${device}]: ring_status confirmed as OK in context broker"
+}
+
+for device in "${DEVICES[@]}"; do
+    send_ring_command "${device}" || failures=$((failures + 1))
+done
+
+echo "Waiting 5s for command round-trip..."
+sleep 5
+
+for device in "${DEVICES[@]}"; do
+    check_ring_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 bell devices are responding and context broker is updated"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,4 +29,6 @@ jobs:
         ./services create || true
     - name: Run Script
       run: |
-        ./services start && ./services stop
+        ./services start
+        ./.github/test/iot_device_smoke_test
+        ./services stop
diff --git a/README.ja.md b/README.ja.md
@@ -140,7 +140,7 @@ FIWARE [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) は、永続
 このチュートリアルの目的のために、一連のダミー IoT デバイスが作成され、Context Broker に接続されます。使用しているアーキ
 テクチャとプロトコルの詳細は
 、[IoT Sensors チュートリアル](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-v2)にあります。各デバイスの状態
-は、次の UltraLight デバイス・モニタの Web ページで確認できます : `http://localhost:3000/device/monitor`
+は、次の JSON デバイス・モニタの Web ページで確認できます : `http://localhost:3000/device/monitor`
 
 ![FIWARE Monitor](https://fiware.github.io/tutorials.Time-Series-Data/img/device-monitor.png)
 
@@ -159,7 +159,7 @@ FIWARE [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) は、永続
 
 このアプリケーションは、[以前のチュートリアル](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/)
+。[Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/)，[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/)
 および [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) の 3 つの FIWARE コンポーネントを使用します。
 
 したがって、全体的なアーキテクチャは次の要素で構成されます :
@@ -168,7 +168,7 @@ FIWARE [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) は、永続
 
     -   FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) は
         、[NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) を使用してリクエストを受信します
-    -   FIWARE [IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) は、Ultralight 2.0
+    -   FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) は、JSON
         形式のダミー IoT デバイスからノース・バウンドの測定値を受信し、Context Broker の
         [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) リクエストに変換してコンテキスト・エンティティ
         の状態を変更します
@@ -187,7 +187,7 @@ FIWARE [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) は、永続
     -   時間ベースのデータクエリを解釈する HTTP エンドポイントを提供します
 
 -   **コンテキストプロバイダ** : - 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-v2)のセットと
     して機能する Web サーバです。 - このチュートリアルでは、 **コンテキスト・プロバイダの NGSI proxy** は使用しません
 
diff --git a/README.md b/README.md
@@ -137,7 +137,7 @@ available licensed under the Apache License 2.0. More information can be found a
 For the purpose of this tutorial, a series of dummy 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-v2). 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.Time-Series-Data/img/device-monitor.png)
 
@@ -153,7 +153,7 @@ web page found at: `http://localhost:3000/device/history/urn:ngsi-ld:Store:001`
 This application builds on the components and dummy IoT devices created in
 [previous tutorials](https://github.com/FIWARE/tutorials.IoT-Agent/). It will use three FIWARE components: the
 [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/), the
-[IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/), and
+[IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/), and
 [QuantumLeap](https://smartsdk.github.io/ngsi-timeseries-api/) .
 
 Therefore the overall architecture will consist of the following elements:
@@ -162,9 +162,9 @@ Therefore the overall architecture will consist of the following elements:
 
     -   The FIWARE [Orion Context Broker](https://fiware-orion.readthedocs.io/en/latest/) which will receive requests
         using [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2)
-    -   The FIWARE [IoT Agent for Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/) which will
-        receive northbound measurements from the dummy IoT devices in
-        [Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
+    -   The FIWARE [IoT Agent for JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/) which will receive
+        northbound measurements from the dummy IoT devices in
+        [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
         format and convert them to [NGSI-v2](https://fiware.github.io/specifications/OpenAPI/ngsiv2) requests for the
         context broker to alter the state of the context entities
     -   FIWARE [QuantumLeap](https://quantumleap.readthedocs.io/en/latest/) subscribed to context changes and persisting
@@ -183,9 +183,9 @@ Therefore the overall architecture will consist of the following elements:
 
 -   A **Context Provider**: - A webserver acting as set of
     [dummy IoT devices](https://github.com/FIWARE/tutorials.IoT-Sensors/tree/NGSI-v2) using the
-    [Ultralight 2.0](https://fiware-iotagent-ul.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual)
-    protocol running over HTTP. - Note the **Stock Management Frontend** and **Context Provider NGSI** proxy are not
-    used in this tutorial.
+    [JSON](https://fiware-iotagent-json.readthedocs.io/en/latest/usermanual/index.html#user-programmers-manual) protocol
+    running over HTTP. - Note the **Stock Management Frontend** and **Context Provider NGSI** proxy are not used in this
+    tutorial.
 
 Since all interactions between the elements are initiated by HTTP requests, the entities can be containerized and run
 from exposed ports.
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -58,11 +58,11 @@ services:
     healthcheck:
       test: curl --fail -s http://quantumleap:${QUANTUMLEAP_PORT}/version || exit 1
   
-  # IoT-Agent is configured for the UltraLight Protocol
+  # IoT-Agent is configured for the JSON Protocol
   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:
@@ -82,9 +82,7 @@ services:
       - IOTA_TIMESTAMP=true # Supply timestamp information with each measurement
       - IOTA_CB_NGSI_VERSION=v2 # use NGSIv2 when sending updates for active attributes
       - 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_MONGO_URI=mongodb://mongo-db:${MONGO_DB_PORT}/iotagentjson # The name of the database used in mongoDB
       - IOTA_HTTP_PORT=${IOTA_SOUTH_PORT} # The port used for device traffic over HTTP
       - IOTA_PROVIDER_URL=http://iot-agent:${IOTA_NORTH_PORT}
       - IOTA_MULTI_CORE=true
@@ -121,9 +119,10 @@ services:
       - "WEB_APP_PORT=${TUTORIAL_APP_PORT}" # Port used by the content provider proxy and web-app for viewing data
       - "IOTA_HTTP_HOST=iot-agent"
       - "IOTA_HTTP_PORT=${IOTA_SOUTH_PORT}"
-      - "IOTA_DEFAULT_RESOURCE=/iot/d"
+      - "IOTA_DEFAULT_RESOURCE=/iot/json"
       - "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=JSON"
       - "CONTEXT_BROKER=http://orion:${ORION_PORT}/v2" # URL of the context broker to update context
       - "NGSI_LD_PREFIX="
       - "CRATE_DB_SERVICE_URL=http://crate-db:4200/_sql"
diff --git a/provision-devices b/provision-devices
@@ -10,7 +10,7 @@ printf "⏳ Provisioning IoT devices "
 
 
 #
-# Create a service groups for all UltraLight IoT devices
+# Create a service groups for all JSON IoT devices
 #
 
 curl -s -o /dev/null -X POST \
@@ -24,8 +24,8 @@ curl -s -o /dev/null -X POST \
      "apikey":      "1068318794",
      "cbroker":     "'"http://orion:$ORION_PORT"'",
      "entity_type": "Motion",
-     "resource":    "/iot/d",
-     "protocol":    "PDI-IoTA-UltraLight",
+     "resource":    "/iot/json",
+     "protocol":    "IoTA-JSON",
      "transport":   "HTTP",
      "timezone":    "Europe/Berlin",
      "attributes": [
@@ -35,16 +35,16 @@ curl -s -o /dev/null -X POST \
           {"name": "category", "type":"Text", "value": ["sensor"]},
           {"name": "controlledProperty", "type": "Text", "value": "motion"},
           {"name": "function", "type": "Text", "value":["sensing"]},
-          {"name": "supportedProtocol", "type": "Text", "value": ["ul20"]},
+          {"name": "supportedProtocol", "type": "Text", "value": ["json"]},
           {"name": "supportedUnits", "type": "Text", "value": "C62"}
       ]
    },
    {
      "apikey":      "3020035",
      "cbroker":     "'"http://orion:$ORION_PORT"'",
      "entity_type": "Bell",
-     "resource":    "/iot/d",
-     "protocol":    "PDI-IoTA-UltraLight",
+     "resource":    "/iot/json",
+     "protocol":    "IoTA-JSON",
      "transport":   "HTTP",
      "timezone":    "Europe/Berlin",
      "commands": [ 
@@ -57,15 +57,15 @@ curl -s -o /dev/null -X POST \
           {"name": "category", "type":"Text", "value": ["actuator"]},
           {"name": "controlledProperty", "type": "Text", "value": "noiseLevel"},
           {"name": "function", "type": "Text", "value":["onOff"]},
-          {"name": "supportedProtocol", "type": "Text", "value": ["ul20"]}
+          {"name": "supportedProtocol", "type": "Text", "value": ["json"]}
       ]
    },
    {
      "apikey":      "3314136",
      "cbroker":     "'"http://orion:$ORION_PORT"'",
      "entity_type": "Lamp",
-     "resource":    "/iot/d",
-     "protocol":    "PDI-IoTA-UltraLight",
+     "resource":    "/iot/json",
+     "protocol":    "IoTA-JSON",
      "transport":   "HTTP",
      "timezone":    "Europe/Berlin",
      "commands": [ 
@@ -82,16 +82,16 @@ curl -s -o /dev/null -X POST \
           {"name": "category", "type":"Text", "value": ["actuator","sensor"]},
           {"name": "controlledProperty", "type": "Text", "value": "light"},
           {"name": "function", "type": "Text", "value":["onOff", "sensing"]},
-          {"name": "supportedProtocol", "type": "Text", "value": ["ul20"]},
+          {"name": "supportedProtocol", "type": "Text", "value": ["json"]},
           {"name": "supportedUnits", "type": "Text", "value": "CDL"}
      ]
    },
    {
      "apikey":      "3089326",
      "cbroker":     "'"http://orion:$ORION_PORT"'",
      "entity_type": "Door",
-     "resource":    "/iot/d",
-     "protocol":    "PDI-IoTA-UltraLight",
+     "resource":    "/iot/json",
+     "protocol":    "IoTA-JSON",
      "transport":   "HTTP",
      "timezone":    "Europe/Berlin",
      "commands": [ 
@@ -107,7 +107,7 @@ curl -s -o /dev/null -X POST \
           {"name": "category", "type":"Text", "value": ["actuator", "sensor"]},
           {"name": "controlledProperty", "type": "Text", "value": "state"},
           {"name": "function", "type": "Text", "value":["openClose", "eventNotification"]},
-          {"name": "supportedProtocol", "type": "Text", "value": ["ul20"]}
+          {"name": "supportedProtocol", "type": "Text", "value": ["json"]}
       ]
    }
  ]
@@ -119,7 +119,7 @@ curl -s -o /dev/null -X POST \
 #
 
 curl -s -o /dev/null -X POST \
-  "http://iot-agent:$IOTA_NORTH_PORT/iot/devices" \
+  "http://iot-agent:$IOTA_NORTH_PORT/iot/jsonevices" \
   -H 'Content-Type: application/json' \
   -H 'fiware-service: openiot' \
   -H 'fiware-servicepath: /' \
@@ -149,7 +149,7 @@ curl -s -o /dev/null -X POST \
       "entity_name": "Door:001",
       "entity_type": "Door",
       "apikey":      "3089326",
-      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/door001"'",
+      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/jsonoor001"'",
       "static_attributes": [
           {"name": "refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:001"}
        ]
@@ -180,7 +180,7 @@ curl -s -o /dev/null -X POST \
 #
 
 curl -s -o /dev/null -X POST \
-  "http://iot-agent:$IOTA_NORTH_PORT/iot/devices" \
+  "http://iot-agent:$IOTA_NORTH_PORT/iot/jsonevices" \
   -H 'Content-Type: application/json' \
   -H 'fiware-service: openiot' \
   -H 'fiware-servicepath: /' \
@@ -210,7 +210,7 @@ curl -s -o /dev/null -X POST \
       "entity_name": "Door:002",
       "entity_type": "Door",
       "apikey":      "3089326",
-      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/door002"'",
+      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/jsonoor002"'",
       "static_attributes": [
         {"name": "refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:002"}
       ]
@@ -244,7 +244,7 @@ curl -s -o /dev/null -X POST \
 #
 
 curl -s -o /dev/null -X POST \
-  "http://iot-agent:$IOTA_NORTH_PORT/iot/devices" \
+  "http://iot-agent:$IOTA_NORTH_PORT/iot/jsonevices" \
   -H 'Content-Type: application/json' \
   -H 'fiware-service: openiot' \
   -H 'fiware-servicepath: /' \
@@ -274,7 +274,7 @@ curl -s -o /dev/null -X POST \
       "entity_name": "Door:003",
       "entity_type": "Door",
       "apikey":      "3089326",
-      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/door003"'",
+      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/jsonoor003"'",
       "static_attributes": [
         {"name": "refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:003"}
       ]
@@ -307,7 +307,7 @@ curl -s -o /dev/null -X POST \
 #
 
 curl -s -o /dev/null -X POST \
-  "http://iot-agent:$IOTA_NORTH_PORT/iot/devices" \
+  "http://iot-agent:$IOTA_NORTH_PORT/iot/jsonevices" \
   -H 'Content-Type: application/json' \
   -H 'fiware-service: openiot' \
   -H 'fiware-servicepath: /' \
@@ -337,7 +337,7 @@ curl -s -o /dev/null -X POST \
       "entity_name": "Door:004",
       "entity_type": "Door",
       "apikey":      "3089326",
-      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/door004"'",
+      "endpoint": "'"http://iot-sensors:$TUTORIAL_DUMMY_DEVICE_PORT/iot/jsonoor004"'",
       "static_attributes": [
         {"name": "refStore", "type": "Relationship","value": "urn:ngsi-ld:Store:004"}
       ]
