goodwe 0.4.2__tar.gz → 0.4.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: goodwe
-Version: 0.4.2
+Version: 0.4.3
 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/VERSION

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

{goodwe-0.4.2 → goodwe-0.4.3}/goodwe/__init__.py

@@ -22,9 +22,6 @@ DT_FAMILY = ["DT", "MS", "NS", "XS"]
 # Initial discovery command
 DISCOVERY_COMMAND = Aa55ProtocolCommand("010200", "0182")
 
-# supported inverter protocols
-_SUPPORTED_PROTOCOLS = [ET, DT, ES]
-
 
 async def connect(host: str, port: int = GOODWE_UDP_PORT, family: str = None, comm_addr: int = 0, timeout: int = 1,
                   retries: int = 3, do_discover: bool = True) -> Inverter:
@@ -41,7 +38,7 @@ async def connect(host: str, port: int = GOODWE_UDP_PORT, family: str = None, co
 
     Raise InverterError if unable to contact or recognise supported inverter.
     """
-    if family in ET_FAMILY or port == GOODWE_TCP_PORT:
+    if family in ET_FAMILY:
         inv = ET(host, port, comm_addr, timeout, retries)
     elif family in ES_FAMILY:
         inv = ES(host, port, comm_addr, timeout, retries)
@@ -65,42 +62,43 @@ async def discover(host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, ret
     """
     failures = []
 
-    # Try the common AA55C07F0102000241 command first and detect inverter type from serial_number
-    try:
-        logger.debug("Probing inverter at %s:%s.", host, port)
-        response = await DISCOVERY_COMMAND.execute(UdpInverterProtocol(host, port, timeout, retries))
-        response = response.response_data()
-        model_name = response[5:15].decode("ascii").rstrip()
-        serial_number = response[31:47].decode("ascii")
-
-        i: Inverter | None = None
-        for model_tag in ET_MODEL_TAGS:
-            if model_tag in serial_number:
-                logger.debug("Detected ET/EH/BT/BH/GEH inverter %s, S/N:%s.", model_name, serial_number)
-                i = ET(host, port, 0, timeout, retries)
-                break
-        if not i:
-            for model_tag in ES_MODEL_TAGS:
-                if model_tag in serial_number:
-                    logger.debug("Detected ES/EM/BP inverter %s, S/N:%s.", model_name, serial_number)
-                    i = ES(host, port, 0, timeout, retries)
-                    break
-        if not i:
-            for model_tag in DT_MODEL_TAGS:
+    if port == GOODWE_UDP_PORT:
+        # Try the common AA55C07F0102000241 command first and detect inverter type from serial_number
+        try:
+            logger.debug("Probing inverter at %s:%s.", host, port)
+            response = await DISCOVERY_COMMAND.execute(UdpInverterProtocol(host, port, timeout, retries))
+            response = response.response_data()
+            model_name = response[5:15].decode("ascii").rstrip()
+            serial_number = response[31:47].decode("ascii")
+
+            i: Inverter | None = None
+            for model_tag in ET_MODEL_TAGS:
                 if model_tag in serial_number:
-                    logger.debug("Detected DT/MS/D-NS/XS/GEP inverter %s, S/N:%s.", model_name, serial_number)
-                    i = DT(host, port, 0, timeout, retries)
+                    logger.debug("Detected ET/EH/BT/BH/GEH inverter %s, S/N:%s.", model_name, serial_number)
+                    i = ET(host, port, 0, timeout, retries)
                     break
-        if i:
-            await i.read_device_info()
-            logger.debug("Connected to inverter %s, S/N:%s.", i.model_name, i.serial_number)
-            return i
+            if not i:
+                for model_tag in ES_MODEL_TAGS:
+                    if model_tag in serial_number:
+                        logger.debug("Detected ES/EM/BP inverter %s, S/N:%s.", model_name, serial_number)
+                        i = ES(host, port, 0, timeout, retries)
+                        break
+            if not i:
+                for model_tag in DT_MODEL_TAGS:
+                    if model_tag in serial_number:
+                        logger.debug("Detected DT/MS/D-NS/XS/GEP inverter %s, S/N:%s.", model_name, serial_number)
+                        i = DT(host, port, 0, timeout, retries)
+                        break
+            if i:
+                await i.read_device_info()
+                logger.debug("Connected to inverter %s, S/N:%s.", i.model_name, i.serial_number)
+                return i
 
-    except InverterError as ex:
-        failures.append(ex)
+        except InverterError as ex:
+            failures.append(ex)
 
     # Probe inverter specific protocols
-    for inv in _SUPPORTED_PROTOCOLS:
+    for inv in [ET, DT, ES]:
         i = inv(host, port, 0, timeout, retries)
         try:
             logger.debug("Probing %s inverter at %s.", inv.__name__, host)

{goodwe-0.4.2 → goodwe-0.4.3}/goodwe/inverter.py

@@ -91,7 +91,6 @@ class Inverter(ABC):
     def __init__(self, host: str, port: int, comm_addr: int = 0, timeout: int = 1, retries: int = 3):
         self._protocol: InverterProtocol = self._create_protocol(host, port, comm_addr, timeout, retries)
         self._consecutive_failures_count: int = 0
-        self.keep_alive: bool = True
 
         self.model_name: str | None = None
         self.serial_number: str | None = None
@@ -130,9 +129,9 @@ class Inverter(ABC):
         except RequestFailedException as ex:
             self._consecutive_failures_count += 1
             raise RequestFailedException(ex.message, self._consecutive_failures_count) from None
-        finally:
-            if not self.keep_alive:
-                self._protocol.close_transport()
+
+    def set_keep_alive(self, keep_alive: bool) -> None:
+        self._protocol.keep_alive = keep_alive
 
     @abstractmethod
     async def read_device_info(self):

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

@@ -222,10 +222,14 @@ def validate_modbus_tcp_response(data: bytes, cmd: int, offset: int, value: int)
         logger.debug("Response is too short.")
         return False
     expected_length = int.from_bytes(data[4:6], byteorder='big', signed=False) + 6
-    if len(data) < expected_length:
+    # 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)
 
     if data[7] == MODBUS_READ_CMD:
+        expected_length = data[8] + 9
+        if len(data) < expected_length:
+            raise PartialResponseException(len(data), expected_length)
         if data[8] != value * 2:
             logger.debug("Response has unexpected length: %d, expected %d.", data[8], value * 2)
             return False

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

@@ -37,6 +37,7 @@ class InverterProtocol:
         self._timer: asyncio.TimerHandle | None = None
         self.timeout: int = timeout
         self.retries: int = retries
+        self.keep_alive: bool = True
         self.protocol: asyncio.Protocol | None = None
         self.response_future: Future | None = None
         self.command: ProtocolCommand | None = None
@@ -57,10 +58,10 @@ class InverterProtocol:
             logger.debug("Creating lock instance for current event loop.")
             self._lock = asyncio.Lock()
             self._running_loop = asyncio.get_event_loop()
-            self.close_transport()
+            self._close_transport()
             return self._lock
 
-    def close_transport(self) -> None:
+    async def close(self) -> None:
         """Close the underlying transport/connection."""
         raise NotImplementedError()
 
@@ -116,7 +117,7 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
             logger.debug("Socket closed with error: %s.", exc)
         else:
             logger.debug("Socket closed.")
-        self.close_transport()
+        self._close_transport()
 
     def datagram_received(self, data: bytes, addr: Tuple[str, int]) -> None:
         """On datagram received"""
@@ -146,13 +147,13 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
         except RequestRejectedException as ex:
             logger.debug("Received exception response: %s", data.hex())
             self.response_future.set_exception(ex)
-            self.close_transport()
+            self._close_transport()
 
     def error_received(self, exc: Exception) -> None:
         """On error received"""
         logger.debug("Received error: %s", exc)
         self.response_future.set_exception(exc)
-        self.close_transport()
+        self._close_transport()
 
     async def send_request(self, command: ProtocolCommand) -> Future:
         """Send message via transport"""
@@ -188,9 +189,9 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
         else:
             logger.debug("Max number of retries (%d) reached, request %s failed.", self.retries, self.command)
             self.response_future.set_exception(MaxRetriesException)
-            self.close_transport()
+            self._close_transport()
 
-    def close_transport(self) -> None:
+    def _close_transport(self) -> None:
         if self._transport:
             try:
                 self._transport.close()
@@ -201,6 +202,9 @@ class UdpInverterProtocol(InverterProtocol, asyncio.DatagramProtocol):
         if self.response_future and not self.response_future.done():
             self.response_future.cancel()
 
+    async def close(self):
+        self._close_transport()
+
 
 class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
     def __init__(self, host: str, port: int, comm_addr: int, timeout: int = 1, retries: int = 0):
@@ -227,14 +231,18 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
                 lambda: self,
                 host=self._host, port=self._port,
             )
-            sock = self._transport.get_extra_info('socket')
-            if sock is not None:
-                sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
-                sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 10)
-                sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 10)
-                sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 3)
-                if platform.system() == 'Windows':
-                    sock.ioctl(socket.SIO_KEEPALIVE_VALS, (1, 10000, 10000))
+            if self.keep_alive:
+                try:
+                    sock = self._transport.get_extra_info('socket')
+                    if sock is not None:
+                        sock.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
+                        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPIDLE, 10)
+                        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPINTVL, 10)
+                        sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_KEEPCNT, 3)
+                        if platform.system() == 'Windows':
+                            sock.ioctl(socket.SIO_KEEPALIVE_VALS, (1, 10000, 10000))
+                except AttributeError as ex:
+                    logger.debug("Failed to apply KEEPALIVE: %s", ex)
 
     def connection_made(self, transport: asyncio.DatagramTransport) -> None:
         """On connection made"""
@@ -243,7 +251,7 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
 
     def eof_received(self) -> None:
         logger.debug("EOF received.")
-        self.close_transport()
+        self._close_transport()
 
     def connection_lost(self, exc: Optional[Exception]) -> None:
         """On connection lost"""
@@ -251,7 +259,7 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
             logger.debug("Connection closed with error: %s.", exc)
         else:
             logger.debug("Connection closed.")
-        self.close_transport()
+        self._close_transport()
 
     def data_received(self, data: bytes) -> None:
         """On data received"""
@@ -272,7 +280,7 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
             else:
                 logger.debug("Received invalid response: %s", data.hex())
                 self.response_future.set_exception(RequestRejectedException())
-                self.close_transport()
+                self._close_transport()
         except PartialResponseException:
             logger.debug("Received response fragment: %s", data.hex())
             self._partial_data = data
@@ -282,13 +290,13 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
         except RequestRejectedException as ex:
             logger.debug("Received exception response: %s", data.hex())
             self.response_future.set_exception(ex)
-            # self.close_transport()
+            # self._close_transport()
 
     def error_received(self, exc: Exception) -> None:
         """On error received"""
         logger.debug("Received error: %s", exc)
         self.response_future.set_exception(exc)
-        self.close_transport()
+        self._close_transport()
 
     async def send_request(self, command: ProtocolCommand) -> Future:
         """Send message via transport"""
@@ -306,7 +314,7 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
                 self._retry += 1
                 if self._lock and self._lock.locked():
                     self._lock.release()
-                self.close_transport()
+                self._close_transport()
                 return await self.send_request(command)
             else:
                 return self._max_retries_reached()
@@ -343,16 +351,16 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
             if self._timer:
                 logger.debug("Failed to receive response to %s in time (%ds).", self.command, self.timeout)
                 self._timer = None
-            self.close_transport()
+            self._close_transport()
 
     def _max_retries_reached(self) -> Future:
         logger.debug("Max number of retries (%d) reached, request %s failed.", self.retries, self.command)
-        self.close_transport()
+        self._close_transport()
         self.response_future = asyncio.get_running_loop().create_future()
         self.response_future.set_exception(MaxRetriesException)
         return self.response_future
 
-    def close_transport(self) -> None:
+    def _close_transport(self) -> None:
         if self._transport:
             try:
                 self._transport.close()
@@ -363,6 +371,14 @@ class TcpInverterProtocol(InverterProtocol, asyncio.Protocol):
         if self.response_future and not self.response_future.done():
             self.response_future.cancel()
 
+    async def close(self):
+        await self._ensure_lock().acquire()
+        try:
+            self._close_transport()
+        finally:
+            if self._lock and self._lock.locked():
+                self._lock.release()
+
 
 class ProtocolResponse:
     """Definition of response to protocol command"""
@@ -441,6 +457,9 @@ class ProtocolCommand:
             raise RequestFailedException(
                 "No valid response received to '" + self.request.hex() + "' request."
             ) from None
+        finally:
+            if not protocol.keep_alive:
+                await protocol.close()
 
 
 class Aa55ProtocolCommand(ProtocolCommand):
@@ -485,8 +504,7 @@ class Aa55ProtocolCommand(ProtocolCommand):
         data[-2:] is checksum (plain sum of response data incl. header)
         """
         if len(data) <= 8 or len(data) != data[6] + 9:
-            logger.debug("Response has unexpected length: %d, expected %d.", len(data), data[6] + 9)
-            return False
+            raise PartialResponseException(len(data), data[6] + 9)
         elif response_type:
             data_rt_int = int.from_bytes(data[4:6], byteorder="big", signed=True)
             if int(response_type, 16) != data_rt_int:

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

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

{goodwe-0.4.2 → goodwe-0.4.3}/tests/test_modbus.py

@@ -104,6 +104,8 @@ class TestModbus(TestCase):
     def test_validate_modbus_tcp_read_response(self):
         self.assert_tcp_response_ok('000100000007b4030445565345', 0x3, 310, 2)
         self.assert_tcp_response_ok('000100000007b4030400000002', 0x3, 331, 2)
+        # technically illegal, but work around Goodwe bug
+        self.assert_tcp_response_ok('000100000006f703020000', 0x3, 47510, 1)
         # length too short
         self.assert_tcp_response_partial('000100000007b403040000', 0x03, 331, 2)
         # failure code

goodwe-0.4.2/VERSION

@@ -1 +0,0 @@
-0.4.2