Allow integer values in register types 3 and 4 (#27)

Author: cybcon

Dockerfile

@@ -1,14 +1,7 @@
 FROM python:3.10.9-alpine3.17
 
 LABEL maintainer="Michael Oberdorf IT-Consulting <info@oberdorf-itc.de>"
-LABEL site.local.vendor="Michael Oberdorf IT-Consulting"
-LABEL site.local.os.main="Linux"
-LABEL site.local.os.dist="Alpine"
-LABEL site.local.os.version="3.17"
-LABEL site.local.runtime.name="Python"
-LABEL site.local.runtime.version="3.10.9"
-LABEL site.local.program.name="Python Modbus TCP Server"
-LABEL site.local.program.version="1.1.5"
+LABEL site.local.program.version="1.2.0"
 
 COPY --chown=root:root /src /
 

README.md

@@ -8,7 +8,8 @@ Container image: [DockerHub](https://hub.docker.com/r/oitc/modbus-server)
 
 # Supported tags and respective `Dockerfile` links
 
-* [`latest`, `1.1.5`](https://github.com/cybcon/modbus-server/blob/v1.1.5/Dockerfile)
+* [`latest`, `1.2.0`](https://github.com/cybcon/modbus-server/blob/v1.2.0/Dockerfile)
+* [`1.1.5`](https://github.com/cybcon/modbus-server/blob/v1.1.5/Dockerfile)
 * [`1.1.4`](https://github.com/cybcon/modbus-server/blob/v1.1.4/Dockerfile)
 * [`1.1.3`](https://github.com/cybcon/modbus-server/blob/v1.1.3/Dockerfile)
 * [`1.1.2`](https://github.com/cybcon/modbus-server/blob/v1.1.2/Dockerfile)
@@ -132,6 +133,7 @@ Example configuration of pre-defined registers from type "Discrete Input" or "Co
 ```
 
 As by the modbus spec, the "Holding Registers" and "Input Registers" tables contains a 16-bit word. In the json configuration file, we use a hexadecimal notation, starting with `0x`, as register values.
+With v1.2.0 of the modbus-server, you can also use integer values (0-65535) instead.
 
 Example configuration of pre-defined registers from type "Holding Registers" or "Input Registers":
 ```

examples/test.json

@@ -29,16 +29,16 @@
     "4": false
   },
   "holdingRegister": {
-    "1": "0xCC01",
+    "1": 52225,
     "2": "0xCC02",
-    "3": "0xCC03",
+    "3": 52227,
     "4": "0xCC04"
     },
   "inputRegister": {
     "1": "0xDD01",
-    "2": "0xDD02",
+    "2": 56578,
     "3": "0xDD03",
-    "4": "0xDD04"
+    "4": 56580
     }
   }
 }

src/app/modbus_server.py

@@ -3,8 +3,8 @@
 Modbus TCP server script for debugging
 Author: Michael Oberdorf IT-Consulting
 Datum: 2020-03-30
-Last modified by: Hackergarden Meetup@Codecentric
-Last modified at: 2023-11-08
+Last modified by: Michael Oberdorf
+Last modified at: 2023-11-13
 *************************************************************************** """
 import sys
 import os
@@ -21,7 +21,7 @@
 
 # default configuration file path
 config_file='/app/modbus_server.json'
-VERSION='1.1.5'
+VERSION='1.2.0'
 """
 ###############################################################################
 # F U N C T I O N S
@@ -123,7 +123,7 @@ def run_server(listener_address: str = '0.0.0.0', listener_port: int = 5020, tls
     identity.VendorUrl = 'http://github.com/riptideio/pymodbus/'
     identity.ProductName = 'Pymodbus Server'
     identity.ModelName = 'Pymodbus Server'
-    identity.MajorMinorRevision = '2.3.0'
+    identity.MajorMinorRevision = '2.5.3'
 
     # ----------------------------------------------------------------------- #
     # run the server
@@ -156,27 +156,33 @@ def prepareRegister(register: dict, initType: str, initializeUndefinedRegisters:
     if len(register) == 0: return(outRegister)
 
     for key in register:
-        if isinstance(key, str):
-            keyOut = int(key, 0)
-            log.debug('  Transform register id: ' + str(key) + ' ('+ str(type(key)) + ') to: ' + str(keyOut) + ' (' + str(type(keyOut)) + ')')
-        else: keyOut = key
+      if isinstance(key, str):
+        keyOut = int(key, 0)
+        log.debug('  Transform register id: ' + str(key) + ' ('+ str(type(key)) + ') to: ' + str(keyOut) + ' (' + str(type(keyOut)) + ')')
+      else: keyOut = key
 
-        val = register[key]
+      val = register[key]
+      valOut = val
+      if initType == 'word' and isinstance(val, str) and str(val)[0:2] == '0x' and len(val) >= 3 and len(val) <= 6:
+        valOut = int(val, 16)
+        log.debug('  Transform value for register: ' + str(keyOut) + ' from: ' + str(val) + ' ('+ str(type(key)) + ') to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
+      elif initType == 'word' and isinstance(val, int) and val >=0 and val <= 65535:
         valOut = val
-        if initType == 'word' and isinstance(val, str) and str(val)[0:2] == '0x':
-            valOut = int(val, 16)
-            log.debug('  Transform value for register: ' + str(keyOut) + ' from: ' + str(val) + ' ('+ str(type(key)) + ') to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
-        elif initType == 'boolean':
-            if isinstance(val, bool):
-              valOut = val
-              log.debug('  Set register: ' + str(keyOut) + ' to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
-            elif isinstance(val, int):
-              if val == 0:
-                valOut = False
-              else:
-                valOut = True
-              log.debug('  Transform value for register: ' + str(keyOut) + ' from: ' + str(val) + ' ('+ str(type(key)) + ') to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
-        outRegister[keyOut] = valOut
+        log.debug('  Use value for register: {}: {}'.format(str(keyOut), str(valOut)))
+      elif initType == 'boolean':
+        if isinstance(val, bool):
+          valOut = val
+          log.debug('  Set register: ' + str(keyOut) + ' to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
+        elif isinstance(val, int):
+          if val == 0:
+            valOut = False
+          else:
+            valOut = True
+          log.debug('  Transform value for register: ' + str(keyOut) + ' from: ' + str(val) + ' ('+ str(type(key)) + ') to: ' + str(valOut) + ' (' + str(type(valOut)) + ')')
+      else:
+        log.error('  Malformed input or input is out of range for register: {} -> value is {} - skip this register initialization!'.format(str(keyOut), str(val)))
+        continue
+      outRegister[keyOut] = valOut
 
     if initializeUndefinedRegisters:
         if initType == 'word':