modbus_tcp: added modBusDirection: write

Author: bmxp

modbus_tcp/__init__.py

@@ -37,6 +37,8 @@
 from pymodbus.client.tcp import ModbusTcpClient
 from pymodbus import ModbusException
 
+import struct
+
 import logging
 
 AttrAddress = 'modBusAddress'
@@ -63,7 +65,7 @@ class modbus_tcp(SmartPlugin):
     devices.
     """
 
-    PLUGIN_VERSION = '1.0.14'
+    PLUGIN_VERSION = '1.0.15'
 
     def __init__(self, sh, *args, **kwargs):
         """
@@ -210,6 +212,10 @@ def parse_item(self, item):
                 self._regToWrite.update({reg: regPara})
                 self.logger.info(f"parse item: {item} Attributes {regPara}")
                 return self.update_item
+            elif dataDirection == 'write':
+                self._regToWrite.update({reg: regPara})
+                self.logger.info(f"parse item: {item} Attributes {regPara}")
+                return self.update_item
             else:
                 self.logger.warning("Invalid data direction -> default(read) is used")
                 self._regToRead.update({reg: regPara})
@@ -338,7 +344,7 @@ def update_item(self, item, caller=None, source=None, dest=None):
 
         if self.has_iattr(item.conf, AttrDirection):
             dataDirection = self.get_iattr_value(item.conf, AttrDirection)
-            if not dataDirection == 'read_write':
+            if not (dataDirection == 'read_write' or dataDirection == 'write'):
                 self.logger.debug(f'update_item: {item} Writing is not allowed - selected dataDirection:{dataDirection}')
                 return
             # else:
@@ -554,44 +560,47 @@ def __read_Registers(self, regPara: dict):
 
         self.logger.debug(f"read {objectType}.{address}.{slaveUnit} (address.slaveUnit) regCount:{registerCount} result:{result}")
 
-        if dataType.lower() == 'uint':
-            if bits == 16:
-                return decoder.decode_16bit_uint()
-            elif bits == 32:
-                return decoder.decode_32bit_uint()
-            elif bits == 64:
-                return decoder.decode_64bit_uint()
-            else:
-                self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
-        elif dataType.lower() == 'int':
-            if bits == 16:
-                return decoder.decode_16bit_int()
-            elif bits == 32:
-                return decoder.decode_32bit_int()
-            elif bits == 64:
-                return decoder.decode_64bit_int()
-            else:
-                self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
-        elif dataType.lower() == 'float':
-            if bits == 32:
-                return decoder.decode_32bit_float()
-            elif bits == 64:
-                return decoder.decode_64bit_float()
+        try:
+            if dataType.lower() == 'uint':
+                if bits == 16:
+                    return decoder.decode_16bit_uint()
+                elif bits == 32:
+                    return decoder.decode_32bit_uint()
+                elif bits == 64:
+                    return decoder.decode_64bit_uint()
+                else:
+                    self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
+            elif dataType.lower() == 'int':
+                if bits == 16:
+                    return decoder.decode_16bit_int()
+                elif bits == 32:
+                    return decoder.decode_32bit_int()
+                elif bits == 64:
+                    return decoder.decode_64bit_int()
+                else:
+                    self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
+            elif dataType.lower() == 'float':
+                if bits == 32:
+                    return decoder.decode_32bit_float()
+                elif bits == 64:
+                    return decoder.decode_64bit_float()
+                else:
+                    self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
+            elif dataType.lower() == 'string':
+                # bei string: bits = bytes !! string16 -> 16Byte
+                ret = decoder.decode_string(bits)
+                return str(ret, 'ASCII')
+            elif dataType.lower() == 'bit':
+                if objectType == 'Coil' or objectType == 'DiscreteInput':
+                    # self.logger.debug(f"read bit value: {value}")
+                    return value
+                else:
+                    self.logger.debug(f"read bits values: {value.decode_bits()}")
+                    return decoder.decode_bits()
             else:
                 self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
-        elif dataType.lower() == 'string':
-            # bei string: bits = bytes !! string16 -> 16Byte
-            ret = decoder.decode_string(bits)
-            return str(ret, 'ASCII')
-        elif dataType.lower() == 'bit':
-            if objectType == 'Coil' or objectType == 'DiscreteInput':
-                # self.logger.debug(f"read bit value: {value}")
-                return value
-            else:
-                self.logger.debug(f"read bits values: {value.decode_bits()}")
-                return decoder.decode_bits()
-        else:
-            self.logger.error(f"Number of bits or datatype not supported : {dataTypeStr}")
+        except struct.error as e:
+            self.logger.error(f"unable to unpack data for datatype={dataType.lower()} for read {objectType}.{address}.{slaveUnit} (address.slaveUnit) regCount:{registerCount}")
 
     @staticmethod
     def is_NaN( value, dataType: str) -> bool:

modbus_tcp/plugin.yaml

@@ -8,11 +8,11 @@ plugin:
     maintainer: ivande, Cannon
     tester: NONE                   # Who tests this plugin?
     state: ready
-    keywords: modbus_tcp modbus smartmeter inverter heatpump
+    keywords: modbus_tcp modbus tcp smartmeter inverter heatpump
     #documentation: http://smarthomeng.de/user/plugins/modbus_tcp/user_doc.html
     support: https://knx-user-forum.de/forum/supportforen/smarthome-py/1154368-einbindung-von-modbus-tcp
     version: 1.0.14                # Plugin version
-    sh_minversion: '1.10'             # minimum shNG version to use this plugin
+    sh_minversion: '1.10'          # minimum shNG version to use this plugin
     #sh_maxversion:                # maximum shNG version to use this plugin (leave empty if latest)
     py_minversion: '3.8'
     # py_maxversion:               # maximum Python version to use for this plugin (leave empty if latest)

modbus_tcp/user_doc.rst

@@ -18,9 +18,9 @@ SmarthomeNG plugin, zum Lesen von Register über ModBusTCP
 Anforderungen
 =============
 
-* Python > 3.6
-* pymodbus >= 2.5.3
-* SmarthomeNG >= 1.8.0
+* Python > 3.8
+* pymodbus < 3.10
+* SmarthomeNG >= 1.10
 
 pymodbus
 --------
@@ -164,6 +164,16 @@ siehe auch example.yaml
 
 Changelog
 ---------
+V1.0.15 Item Attribut modBusDirection erweitert: 'write' hinzugefügt für Register 
+        die nicht gelesen werden können aber beschrieben werden dürfen
+
+        pymodbus auf Version < 3.10 beschränkt
+
+V1.0.14 Fehlerwerte hinzugefügt, Exception Handling verbessert, an aktuelle Pymodbus Version
+        angepasst und minimal notwendige Python Version auf 3.8 gesetzt
+
+V1.0.13 pause_item wird nun unterstützt
+
 V1.0.12 Problem beim Schreiben ohne modBusObjectTyp behoben
         bei wiederholten Verbindungsproblemen Ausgabe vom Logger reduziert
         Verbindungstop mit supend/resume steuerbar
@@ -173,7 +183,7 @@ V1.0.11	Verbesserung Umwandlung Byte/Wordorder in Endian-Konstante
 
 V1.0.10	Mindestversion für pymodbus ist nun 3.5.2
 
-V1.0.9  
+V1.0.9  Zusätzlich zu cycle für Geräteabfrage 'crontab' Einträge erlaubt, Logeinträge abgeändert in Python f-strings
 
 V1.0.8  Neuere Pymodbus Versionen können nun verwendet werden.
         Di minimale Version für Pymodbus ist jetzt 2.5.3