feat(vucm): add integration with NI-cDAQ

Author: anataty

examples/vucm/ni-daq/Dockerfile

@@ -0,0 +1,13 @@
+FROM python:3.10-alpine3.16
+
+WORKDIR /app
+
+RUN apk add build-base
+
+RUN python -m venv .venv
+COPY requirements.txt requirements.txt
+RUN .venv/bin/pip install -r requirements.txt
+
+COPY script.py script.py
+
+CMD [".venv/bin/python", "script.py"]

examples/vucm/ni-daq/docker_run.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -euo pipefail
+IFS=$'\n\t'
+
+SCRIPT_DIR="$(realpath "$(dirname "$0")")"
+IMAGE_TAG="${IMAGE_TAG:-"enapter-vucm-examples/$(basename "$SCRIPT_DIR"):latest"}"
+
+docker build --tag "$IMAGE_TAG" "$SCRIPT_DIR"
+
+docker run --rm -it \
+	--name "ni-daq" \
+	--network host \
+	-e ENAPTER_LOG_LEVEL="${ENAPTER_LOG_LEVEL:-info}" \
+	-e ENAPTER_VUCM_BLOB="$ENAPTER_VUCM_BLOB" \
+	-e LISTEN_TCP_PORT="$LISTEN_TCP_PORT" \
+	"$IMAGE_TAG"

examples/vucm/ni-daq/manifest.yml

@@ -0,0 +1,28 @@
+blueprint_spec: "device/1.0"
+
+display_name: ATS stack
+
+communication_module:
+  product: ENP-VIRTUAL
+
+command_groups: {}
+
+properties:
+  model:
+    display_name: Model
+    type: string
+
+alerts:
+  nidaq_error:
+    display_name: Data processing failed
+    severity: error
+
+telemetry:
+  status:
+    display_name: Status
+    type: string
+    enum:
+      - ok
+      - error
+
+commands: {}

examples/vucm/ni-daq/requirements.txt

@@ -0,0 +1 @@
+enapter==0.9.2

examples/vucm/ni-daq/script.py

@@ -0,0 +1,93 @@
+import asyncio
+import csv
+import functools
+import io
+import os
+import socket
+
+import enapter
+
+def parse_bytes(bytes):
+    return bytes.decode("utf-8")
+
+
+def decode_csv(s):
+    csv_file = io.StringIO(s)
+    reader = csv.DictReader(csv_file)
+    return [row for row in reader]
+
+async def main():
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        device_factory = functools.partial(
+            NIDAQ,
+            socket=sock,
+            tcp_port=os.environ["LISTEN_TCP_PORT"],
+        )
+        await enapter.vucm.run(device_factory)
+
+
+class NIDAQ(enapter.vucm.Device):
+    def __init__(self, socket, tcp_port, **kwargs):
+        super().__init__(**kwargs)
+        self.socket = socket
+        self.tcp_port = tcp_port
+
+    async def task_properties_sender(self):
+        while True:
+            await self.send_properties(
+                {
+                    "model": "NI cDAQ 9178",
+                }
+            )
+            await asyncio.sleep(10)
+
+    async def task_telemetry_sender(self):
+        server_address = ('localhost', int(self.tcp_port))
+        self.socket.bind(server_address)
+        self.socket.setblocking(False)
+        self.socket.listen(1)
+        
+        while True:
+            try:
+                await self.log.info('waiting for a connection')
+                connection, client_address = await asyncio.get_event_loop().sock_accept(self.socket)
+                
+                try:
+                    await self.log.info(f'connection from {client_address}')
+                    data_to_send = bytearray()
+                    
+                    while True:
+                        try:
+                            data = await asyncio.get_event_loop().sock_recv(connection, 1024)
+                            if not data:
+                                await self.log.info(f'no more data from {client_address}')
+                                break
+                            data_to_send.extend(data)
+                            await self.log.info(f'got data: {data}')
+                        except Exception as e:
+                            await self.log.error(f"Error receiving data: {e}")
+                            break
+                    
+                    await self.send_telemetry(
+                        {
+                            "status": parse_bytes(data_to_send),
+                        }
+                    )
+                    self.alerts.clear()
+                    
+                except Exception as e:
+                    self.alerts.add("nidaq_error")
+                    await self.log.error(f"failed to process data: {e}")
+                    
+                finally:
+                    connection.close()
+                    await asyncio.sleep(1)
+                    
+            except Exception as e:
+                await self.log.error(f"Connection error: {e}")
+                
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+