Merge pull request #11 from reubenmiller/refactor-operation-handlers

refactor: move operation handlers to python module

Author: reubenmiller

.github/workflows/pr.yml

@@ -36,4 +36,4 @@ jobs:
         run: pylint operations
 
       - name: Check reader
-        run: pylint modbus_reader
+        run: pylint tedge_modbus

.pylintrc

@@ -290,7 +290,7 @@ exclude-too-few-public-methods=
 ignored-parents=
 
 # Maximum number of arguments for function / method.
-max-args=6
+max-args=5
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=7
@@ -302,7 +302,7 @@ max-bool-expr=5
 max-branches=12
 
 # Maximum number of locals for function / method body.
-max-locals=19
+max-locals=15
 
 # Maximum number of parents for a class (see R0901).
 max-parents=7
@@ -517,7 +517,7 @@ ignore-imports=yes
 ignore-signatures=yes
 
 # Minimum lines number of a similarity.
-min-similarity-lines=10
+min-similarity-lines=4
 
 
 [SPELLING]

README.md

@@ -71,7 +71,7 @@ There are two configuration files you need to edit for your use case. Any change
 All config files are expected to be in the /etc/tedge/plugins/modbus folder.
 As an alternative the directory can be based with -c or --configdir to the python script like so:
 
-`python modbus_reader/reader.py --configdir <configfolder>`
+`python3 -m tedge_modbus.reader --configdir <configfolder>`
 
 If used with Cumulocity IoT, the plugins can be managed via the Device Management or created with the cloud fieldbus operations.
 
@@ -192,7 +192,7 @@ After installing, you can build the Debian package with:
 - create the virtualenv with `python -m venv venv`
 - activate venv environment with `source ./venv/bin/activate`
 - install all dependencies with `python -m pip install -r requirements.txt`
-- run the reader with `python modbus_reader/reader.py -c ./config`
+- run the reader with `python tedge_modbus/reader/reader.py -c ./config`
 
 ### As deb file
 

images/tedge/Dockerfile

@@ -3,7 +3,7 @@ FROM goreleaser/nfpm as build-stage
 
 # Copy required files
 WORKDIR /build
-COPY modbus_reader /build/modbus_reader
+COPY tedge_modbus /build/tedge_modbus
 COPY operations /build/operations
 COPY scripts /build/scripts
 COPY nfpm.yaml /build/nfpm.yaml

justfile

@@ -24,7 +24,7 @@ format:
 # Run python linter
 lint:
     .venv/bin/python3 -m pylint operations
-    .venv/bin/python3 -m pylint modbus_reader
+    .venv/bin/python3 -m pylint tedge_modbus
 
 # Build deb package
 setup:

nfpm.yaml

@@ -17,34 +17,22 @@ license: "Apache-2.0"
 
 contents:
 #modbus reader files
-- src: ./modbus_reader/
-  dst: /usr/lib/python3/dist-packages/modbus_reader
+- src: ./tedge_modbus/
+  dst: /usr/lib/python3/dist-packages/tedge_modbus
 
-  #c8y_ModbusConfiguration
-- src: ./operations/c8y_ModbusConfiguration/c8y_ModbusConfiguration
-  dst: /etc/tedge/operations/c8y/c8y_ModbusConfiguration
+# operation handlers
+- src: ./operations/*
+  dst: /etc/tedge/operations/c8y/
   file_info:
-      mode: 0644
-- src: ./operations/c8y_ModbusConfiguration/c8y_ModbusConfiguration.py
-  dst: /etc/tedge/plugins/modbus/c8y_ModbusConfiguration.py
-  file_info:
-      mode: 0755
+    mode: 0644
 
-# c8y_ModbusDevice
-- src: ./operations/c8y_ModbusDevice/c8y_ModbusDevice
-  dst: /etc/tedge/operations/c8y/c8y_ModbusDevice
-  file_info:
-      mode: 0644
-- src: ./operations/c8y_ModbusDevice/c8y_ModbusDevice.py
-  dst: /etc/tedge/plugins/modbus/c8y_ModbusDevice.py
-  file_info:
-      mode: 0755
-  # Empty modbus config
+# Empty modbus config
 # - dst: /etc/tedge/plugins/modbus/modbus.toml
 #   type: config
 #   # Empty device config
 # - dst: /etc/tedge/plugins/modbus/devices.toml
 #   type: config
+
 # System D Unit File
 - src: ./tedge-modbus-plugin.service
   dst: /lib/systemd/system/tedge-modbus-plugin.service

operations/c8y_Coils

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

operations/c8y_Coils/c8y_Coils

@@ -0,0 +1,4 @@
+[exec]
+  topic = "c8y/s/dc/modbus"
+  on_message = "1"
+  command = "python3 -m tedge_modbus.operations c8y_ModbusConfiguration"