goodwe 0.3.2__py3-none-any.whl → 0.3.3__py3-none-any.whl

goodwe/es.py

@@ -15,7 +15,7 @@ logger = logging.getLogger(__name__)
 
 
 class ES(Inverter):
-    """Class representing inverter of ES/EM/BP family"""
+    """Class representing inverter of ES/EM/BP family AKA platform 105"""
 
     _READ_DEVICE_VERSION_INFO: ProtocolCommand = Aa55ProtocolCommand("010200", "0182")
     _READ_DEVICE_RUNNING_DATA: ProtocolCommand = Aa55ProtocolCommand("010600", "0186")

goodwe/et.py

@@ -7,7 +7,7 @@ from .exceptions import RequestRejectedException
 from .inverter import Inverter
 from .inverter import OperationMode
 from .inverter import SensorKind as Kind
-from .model import is_2_battery, is_4_mppt, is_single_phase
+from .model import is_2_battery, is_4_mppt, is_745_platform, is_single_phase
 from .protocol import ProtocolCommand, ModbusReadCommand, ModbusWriteCommand, ModbusWriteMultiCommand
 from .sensor import *
 
@@ -15,7 +15,7 @@ logger = logging.getLogger(__name__)
 
 
 class ET(Inverter):
-    """Class representing inverter of ET/EH/BT/BH or GE's GEH families"""
+    """Class representing inverter of ET/EH/BT/BH or GE's GEH families AKA platform 205 or 745"""
 
     # Modbus registers from offset 0x891c (35100), count 0x7d (125)
     __all_sensors: Tuple[Sensor, ...] = (
@@ -384,19 +384,25 @@ class ET(Inverter):
 
         Integer("load_control_mode", 47595, "Load Control Mode", "", Kind.AC),
         Integer("load_control_switch", 47596, "Load Control Switch", "", Kind.AC),
-        Integer("load_control_soc", 47596, "Load Control SoC", "", Kind.AC),
+        Integer("load_control_soc", 47597, "Load Control SoC", "", Kind.AC),
 
         Integer("fast_charging_power", 47603, "Fast Charging Power", "%", Kind.BAT),
     )
 
     # Settings added in ARM firmware 22
     __settings_arm_fw_22: Tuple[Sensor, ...] = (
+        Long("peak_shaving_power_limit", 47542, "Peak Shaving Power Limit"),
+        Integer("peak_shaving_soc", 47544, "Peak Shaving SoC"),
         # EcoModeV2("eco_modeV2_5", 47571, "Eco Mode Version 2 Power Group 5"),
         # EcoModeV2("eco_modeV2_6", 47577, "Eco Mode Version 2 Power Group 6"),
         # EcoModeV2("eco_modeV2_7", 47583, "Eco Mode Version 2 Power Group 7"),
         PeakShavingMode("peak_shaving_mode", 47589, "Peak Shaving Mode"),
 
         Integer("dod_holding", 47602, "DoD Holding", "", Kind.BAT),
+        Integer("backup_mode_enable", 47605, "Backup Mode Switch"),
+        Integer("max_charge_power", 47606, "Max Charge Power"),
+        Integer("smart_charging_enable", 47609, "Smart Charging Mode Switch"),
+        Integer("eco_mode_enable", 47612, "Eco Mode Switch"),
     )
 
     def __init__(self, host: str, comm_addr: int = 0, timeout: int = 1, retries: int = 3):
@@ -626,6 +632,7 @@ class ET(Inverter):
             await self._set_offline(True)
             await self.write_setting('backup_supply', 1)
             await self.write_setting('cold_start', 4)
+            await self._clear_battery_mode_param()
         elif operation_mode == OperationMode.BACKUP:
             await self.write_setting('work_mode', 2)
             await self._set_offline(False)
@@ -636,13 +643,20 @@ class ET(Inverter):
         elif operation_mode == OperationMode.PEAK_SHAVING:
             await self.write_setting('work_mode', 4)
             await self._set_offline(False)
+            await self._clear_battery_mode_param()
         elif operation_mode in (OperationMode.ECO_CHARGE, OperationMode.ECO_DISCHARGE):
             if eco_mode_power < 0 or eco_mode_power > 100:
                 raise ValueError()
             if eco_mode_soc < 0 or eco_mode_soc > 100:
                 raise ValueError()
+
             eco_mode: EcoMode | Sensor = self._settings.get('eco_mode_1')
-            await self._read_setting(eco_mode)
+            # Load the current values to try to detect schedule type
+            try:
+                await self._read_setting(eco_mode)
+            except ValueError:
+                pass
+            eco_mode.set_schedule_type(ScheduleType.ECO_MODE, is_745_platform(self))
             if operation_mode == OperationMode.ECO_CHARGE:
                 await self.write_setting('eco_mode_1', eco_mode.encode_charge(eco_mode_power, eco_mode_soc))
             else:

goodwe/inverter.py

@@ -76,8 +76,8 @@ class OperationMode(IntEnum):
     BACKUP = 2
     ECO = 3
     PEAK_SHAVING = 4
-    ECO_CHARGE = 5
-    ECO_DISCHARGE = 6
+    ECO_CHARGE = 10
+    ECO_DISCHARGE = 11
 
 
 class Inverter(ABC):

goodwe/model.py

@@ -1,27 +1,32 @@
+# Serial number tags to identify inverter type
 from .inverter import Inverter
 
-# Serial number tags to identify inverter type
-ET_MODEL_TAGS = ["ETU", "ETL", "ETR", "ETC", "EHU", "EHR", "EHB", "BTU", "BTN", "BTC", "BHU", "AES", "ABP", "HHI",
-                 "HSB", "HUA", "CUA",
-                 "ESN", "EMN", "ERN", "EBN",  # ES Gen 2
-                 "HLB", "HMB", "HBB", "SPN"]  # Gen 2
-ES_MODEL_TAGS = ["ESU", "EMU", "ESA", "BPS", "BPU", "EMJ", "IJL"]
-DT_MODEL_TAGS = ["DTU", "DTS",
+PLATFORM_105_MODELS = ("ESU", "EMU", "ESA", "BPS", "BPU", "EMJ", "IJL")
+PLATFORM_205_MODELS = ("ETU", "ETL", "ETR", "BHN", "EHU", "BHU", "EHR", "BTU")
+PLATFORM_745_LV_MODELS = ("ESN", "EBN", "EMN", "SPN", "ERN", "ESC", "HLB", "HMB", "HBB", "EOA")
+PLATFORM_745_HV_MODELS = ("ETT", "HTA", "HUB", "AEB", "SPB", "CUB", "EUB", "HEB", "ERB", "BTT", "ETF", "ARB", "URB",
+                          "EBR")
+PLATFORM_753_MODELS = ("AES", "HHI", "ABP", "EHB", "HSB", "HUA", "CUA")
+
+ET_MODEL_TAGS = PLATFORM_205_MODELS + PLATFORM_745_LV_MODELS + PLATFORM_745_HV_MODELS + PLATFORM_753_MODELS + (
+    "ETC", "BTC", "BTN")  # Qianhai
+ES_MODEL_TAGS = PLATFORM_105_MODELS
+DT_MODEL_TAGS = ("DTU", "DTS",
                  "MSU", "MST", "MSC", "DSN", "DTN", "DST", "NSU", "SSN", "SST", "SSX", "SSY",
-                 "PSB", "PSC"]
+                 "PSB", "PSC")
 
-SINGLE_PHASE_MODELS = ["DSN", "DST", "NSU", "SSN", "SST", "SSX", "SSY",  # DT
+SINGLE_PHASE_MODELS = ("DSN", "DST", "NSU", "SSN", "SST", "SSX", "SSY",  # DT
                        "MSU", "MST", "PSB", "PSC",
                        "MSC",  # Found on third gen MS
                        "EHU", "EHR", "HSB",  # ET
-                       "ESN", "EMN", "ERN", "EBN", "HLB", "HMB", "HBB", "SPN"]  # ES Gen 2
+                       "ESN", "EMN", "ERN", "EBN", "HLB", "HMB", "HBB", "SPN")  # ES Gen 2
 
-MPPT3_MODELS = ["MSU", "MST", "PSC", "MSC",
-                "25KET", "29K9ET"]
+MPPT3_MODELS = ("MSU", "MST", "PSC", "MSC",
+                "25KET", "29K9ET")
 
-MPPT4_MODELS = ["HSB"]
+MPPT4_MODELS = ("HSB",)
 
-BAT_2_MODELS = ["25KET", "29K9ET"]
+BAT_2_MODELS = ("25KET", "29K9ET")
 
 
 def is_single_phase(inverter: Inverter) -> bool:
@@ -38,3 +43,8 @@ def is_4_mppt(inverter: Inverter) -> bool:
 
 def is_2_battery(inverter: Inverter) -> bool:
     return any(model in inverter.serial_number for model in BAT_2_MODELS)
+
+
+def is_745_platform(inverter: Inverter) -> bool:
+    return any(model in inverter.serial_number for model in PLATFORM_745_LV_MODELS) or any(
+        model in inverter.serial_number for model in PLATFORM_745_HV_MODELS)

goodwe/sensor.py

@@ -21,12 +21,13 @@ class ScheduleType(IntEnum):
     PEAK_SHAVING = 3,
     BACKUP_MODE = 4,
     SMART_CHARGE_MODE = 5,
-    ECO_MODE_745 = 6
+    ECO_MODE_745 = 6,
+    NOT_SET = 85
 
     @classmethod
     def detect_schedule_type(cls, value: int) -> ScheduleType:
         """Detect schedule type from its on/off value"""
-        if value in (0, -1, 85):
+        if value in (0, -1):
             return ScheduleType.ECO_MODE
         elif value in (1, -2):
             return ScheduleType.DRY_CONTACT_LOAD
@@ -40,6 +41,8 @@ class ScheduleType(IntEnum):
             return ScheduleType.SMART_CHARGE_MODE
         elif value in (6, -7):
             return ScheduleType.ECO_MODE_745
+        elif value == 85:
+            return ScheduleType.NOT_SET
         else:
             raise ValueError(f"{value}: on_off value {value} out of range.")
 
@@ -52,12 +55,13 @@ class ScheduleType(IntEnum):
 
     def decode_power(self, value: int) -> int:
         """Decode human readable value of power parameter"""
-        if self == ScheduleType.ECO_MODE:
-            return value
-        elif self == ScheduleType.PEAK_SHAVING:
+        if self == ScheduleType.PEAK_SHAVING:
             return value * 10
-        if self == ScheduleType.ECO_MODE_745:
+        elif self == ScheduleType.ECO_MODE_745:
             return int(value / 10)
+        elif self == ScheduleType.NOT_SET:
+            # Prevent out of range values when changing mode
+            return value if -100 <= value <= 100 else int(value / 10)
         else:
             return value
 
@@ -67,7 +71,7 @@ class ScheduleType(IntEnum):
             return value
         elif self == ScheduleType.PEAK_SHAVING:
             return int(value / 10)
-        if self == ScheduleType.ECO_MODE_745:
+        elif self == ScheduleType.ECO_MODE_745:
             return value * 10
         else:
             return value
@@ -76,7 +80,7 @@ class ScheduleType(IntEnum):
         """Check if the value fits in allowed values range"""
         if self == ScheduleType.ECO_MODE:
             return -100 <= value <= 100
-        if self == ScheduleType.ECO_MODE_745:
+        elif self == ScheduleType.ECO_MODE_745:
             return -1000 <= value <= 1000
         else:
             return True
@@ -298,6 +302,19 @@ class ByteL(Byte):
 
 
 class Integer(Sensor):
+    """Sensor representing unsigned int value encoded in 2 bytes"""
+
+    def __init__(self, id_: str, offset: int, name: str, unit: str = "", kind: Optional[SensorKind] = None):
+        super().__init__(id_, offset, name, 2, unit, kind)
+
+    def read_value(self, data: ProtocolResponse):
+        return read_bytes2(data)
+
+    def encode_value(self, value: Any, register_value: bytes = None) -> bytes:
+        return int.to_bytes(int(value), length=2, byteorder="big", signed=False)
+
+
+class IntegerS(Sensor):
     """Sensor representing signed int value encoded in 2 bytes"""
 
     def __init__(self, id_: str, offset: int, name: str, unit: str = "", kind: Optional[SensorKind] = None):
@@ -311,6 +328,19 @@ class Integer(Sensor):
 
 
 class Long(Sensor):
+    """Sensor representing unsigned int value encoded in 4 bytes"""
+
+    def __init__(self, id_: str, offset: int, name: str, unit: str = "", kind: Optional[SensorKind] = None):
+        super().__init__(id_, offset, name, 4, unit, kind)
+
+    def read_value(self, data: ProtocolResponse):
+        return read_bytes4(data)
+
+    def encode_value(self, value: Any, register_value: bytes = None) -> bytes:
+        return int.to_bytes(int(value), length=4, byteorder="big", signed=False)
+
+
+class LongS(Sensor):
     """Sensor representing signed int value encoded in 4 bytes"""
 
     def __init__(self, id_: str, offset: int, name: str, unit: str = "", kind: Optional[SensorKind] = None):
@@ -476,6 +506,14 @@ class EcoMode(ABC):
     def is_eco_discharge_mode(self) -> bool:
         """Answer if it represents the emulated 24/7 fulltime discharge mode"""
 
+    @abstractmethod
+    def get_schedule_type(self) -> ScheduleType:
+        """Answer the schedule type"""
+
+    @abstractmethod
+    def set_schedule_type(self, schedule_type: ScheduleType, is745: bool):
+        """Set the schedule type"""
+
 
 class EcoModeV1(Sensor, EcoMode):
     """Sensor representing Eco Mode Battery Power Group encoded in 8 bytes"""
@@ -518,8 +556,6 @@ class EcoModeV1(Sensor, EcoMode):
             raise ValueError(f"{self.id_}: on_off value {self.on_off} out of range.")
         self.day_bits = read_byte(data)
         self.days = decode_day_of_week(self.day_bits)
-        if self.day_bits < 0:
-            raise ValueError(f"{self.id_}: day_bits value {self.day_bits} out of range.")
         return self
 
     def encode_value(self, value: Any, register_value: bytes = None) -> bytes:
@@ -561,6 +597,14 @@ class EcoModeV1(Sensor, EcoMode):
             and self.day_bits == 127 \
             and self.power > 0
 
+    def get_schedule_type(self) -> ScheduleType:
+        """Answer the schedule type"""
+        return ScheduleType.ECO_MODE
+
+    def set_schedule_type(self, schedule_type: ScheduleType, is745: bool):
+        """Set the schedule type"""
+        pass
+
     def as_eco_mode_v2(self) -> EcoModeV2:
         """Convert V1 to V2 EcoMode"""
         result = EcoModeV2(self.id_, self.offset, self.name)
@@ -617,8 +661,6 @@ class Schedule(Sensor, EcoMode):
         self.schedule_type = ScheduleType.detect_schedule_type(self.on_off)
         self.day_bits = read_byte(data)
         self.days = decode_day_of_week(self.day_bits)
-        if self.day_bits < 0:
-            raise ValueError(f"{self.id_}: day_bits value {self.day_bits} out of range.")
         self.power = read_bytes2_signed(data)  # negative=charge, positive=discharge
         if not self.schedule_type.is_in_range(self.power):
             raise ValueError(f"{self.id_}: power value {self.power} out of range.")
@@ -680,6 +722,19 @@ class Schedule(Sensor, EcoMode):
             and self.power > 0 \
             and (self.month_bits == 0 or self.month_bits == 0x0fff)
 
+    def get_schedule_type(self) -> ScheduleType:
+        """Answer the schedule type"""
+        return self.schedule_type
+
+    def set_schedule_type(self, schedule_type: ScheduleType, is745: bool):
+        """Set the schedule type"""
+        if schedule_type == ScheduleType.ECO_MODE:
+            # try to keep-reuse the type, use is745 only when necessary
+            if self.schedule_type not in (ScheduleType.ECO_MODE, ScheduleType.ECO_MODE_745):
+                self.schedule_type = ScheduleType.ECO_MODE_745 if is745 else ScheduleType.ECO_MODE
+        else:
+            self.schedule_type = schedule_type
+
     def as_eco_mode_v1(self) -> EcoModeV1:
         """Convert V2 to V1 EcoMode"""
         result = EcoModeV1(self.id_, self.offset, self.name)
@@ -891,6 +946,10 @@ def decode_bitmap(value: int, bitmap: Dict[int, str]) -> str:
 
 
 def decode_day_of_week(data: int) -> str:
+    if data == -1:
+        return "Mon-Sun"
+    elif data == 0:
+        return ""
     bits = bin(data)[2:]
     daynames = list(DAY_NAMES)
     days = ""
@@ -904,7 +963,7 @@ def decode_day_of_week(data: int) -> str:
 
 
 def decode_months(data: int) -> str | None:
-    if data == 0 or data == 0x0fff:
+    if data <= 0 or data == 0x0fff:
         return None
     bits = bin(data)[2:]
     monthnames = list(MONTH_NAMES)

{goodwe-0.3.2.dist-info → goodwe-0.3.3.dist-info}/METADATA

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

goodwe-0.3.3.dist-info/RECORD

@@ -0,0 +1,16 @@
+goodwe/__init__.py,sha256=PInrrZEpTmMOQKk494vIz8EKSaw_qLBNz-6t9eLIUcg,5642
+goodwe/const.py,sha256=Nw-nd4UJuqUOLfbmOrxTHEdS1AuaTDSpZzQqR6tBb8w,7912
+goodwe/dt.py,sha256=bI53MVdZjtxTYU2qJLO8icsvF6UiXrkgH95V3iUwXT0,10581
+goodwe/es.py,sha256=KZLBydRSzzAnbI8-o_-sKiJeunJGuCKr7N8V8_Ft__U,22434
+goodwe/et.py,sha256=P4H5Q17Gx8V8Y9os5HfiECsVIZ1znx13pGRFzc93n54,39228
+goodwe/exceptions.py,sha256=I6PHG0GTWgxNrDVZwJZBnyzItRq5eiM6ci23-EEsn1I,1012
+goodwe/inverter.py,sha256=uiQdti_4lGVLrSG94GgxgALWuevY6hl9ekdHQTomR-0,10325
+goodwe/modbus.py,sha256=ZPib-zKnOVE5zc0RNnhlf0w_26QBees1ScWGo6bAj0o,4685
+goodwe/model.py,sha256=dWBjMFJMnhZoUdDd9fGT54DERDANz4TirK0Wy8kWMbk,2068
+goodwe/protocol.py,sha256=pUkXTP2DqpKXGO7rbRfHq1x82Y1QM6OiRVx8cAtS0sM,13162
+goodwe/sensor.py,sha256=cPZCC3_9gk5zPVTkzhuDa6byz_dM4xCyE8FtV5nxqgg,36845
+goodwe-0.3.3.dist-info/LICENSE,sha256=aZAhk3lRdYT1YZV-IKRHISEcc_KNUmgfuNO3QhRamNM,1073
+goodwe-0.3.3.dist-info/METADATA,sha256=0sEhEL3Uv3TSMsOTCqZSE1YEpeoDD609fcQodacEIvs,3050
+goodwe-0.3.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+goodwe-0.3.3.dist-info/top_level.txt,sha256=kKoiqiVvAxDaDJYMZZQLgHQj9cuWT1MXLfXElTDuf8s,7
+goodwe-0.3.3.dist-info/RECORD,,

goodwe-0.3.2.dist-info/RECORD

@@ -1,16 +0,0 @@
-goodwe/__init__.py,sha256=PInrrZEpTmMOQKk494vIz8EKSaw_qLBNz-6t9eLIUcg,5642
-goodwe/const.py,sha256=Nw-nd4UJuqUOLfbmOrxTHEdS1AuaTDSpZzQqR6tBb8w,7912
-goodwe/dt.py,sha256=bI53MVdZjtxTYU2qJLO8icsvF6UiXrkgH95V3iUwXT0,10581
-goodwe/es.py,sha256=d0RyW70dnxaMNVZzSxE7eEoW2dMDzQQxA4MlSADOyuo,22417
-goodwe/et.py,sha256=zQUZAhaC4HUV_0hzF6M85ffXasBBKSbpNkT_x37EZjw,38443
-goodwe/exceptions.py,sha256=I6PHG0GTWgxNrDVZwJZBnyzItRq5eiM6ci23-EEsn1I,1012
-goodwe/inverter.py,sha256=HvVtFBz5Zvl1je1V2AuLqpoB1vsur_gDHu-6SjNbJ8o,10323
-goodwe/modbus.py,sha256=ZPib-zKnOVE5zc0RNnhlf0w_26QBees1ScWGo6bAj0o,4685
-goodwe/model.py,sha256=Yy662c6VpuLozxo1Q7Llw1g34UhT5qJd9_rITIjmEd4,1523
-goodwe/protocol.py,sha256=pUkXTP2DqpKXGO7rbRfHq1x82Y1QM6OiRVx8cAtS0sM,13162
-goodwe/sensor.py,sha256=M8v3flB4V7VxY91G1m2a1tdaD5j_lqtVzkxxrcTFHmE,34696
-goodwe-0.3.2.dist-info/LICENSE,sha256=aZAhk3lRdYT1YZV-IKRHISEcc_KNUmgfuNO3QhRamNM,1073
-goodwe-0.3.2.dist-info/METADATA,sha256=izdqayJnYLUwJt9DPS2oUrgMUxGzNNIDMmokDNb3RNs,3050
-goodwe-0.3.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-goodwe-0.3.2.dist-info/top_level.txt,sha256=kKoiqiVvAxDaDJYMZZQLgHQj9cuWT1MXLfXElTDuf8s,7
-goodwe-0.3.2.dist-info/RECORD,,