examples: standalone: try to fix zigbee2mqtt

Author: rnovatorov

examples/standalone/zigbee2mqtt/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-alpine3.16
+FROM python:3.13-alpine
 
 WORKDIR /app
 

examples/standalone/zigbee2mqtt/README.md

@@ -1,42 +1,54 @@
 # Zigbee Sensor (MQTT)
 
-This example describes the implementation of the [Standalone UCM](https://handbook.enapter.com/software/virtual_ucm/) concept using the opensource [Enapter python-sdk](https://github.com/Enapter/python-sdk) for monitoring Zigbee Sensor via MQTT protocol (Zigbee2Mqtt).
+This example describes the implementation of the Standalone Device concept
+using the opensource [Enapter
+python-sdk](https://github.com/Enapter/python-sdk) for monitoring Zigbee Sensor
+via MQTT protocol (Zigbee2Mqtt).
 
-In order to use this UCM you need to have [Zigbee2MQTT](https://www.zigbee2mqtt.io/guide/installation/) and some MQTT broker (for example [Mosquitto](https://mosquitto.org)) running.
+In order to use this Standalone Device you need to have
+[Zigbee2MQTT](https://www.zigbee2mqtt.io/guide/installation/) and some MQTT
+broker (for example [Mosquitto](https://mosquitto.org)) running.
 
-As an example in this guide we will use the following dummy settings for configuration:
+As an example in this guide we will use the following dummy settings for
+configuration:
 
-MQTT Broker Address: 192.168.192.190
-
-MQTT Broker Port: 9883
-
-MQTT User: mqtt_user
-
-MQTT Password: mqtt_password
-
-Device MQTT topic: zigbee2mqtt/MyDevice
+- MQTT Broker Address: 192.168.192.190
+- MQTT Broker Port: 9883
+- MQTT User: mqtt_user
+- MQTT Password: mqtt_password
+- Device MQTT topic: zigbee2mqtt/MyDevice
 
 ## Requirements
 
-It is recommended to run this UCM using Docker and Docker Compose. This will ensure that environment is correct.
-
-The MQTT broker must be reachable from the computer where the Docker Container will be running.
+It is recommended to run this Standalone Device using Docker and Docker
+Compose. This will ensure that environment is correct.
 
-## Step 1. Create Standalone UCM in Enapter Cloud
+The MQTT broker must be reachable from the computer where the Docker Container
+will be running.
 
-Log in to the Enapter Cloud, navigate to the Site where you want to create Standalone UCM and click on `Add new` button in the Standalone Device section.
+## Step 1. Create Standalone Device in Enapter Cloud
 
-After creating Standalone UCM, you need to Generate and save Configuration string also known as ENAPTER_VUCM_BLOB as well as save UCM ID which will be needed for the next step
+Log in to the Enapter Cloud, navigate to the Site where you want to create
+Standalone Device and click on `Add new` button in the Standalone Device
+section.
 
-More information you can find on [this page](https://developers.enapter.com/docs/tutorial/software-ucms/standalone).
+After creating Standalone Device, you need to Generate and save Configuration
+string also known as `ENAPTER_STANDALONE_COMMUNICATION_CONFIG` as well as save
+UCM ID which will be needed for the next step.
 
 ## Step 2. Upload Blueprint into the Cloud
 
-The general case [Enapter Blueprint](https://marketplace.enapter.com/about) consists of two files - declaration in YAML format (manifest.yaml) and logic written in Lua. Howerver for this case the logic is written in Python as Lua implementation doesn't have SNMP integration.
+The general case [Enapter Blueprint](https://marketplace.enapter.com/about)
+consists of two files - declaration in YAML format (manifest.yaml) and logic
+written in Lua. Howerver for this case the logic is written in Python.
 
-But for both cases we need to tell Enapter Cloud which telemetry we are going to send and store and how to name it.
+But for both cases we need to tell Enapter Cloud which telemetry we are going
+to send and store and how to name it.
 
-The easiest way to do that - using [Enapter CLI](https://github.com/Enapter/enapter-cli) to upload manifest.yaml into Cloud. The other option is to use [Web IDE](https://developers.enapter.com/docs/tutorial/uploading-blueprint).
+The easiest way to do that - using [Enapter
+CLI](https://github.com/Enapter/enapter-cli) to upload manifest.yaml into
+Cloud. The other option is to use [Web
+IDE](https://developers.enapter.com/docs/tutorial/uploading-blueprint).
 
 ```bash
 user@pc zigbee2mqtt % enapter devices upload --blueprint-dir . --hardware-id REAL_UCM_ID
@@ -53,16 +65,17 @@ Done!
 
 Open `docker-compose.yaml` in any editor.
 
-Set environment variables according to your configuration settings. With dummy settings your file will look like this:
+Set environment variables according to your configuration settings. With dummy
+settings your file will look like this:
 
 ```yaml
 version: "3"
 services:
-  zigbee2mqtt-ucm:
+  zigbee2mqtt-standalone:
     build: .
-    image: enapter-vucm-examples/zigbee2mqtt:latest
+    image: enapter-standalone-examples/zigbee2mqtt:latest
     environment:
-      - ENAPTER_VUCM_BLOB: "REALENAPTERVUCMBLOBMUSTBEHERE="
+      - ENAPTER_STANDALONE_COMMUNICATION_CONFIG: "PUT_YOUR_CONFIG_HERE"
       - ZIGBEE_MQTT_HOST: "192.168.192.190"
       - ZIGBEE_MQTT_PORT: "9883"
       - ZIGBEE_MQTT_USER: "mqtt_user"
@@ -72,12 +85,13 @@ services:
       - ZIGBEE_SENSOR_MODEL: "Device Model"
 ```
 
-## Step 4. Build Docker Image with Standalone UCM
+## Step 4. Build Docker Image with Standalone Device
 
-> You can you can skip this step and go directly to th Step 5.
-> Docker Compose will automatically build your image before starting container.
+> You can you can skip this step and go directly to Step 5. Docker Compose will
+> automatically build your image before starting container.
 
-Build your Docker image by running `bash docker_build.sh` command in directory with UCM.
+Build your Docker image by running `bash docker_build.sh` command in directory
+with Standalone Device.
 
 ```bash
 user@pc zigbee2mqtt  % bash docker_build.sh
@@ -122,20 +136,21 @@ user@pc zigbee2mqtt  % bash docker_build.sh
 #12 exporting to image
 #12 exporting layers done
 #12 writing image sha256:92e1050debeabaff5837c6ca5bc26b0b966d09fc6f24e21b1d10cbb2f4d9aeec done
-#12 naming to docker.io/enapter-vucm-examples/zigbee2mqtt:latest done
+#12 naming to docker.io/enapter-standalone-examples/zigbee2mqtt:latest done
 #12 DONE 0.0s
 ```
 
-Your `enapter-vucm-examples/zigbee2mqtt` image is now built and you can see it by running `docker images` command:
+Your `enapter-standalone-examples/zigbee2mqtt` image is now built and you can
+see it by running `docker images` command:
 
 ```bash
-user@pc zigbee2mqtt % docker images enapter-vucm-examples/zigbee2mqtt
-REPOSITORY                             TAG       IMAGE ID       CREATED       SIZE
-enapter-vucm-examples/zigbee2mqtt   latest    92e1050debea   5 hours ago   285MB
+user@pc zigbee2mqtt % docker images enapter-standalone-examples/zigbee2mqtt
+REPOSITORY                                TAG       IMAGE ID       CREATED       SIZE
+enapter-standalone-examples/zigbee2mqtt   latest    92e1050debea   5 hours ago   285MB
 ```
 
-## Step 5. Run your Standalone UCM Docker Container
+## Step 5. Run your Standalone Device Docker Container
 
-Finally run your Standalone UCM with `docker-compose up` command:
+Finally run your Standalone Device with `docker-compose up` command:
 
-On this step you can check that your UCM is now Online in the Cloud.
+On this step you can check that your Device is now Online in the Cloud.

examples/standalone/zigbee2mqtt/docker-compose.yaml

@@ -1,10 +1,10 @@
 version: "3"
 services:
-  zigbee2mqtt-ucm:
+  zigbee2mqtt-standalone:
     build: .
-    image: enapter-vucm-examples/zigbee2mqtt:latest
+    image: enapter-standalone-examples/zigbee2mqtt:latest
     environment:
-      - ENAPTER_VUCM_BLOB: "REALENAPTERVUCMBLOBMUSTBEHERE="
+      - ENAPTER_STANDALONE_COMMUNICATION_CONFIG: "PUT_YOUR_CONFIG_HERE"
       - ZIGBEE_MQTT_HOST: "192.168.192.190"
       - ZIGBEE_MQTT_PORT: "9883"
       - ZIGBEE_MQTT_USER: "mqtt_user"

examples/standalone/zigbee2mqtt/docker_build.sh

@@ -4,6 +4,6 @@ set -euo pipefail
 IFS=$'\n\t'
 
 SCRIPT_DIR="$(realpath "$(dirname "$0")")"
-IMAGE_TAG="${IMAGE_TAG:-"enapter-vucm-examples/$(basename "$SCRIPT_DIR"):latest"}"
+IMAGE_TAG="${IMAGE_TAG:-"enapter-standalone-examples/$(basename "$SCRIPT_DIR"):latest"}"
 
 docker build --progress=plain --tag "$IMAGE_TAG" "$SCRIPT_DIR"

examples/standalone/zigbee2mqtt/docker_run.sh

@@ -4,14 +4,14 @@ set -euo pipefail
 IFS=$'\n\t'
 
 SCRIPT_DIR="$(realpath "$(dirname "$0")")"
-IMAGE_TAG="${IMAGE_TAG:-"enapter-vucm-examples/$(basename "$SCRIPT_DIR"):latest"}"
+IMAGE_TAG="${IMAGE_TAG:-"enapter-standalone-examples/$(basename "$SCRIPT_DIR"):latest"}"
 
 bash $SCRIPT_DIR/docker_build.sh
 
 docker run --rm -it \
 	--network host \
 	-e ENAPTER_LOG_LEVEL="${ENAPTER_LOG_LEVEL:-info}" \
-	-e ENAPTER_VUCM_BLOB="$ENAPTER_VUCM_BLOB" \
+	-e ENAPTER_STANDALONE_COMMUNICATION_CONFIG="$ENAPTER_STANDALONE_COMMUNICATION_CONFIG" \
 	-e ZIGBEE_MQTT_HOST="$ZIGBEE_MQTT_HOST" \
 	-e ZIGBEE_MQTT_PORT="$ZIGBEE_MQTT_PORT" \
 	-e ZIGBEE_MQTT_USER="$ZIGBEE_MQTT_USER" \

examples/standalone/zigbee2mqtt/script.py

@@ -1,5 +1,4 @@
 import asyncio
-import functools
 import json
 import os
 
@@ -9,52 +8,47 @@
 async def main():
     env_prefix = "ZIGBEE_"
     mqtt_client_config = enapter.mqtt.Config.from_env(prefix=env_prefix)
-    device_factory = functools.partial(
-        ZigbeeMqtt,
+    zigbee_mqtt = ZigbeeMqtt(
         mqtt_client_config=mqtt_client_config,
         mqtt_topic=os.environ[env_prefix + "MQTT_TOPIC"],
         sensor_manufacturer=os.environ[env_prefix + "SENSOR_MANUFACTURER"],
         sensor_model=os.environ[env_prefix + "SENSOR_MODEL"],
     )
-    await enapter.vucm.run(device_factory)
+    await enapter.standalone.run(zigbee_mqtt)
 
 
-class ZigbeeMqtt(enapter.vucm.Device):
+class ZigbeeMqtt(enapter.standalone.Device):
+
     def __init__(
-        self,
-        mqtt_client_config,
-        mqtt_topic,
-        sensor_manufacturer,
-        sensor_model,
-        **kwargs,
+        self, mqtt_client_config, mqtt_topic, sensor_manufacturer, sensor_model
     ):
-        super().__init__(**kwargs)
-
+        super().__init__()
         self.telemetry = {}
-
         self.mqtt_client_config = mqtt_client_config
         self.mqtt_topic = mqtt_topic
-
         self.sensor_manufacturer = sensor_manufacturer
         self.sensor_model = sensor_model
 
-    @enapter.vucm.device_task
-    async def consume(self):
-        async with enapter.mqtt.Client(self.mqtt_client_config) as client:
-            async with client.subscribe(self.mqtt_topic) as messages:
-                async for msg in messages:
-                    try:
-                        self.telemetry = json.loads(msg.payload)
-                    except json.JSONDecodeError as e:
-                        await self.log.error(f"failed to decode json payload: {e}")
+    async def run(self):
+        async with asyncio.TaskGroup() as tg:
+            tg.create_task(self.consumer(tg))
+            tg.create_task(self.telemetry_sender())
+            tg.create_task(self.properties_sender())
+
+    async def consumer(self, tg):
+        client = enapter.mqtt.Client(tg, self.mqtt_client_config)
+        async with client.subscribe(self.mqtt_topic) as messages:
+            async for msg in messages:
+                try:
+                    self.telemetry = json.loads(msg.payload)
+                except json.JSONDecodeError as e:
+                    await self.log.error(f"failed to decode json payload: {e}")
 
-    @enapter.vucm.device_task
     async def telemetry_sender(self):
         while True:
             await self.send_telemetry(self.telemetry)
             await asyncio.sleep(1)
 
-    @enapter.vucm.device_task
     async def properties_sender(self):
         while True:
             await self.send_properties(
@@ -67,4 +61,7 @@ async def properties_sender(self):
 
 
 if __name__ == "__main__":
-    asyncio.run(main())
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        pass