Merge pull request #35 from rina23q/refactor-replace-smartrest-with-devicecontrol

refactor: Replace usage of SmartREST with JSON over MQTT

Author: rina23q

operations/c8y_Coils

@@ -1,4 +1,4 @@
 [exec]
-  topic = "c8y/s/ds"
-  on_message = "xy"
+  topic = "c8y/devicecontrol/notifications"
+  on_fragment = "c8y_Coils"
   command = "python3 -m tedge_modbus.operations c8y_Coils"

operations/c8y_ModbusConfiguration

@@ -1,4 +1,4 @@
 [exec]
-  topic = "c8y/s/dc/modbus"
-  on_message = "1"
-  command = "python3 -m tedge_modbus.operations c8y_ModbusConfiguration"
+  topic = "c8y/devicecontrol/notifications"
+  on_fragment = "c8y_ModbusConfiguration"
+  command = "python3 -m tedge_modbus.operations c8y_ModbusConfiguration ${.payload.c8y_ModbusConfiguration}"

operations/c8y_ModbusDevice

@@ -1,4 +1,4 @@
 [exec]
-  topic = "c8y/s/dc/modbus"
-  on_message = "2"
-  command = "python3 -m tedge_modbus.operations c8y_ModbusDevice"
+  topic = "c8y/devicecontrol/notifications"
+  on_fragment = "c8y_ModbusDevice"
+  command = "python3 -m tedge_modbus.operations c8y_ModbusDevice ${.payload.c8y_ModbusDevice}"

operations/c8y_Registers

@@ -1,4 +1,4 @@
 [exec]
-  topic = "c8y/s/ds"
-  on_message = "xy"
+  topic = "c8y/devicecontrol/notifications"
+  on_fragment = "c8y_Registers"
   command = "python3 -m tedge_modbus.operations c8y_Registers"

operations/c8y_SerialConfiguration

@@ -1,4 +1,4 @@
 [exec]
-  topic = "c8y/s/dc/modbus"
-  on_message = "3"
-  command = "python3 -m tedge_modbus.operations c8y_SerialConfiguration"
+  topic = "c8y/devicecontrol/notifications"
+  on_fragment = "c8y_SerialConfiguration"
+  command = "python3 -m tedge_modbus.operations c8y_SerialConfiguration ${.payload.c8y_SerialConfiguration}"

scripts/deb/postinst

@@ -1,7 +1,6 @@
 #!/bin/sh
 set -e
 
-tedge config add c8y.smartrest.templates modbus
 tedge refresh-bridges
 
 # Automatically added by thin-edge.io

scripts/rpm/postinst

@@ -1,7 +1,6 @@
 #!/bin/sh
 set -e
 
-tedge config add c8y.smartrest.templates modbus
 tedge refresh-bridges
 
 # Automatically added by thin-edge.io

tedge_modbus/operations/__main__.py

@@ -24,7 +24,7 @@ def main():
     elif command == "c8y_SerialConfiguration":
         run = c8y_serial_configuration.run
 
-    arguments = sys.argv[2].split(",") if len(sys.argv) > 2 else []
+    arguments = sys.argv[2:]
     context = Context()
     run(arguments, context)
 

tedge_modbus/operations/c8y_modbus_configuration.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-"""Cumulocity IoT ModbusConfiguration operation handler"""
+"""Cumulocity ModbusConfiguration operation handler"""
 import json
 import logging
 import toml
@@ -15,18 +15,17 @@
 
 def run(arguments, context: Context):
     """Run c8y_ModbusConfiguration operation handler"""
-    if len(arguments) != 4:
-        raise ValueError(
-            f"Expected 4 arguments in smart rest template. Got {len(arguments)}"
-        )
+    if len(arguments) != 1:
+        raise ValueError(f"Expected 1 argument. Got {len(arguments)}")
     # Get device configuration
     modbus_config = context.base_config
     loglevel = modbus_config["modbus"]["loglevel"] or "INFO"
     logger.setLevel(getattr(logging, loglevel.upper(), logging.INFO))
     logger.info("New c8y_ModbusConfiguration operation")
     logger.debug("Current configuration: %s", modbus_config)
-    transmit_rate = int(arguments[2])
-    polling_rate = int(arguments[3])
+    data = json.loads(arguments[0])
+    transmit_rate = data["transmitRate"]
+    polling_rate = data["pollingRate"]
     logger.debug("transmitRate: %d, pollingRate: %d", transmit_rate, polling_rate)
 
     # Update configuration

tedge_modbus/operations/c8y_modbus_device.py

@@ -1,7 +1,8 @@
 #!/usr/bin/env python3
-"""Cumulocity IoT Modbus device operation handler"""
+"""Cumulocity Modbus device operation handler"""
 import logging
 from dataclasses import dataclass
+import json
 import requests
 import toml
 
@@ -76,13 +77,14 @@ def get_device_from_mapping(target: ModebusDevice, mapping):
 
 def parse_arguments(arguments) -> ModebusDevice:
     """Parse operation arguments"""
+    data = json.loads(arguments[0])
     return ModebusDevice(
-        modbus_type=arguments[2],  # Only works for TCP.
-        modbus_address=arguments[3],
-        child_name=arguments[4],
-        modbus_server=arguments[5],
-        device_id=arguments[6],
-        mapping_path=arguments[7],
+        modbus_type=data["protocol"],
+        modbus_address=data["address"],
+        child_name=data["name"],
+        modbus_server=data["ipAddress"],
+        device_id=data["id"],
+        mapping_path=data["type"],
     )
 
 
@@ -92,12 +94,8 @@ def run(arguments, context: Context):
     logger.setLevel(getattr(logging, loglevel.upper(), logging.INFO))
     logger.info("New c8y_ModbusDevice operation")
     # Check and store arguments
-    if len(arguments) != 8:
-        raise ValueError(
-            "Expected 8 arguments in smart rest template. Got "
-            + str(len(arguments))
-            + "."
-        )
+    if len(arguments) != 1:
+        raise ValueError("Expected 1 argument. Got " + str(len(arguments)) + ".")
     config_path = context.config_dir / "devices.toml"
     target = parse_arguments(arguments)