goodwe 0.4.7__py3-none-any.whl → 0.4.9__py3-none-any.whl

goodwe/__init__.py

@@ -1,9 +1,11 @@
+"""Goodwe solar inverter communication library."""
+
 from __future__ import annotations
 
 import asyncio
 import logging
 
-from .const import GOODWE_TCP_PORT, GOODWE_UDP_PORT
+from .const import GOODWE_UDP_PORT
 from .dt import DT
 from .es import ES
 from .et import ET
@@ -23,8 +25,15 @@ DT_FAMILY = ["DT", "MS", "NS", "XS"]
 DISCOVERY_COMMAND = Aa55ProtocolCommand("010200", "0182")
 
 
-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:
+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:
     """Contact the inverter at the specified host/port and answer appropriate Inverter instance.
 
     The specific inverter family/type will be detected automatically, but it can be passed explicitly.
@@ -55,7 +64,9 @@ async def connect(host: str, port: int = GOODWE_UDP_PORT, family: str = None, co
     return inv
 
 
-async def discover(host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, retries: int = 3) -> Inverter:
+async def discover(
+    host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, retries: int = 3
+) -> Inverter:
     """Contact the inverter at the specified value and answer appropriate Inverter instance
 
     Raise InverterError if unable to contact or recognise supported inverter
@@ -66,7 +77,9 @@ async def discover(host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, ret
         # 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 = 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")
@@ -74,24 +87,38 @@ async def discover(host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, ret
             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)
+                    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)
+                        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)
+                        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)
+                logger.debug(
+                    "Connected to inverter %s, S/N:%s.", i.model_name, i.serial_number
+                )
                 return i
 
         except InverterError as ex:
@@ -104,7 +131,12 @@ async def discover(host: str, port: int = GOODWE_UDP_PORT, timeout: int = 1, ret
             logger.debug("Probing %s inverter at %s.", inv.__name__, host)
             await i.read_device_info()
             await i.read_runtime_data()
-            logger.debug("Detected %s family inverter %s, S/N:%s.", inv.__name__, i.model_name, i.serial_number)
+            logger.debug(
+                "Detected %s family inverter %s, S/N:%s.",
+                inv.__name__,
+                i.model_name,
+                i.serial_number,
+            )
             return i
         except InverterError as ex:
             failures.append(ex)
@@ -124,10 +156,13 @@ async def search_inverters() -> bytes:
     logger.debug("Searching inverters by broadcast to port 48899")
     command = ProtocolCommand("WIFIKIT-214028-READ".encode("utf-8"), lambda r: True)
     try:
-        result = await command.execute(UdpInverterProtocol("255.255.255.255", 48899, 1, 0))
+        result = await command.execute(
+            UdpInverterProtocol("255.255.255.255", 48899, 1, 0)
+        )
         if result is not None:
             return result.response_data()
-        else:
-            raise InverterError("No response received to broadcast request.")
+        raise InverterError("No response received to broadcast request.")
     except asyncio.CancelledError:
-        raise InverterError("No valid response received to broadcast request.") from None
+        raise InverterError(
+            "No valid response received to broadcast request."
+        ) from None

goodwe/const.py

@@ -1,9 +1,8 @@
-from typing import Dict
-
+"""Constants."""
 GOODWE_TCP_PORT = 502
 GOODWE_UDP_PORT = 8899
 
-BATTERY_MODES: Dict[int, str] = {
+BATTERY_MODES: dict[int, str] = {
     0: "No battery",
     1: "Standby",
     2: "Discharge",
@@ -12,7 +11,7 @@ BATTERY_MODES: Dict[int, str] = {
     5: "To be discharged",
 }
 
-ENERGY_MODES: Dict[int, str] = {
+ENERGY_MODES: dict[int, str] = {
     0: "Check Mode",
     1: "Wait Mode",
     2: "Normal (On-Grid)",
@@ -24,37 +23,37 @@ ENERGY_MODES: Dict[int, str] = {
     128: "Battery Discharging",
 }
 
-GRID_MODES: Dict[int, str] = {
+GRID_MODES: dict[int, str] = {
     0: "Not connected to grid",
     1: "Connected to grid",
     2: "Fault",
 }
 
-GRID_IN_OUT_MODES: Dict[int, str] = {
+GRID_IN_OUT_MODES: dict[int, str] = {
     0: "Idle",
     1: "Exporting",
     2: "Importing",
 }
 
-LOAD_MODES: Dict[int, str] = {
+LOAD_MODES: dict[int, str] = {
     0: "Inverter and the load is disconnected",
     1: "The inverter is connected to a load",
 }
 
-PV_MODES: Dict[int, str] = {
+PV_MODES: dict[int, str] = {
     0: "PV panels not connected",
     1: "PV panels connected, no power",
     2: "PV panels connected, producing power",
 }
 
-WORK_MODES: Dict[int, str] = {
+WORK_MODES: dict[int, str] = {
     0: "Wait Mode",
     1: "Normal",
     2: "Error",
     4: "Check Mode",
 }
 
-WORK_MODES_ET: Dict[int, str] = {
+WORK_MODES_ET: dict[int, str] = {
     0: "Wait Mode",
     1: "Normal (On-Grid)",
     2: "Normal (Off-Grid)",
@@ -63,14 +62,14 @@ WORK_MODES_ET: Dict[int, str] = {
     5: "Check Mode",
 }
 
-WORK_MODES_ES: Dict[int, str] = {
+WORK_MODES_ES: dict[int, str] = {
     0: "Inverter Off - Standby",
     1: "Inverter On",
     2: "Inverter Abnormal, stopping power",
     3: "Inverter Severly Abnormal, 20 seconds to restart",
 }
 
-SAFETY_COUNTRIES: Dict[int, str] = {
+SAFETY_COUNTRIES: dict[int, str] = {
     0: "IT CEI 0-21",
     1: "CZ-A1",
     2: "DE LV with PV",
@@ -198,7 +197,7 @@ SAFETY_COUNTRIES: Dict[int, str] = {
     149: "Brazil 254Vac",
 }
 
-ERROR_CODES: Dict[int, str] = {
+ERROR_CODES: dict[int, str] = {
     31: 'Internal Communication Failure',
     30: 'EEPROM R/W Failure',
     29: 'Fac Failure',
@@ -233,7 +232,7 @@ ERROR_CODES: Dict[int, str] = {
     0: 'GFCI Device Check Failure',
 }
 
-DIAG_STATUS_CODES: Dict[int, str] = {
+DIAG_STATUS_CODES: dict[int, str] = {
     0: "Battery voltage low",
     1: "Battery SOC low",
     2: "Battery SOC in back",
@@ -263,9 +262,10 @@ DIAG_STATUS_CODES: Dict[int, str] = {
     26: "Real power limit set",
     27: "DC output on",
     28: "SOC protect off",
+    30: "BMS: Emergency charging",
 }
 
-BMS_ALARM_CODES: Dict[int, str] = {
+BMS_ALARM_CODES: dict[int, str] = {
     15: 'Charging over-voltage 3',
     14: 'Discharging under-voltage 3',
     13: 'Cell temperature high 3',
@@ -284,7 +284,7 @@ BMS_ALARM_CODES: Dict[int, str] = {
     0: 'Charging over-voltage 2',
 }
 
-BMS_WARNING_CODES: Dict[int, str] = {
+BMS_WARNING_CODES: dict[int, str] = {
     11: 'System temperature high',
     10: 'System temperature low 2',
     9: 'System temperature low 1',
@@ -299,7 +299,7 @@ BMS_WARNING_CODES: Dict[int, str] = {
     0: 'Charging over-voltage 1',
 }
 
-DERATING_MODE_CODES: Dict[int, str] = {
+DERATING_MODE_CODES: dict[int, str] = {
     31: '',
     30: '',
     29: '',
@@ -333,3 +333,9 @@ DERATING_MODE_CODES: Dict[int, str] = {
     1: 'Active power derating',
     0: 'Overtemperature derating',
 }
+
+METER_COMMUNICATION_STATUS: dict[int, str] = {
+    0: '',
+    1: 'Normal',
+    2: 'Disconnected',
+}