goodwe 0.4.3__tar.gz → 0.4.5__tar.gz

{goodwe-0.4.3/goodwe.egg-info → goodwe-0.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goodwe
-Version: 0.4.3
+Version: 0.4.5
 Summary: Read data from GoodWe inverter via local network
 Home-page: https://github.com/marcelblijleven/goodwe
 Author: Martin Letenay, Marcel Blijleven

goodwe-0.4.5/VERSION

@@ -0,0 +1 @@
+0.4.5

{goodwe-0.4.3 → goodwe-0.4.5}/goodwe/modbus.py

@@ -221,10 +221,11 @@ def validate_modbus_tcp_response(data: bytes, cmd: int, offset: int, value: int)
     if len(data) <= 8:
         logger.debug("Response is too short.")
         return False
-    expected_length = int.from_bytes(data[4:6], byteorder='big', signed=False) + 6
-    # The weird expected_length != 12 is work around Goodwe bug answering wrong (hardcoded 6) length.
-    if len(data) < expected_length and expected_length != 12:
-        raise PartialResponseException(len(data), expected_length)
+
+    # The Modbus/TCP message length check is completely ignore due to Goodwe bugs
+    # expected_length = int.from_bytes(data[4:6], byteorder='big', signed=False) + 6
+    # if len(data) < expected_length:
+    #    raise PartialResponseException(len(data), expected_length)
 
     if data[7] == MODBUS_READ_CMD:
         expected_length = data[8] + 9
@@ -235,8 +236,8 @@ def validate_modbus_tcp_response(data: bytes, cmd: int, offset: int, value: int)
             return False
     elif data[7] in (MODBUS_WRITE_CMD, MODBUS_WRITE_MULTI_CMD):
         if len(data) < 12:
-            logger.debug("Response has unexpected length: %d, expected %d.", len(data), 14)
-            raise PartialResponseException(len(data), expected_length)
+            logger.debug("Response has unexpected length: %d, expected %d.", len(data), 12)
+            return False
         response_offset = int.from_bytes(data[8:10], byteorder='big', signed=False)
         if response_offset != offset:
             logger.debug("Response has wrong offset: %X, expected %X.", response_offset, offset)

{goodwe-0.4.3 → goodwe-0.4.5}/goodwe/protocol.py

@@ -42,6 +42,7 @@ class InverterProtocol:
         self.response_future: Future | None = None
         self.command: ProtocolCommand | None = None
         self._partial_data: bytes | None = None
+        self._partial_missing: int = 0
 
     def _ensure_lock(self) -> asyncio.Lock:
         """Validate (or create) asyncio Lock.
@@ -125,28 +126,28 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
             self._timer.cancel()
             self._timer = None
         try:
-            if self._partial_data:
-                logger.debug("Received another response fragment: %s.", data.hex())
+            if self._partial_data and self._partial_missing == len(data):
+                logger.debug("Composed fragmented response: %s + %s", self._partial_data.hex(), data.hex())
                 data = self._partial_data + data
-            if self.command.validator(data):
-                if self._partial_data:
-                    logger.debug("Composed fragmented response: %s", data.hex())
-                else:
-                    logger.debug("Received: %s", data.hex())
                 self._partial_data = None
+                self._partial_missing = 0
+            if self.command.validator(data):
+                logger.debug("Received: %s", data.hex())
                 self.response_future.set_result(data)
             else:
                 logger.debug("Received invalid response: %s", data.hex())
                 asyncio.get_running_loop().call_soon(self._retry_mechanism)
-        except PartialResponseException:
-            logger.debug("Received response fragment: %s", data.hex())
+        except PartialResponseException as ex:
+            logger.debug("Received response fragment (%d of %d): %s", ex.length, ex.expected, data.hex())
             self._partial_data = data
-            return
+            self._partial_missing = ex.expected - ex.length
+            self._timer = asyncio.get_running_loop().call_later(self.timeout, self._retry_mechanism)
         except asyncio.InvalidStateError:
             logger.debug("Response already handled: %s", data.hex())
         except RequestRejectedException as ex:
             logger.debug("Received exception response: %s", data.hex())
-            self.response_future.set_exception(ex)
+            if self.response_future and not self.response_future.done():
+                self.response_future.set_exception(ex)
             self._close_transport()
 
     def error_received(self, exc: Exception) -> None:
@@ -169,6 +170,8 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
         """Send message via transport"""
         self.command = command
         self.response_future = response_future
+        self._partial_data = None
+        self._partial_missing = 0
         payload = command.request_bytes()
         if self._retry > 0:
             logger.debug("Sending: %s - retry #%s/%s", self.command, self._retry, self.retries)
@@ -266,30 +269,30 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
         if self._timer:
             self._timer.cancel()
         try:
-            if self._partial_data:
-                logger.debug("Received another response fragment: %s.", data.hex())
+            if self._partial_data and self._partial_missing == len(data):
+                logger.debug("Composed fragmented response: %s + %s", self._partial_data.hex(), data.hex())
                 data = self._partial_data + data
+                self._partial_data = None
+                self._partial_missing = 0
             if self.command.validator(data):
-                if self._partial_data:
-                    logger.debug("Composed fragmented response: %s", data.hex())
-                else:
-                    logger.debug("Received: %s", data.hex())
+                logger.debug("Received: %s", data.hex())
                 self._retry = 0
-                self._partial_data = None
                 self.response_future.set_result(data)
             else:
                 logger.debug("Received invalid response: %s", data.hex())
                 self.response_future.set_exception(RequestRejectedException())
                 self._close_transport()
-        except PartialResponseException:
-            logger.debug("Received response fragment: %s", data.hex())
+        except PartialResponseException as ex:
+            logger.debug("Received response fragment (%d of %d): %s", ex.length, ex.expected, data.hex())
             self._partial_data = data
-            return
+            self._partial_missing = ex.expected - ex.length
+            self._timer = asyncio.get_running_loop().call_later(self.timeout, self._timeout_mechanism)
         except asyncio.InvalidStateError:
             logger.debug("Response already handled: %s", data.hex())
         except RequestRejectedException as ex:
             logger.debug("Received exception response: %s", data.hex())
-            self.response_future.set_exception(ex)
+            if self.response_future and not self.response_future.done():
+                self.response_future.set_exception(ex)
             # self._close_transport()
 
     def error_received(self, exc: Exception) -> None:
@@ -335,6 +338,8 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
         """Send message via transport"""
         self.command = command
         self.response_future = response_future
+        self._partial_data = None
+        self._partial_missing = 0
         payload = command.request_bytes()
         if self._retry > 0:
             logger.debug("Sending: %s - retry #%s/%s", self.command, self._retry, self.retries)
@@ -468,7 +473,7 @@ class Aa55ProtocolCommand(ProtocolCommand):
     Quite probably it is some variation of the protocol used on RS-485 serial link,
     extended/adapted to UDP transport layer.
 
-    Each request starts with header of 0xAA, 0x55, then 0xC0, 0x7F (probably some sort of address/command)
+    Each request starts with header of 0xAA, 0x55, then 0xC0, 0x7F (client addr, inverter addr)
     followed by actual payload data.
     It is suffixed with 2 bytes of plain checksum of header+payload.
 
@@ -484,7 +489,7 @@ class Aa55ProtocolCommand(ProtocolCommand):
                 + payload
                 + self._checksum(bytes.fromhex("AA55C07F" + payload)).hex()
             ),
-            lambda x: self._validate_response(x, response_type),
+            lambda x: self._validate_aa55_response(x, response_type),
         )
 
     @staticmethod
@@ -495,7 +500,7 @@ class Aa55ProtocolCommand(ProtocolCommand):
         return checksum.to_bytes(2, byteorder="big", signed=False)
 
     @staticmethod
-    def _validate_response(data: bytes, response_type: str) -> bool:
+    def _validate_aa55_response(data: bytes, response_type: str) -> bool:
         """
         Validate the response.
         data[0:3] is header
@@ -503,13 +508,20 @@ class Aa55ProtocolCommand(ProtocolCommand):
         data[6] is response payload length
         data[-2:] is checksum (plain sum of response data incl. header)
         """
-        if len(data) <= 8 or len(data) != data[6] + 9:
+        if len(data) <= 8:
+            logger.debug("Response too short.")
+            return False
+        elif len(data) < data[6] + 9:
             raise PartialResponseException(len(data), data[6] + 9)
+        elif len(data) > data[6] + 9:
+            logger.debug("Response invalid - too long (%d).", len(data))
+            return False
         elif response_type:
             data_rt_int = int.from_bytes(data[4:6], byteorder="big", signed=True)
             if int(response_type, 16) != data_rt_int:
                 logger.debug("Response type unexpected: %04x, expected %s.", data_rt_int, response_type)
                 return False
+
         checksum = 0
         for each in data[:-2]:
             checksum += each

{goodwe-0.4.3 → goodwe-0.4.5/goodwe.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goodwe
-Version: 0.4.3
+Version: 0.4.5
 Summary: Read data from GoodWe inverter via local network
 Home-page: https://github.com/marcelblijleven/goodwe
 Author: Martin Letenay, Marcel Blijleven

{goodwe-0.4.3 → goodwe-0.4.5}/tests/test_dt.py

@@ -416,3 +416,66 @@ class GW20KAU_DT_Test(DtMock):
         self.assertSensor('vnbus', 298.9, 'V', data)
         self.assertSensor('derating_mode', 4, '', data)
         self.assertSensor('derating_mode_label', 'Reactive power derating(PF/QU/FixQ)', '', data)
+
+
+class GW17K_DT_Test(DtMock):
+
+    def __init__(self, methodName='runTest'):
+        DtMock.__init__(self, methodName)
+        self.mock_response(self._READ_DEVICE_RUNNING_DATA, 'GW17K-DT_running_data.hex')
+        self.mock_response(self._READ_DEVICE_VERSION_INFO, 'GW17K-DT_device_info.hex')
+
+    def test_GW20KAU_DT_device_info(self):
+        self.loop.run_until_complete(self.read_device_info())
+        self.assertEqual('GW17KT-DT', self.model_name)
+        self.assertEqual('5017KDTT00BW0000', self.serial_number)
+        self.assertEqual(12, self.dsp1_version)
+        self.assertEqual(12, self.dsp2_version)
+        self.assertEqual(13, self.arm_version)
+        self.assertEqual('12.12.0d', self.firmware)
+
+    def test_GW20KAU_DT_runtime_data(self):
+        self.loop.run_until_complete(self.read_device_info())
+        data = self.loop.run_until_complete(self.read_runtime_data())
+        self.assertEqual(40, len(data))
+
+        self.assertSensor('timestamp', datetime.strptime('2024-05-20 10:35:55', '%Y-%m-%d %H:%M:%S'), '', data)
+        self.assertSensor('vpv1', 540.0, 'V', data)
+        self.assertSensor('ipv1', 10.5, 'A', data)
+        self.assertSensor('ppv1', 5670, 'W', data)
+        self.assertSensor('vpv2', 475.5, 'V', data)
+        self.assertSensor('ipv2', 14.8, 'A', data)
+        self.assertSensor('ppv2', 7037, 'W', data)
+        self.assertSensor('vline1', 413.0, 'V', data)
+        self.assertSensor('vline2', 411.5, 'V', data)
+        self.assertSensor('vline3', 409.5, 'V', data)
+        self.assertSensor('vgrid1', 236.7, 'V', data)
+        self.assertSensor('vgrid2', 238.3, 'V', data)
+        self.assertSensor('vgrid3', 237.3, 'V', data)
+        self.assertSensor('igrid1', 17.6, 'A', data)
+        self.assertSensor('igrid2', 17.5, 'A', data)
+        self.assertSensor('igrid3', 17.5, 'A', data)
+        self.assertSensor('fgrid1', 50.02, 'Hz', data)
+        self.assertSensor('fgrid2', 50.02, 'Hz', data)
+        self.assertSensor('fgrid3', 50.02, 'Hz', data)
+        self.assertSensor('pgrid1', 4166, 'W', data)
+        self.assertSensor('pgrid2', 4170, 'W', data)
+        self.assertSensor('pgrid3', 4153, 'W', data)
+        self.assertSensor('ppv', 12470, 'W', data)
+        self.assertSensor('work_mode', 1, '', data)
+        self.assertSensor('work_mode_label', 'Normal', '', data)
+        self.assertSensor('error_codes', 0, '', data)
+        self.assertSensor('warning_code', 0, '', data)
+        self.assertSensor('apparent_power', 0, 'VA', data)
+        self.assertSensor('reactive_power', 0, 'var', data)
+        self.assertSensor('temperature', 45.7, 'C', data)
+        self.assertSensor('e_day', 29.3, 'kWh', data)
+        self.assertSensor('e_total', 29984.4, 'kWh', data)
+        self.assertSensor('h_total', 8357, 'h', data)
+        self.assertSensor('safety_country', 1, '', data)
+        self.assertSensor('safety_country_label', 'CZ-A1', '', data)
+        self.assertSensor('funbit', 546, '', data)
+        self.assertSensor('vbus', 621.8, 'V', data)
+        self.assertSensor('vnbus', 314.2, 'V', data)
+        self.assertSensor('derating_mode', 4, '', data)
+        self.assertSensor('derating_mode_label', 'Reactive power derating(PF/QU/FixQ)', '', data)

goodwe-0.4.3/VERSION

@@ -1 +0,0 @@
-0.4.3