goodwe 0.3.2__tar.gz → 0.3.4__tar.gz

{goodwe-0.3.2/goodwe.egg-info → goodwe-0.3.4}/PKG-INFO

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

goodwe-0.3.4/VERSION

@@ -0,0 +1 @@
+0.3.4

{goodwe-0.3.2 → goodwe-0.3.4}/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")
@@ -95,7 +95,7 @@ class ES(Inverter):
         Power("pback_up", 81, "Back-up Power", Kind.UPS),
         # pload + pback_up
         Calculated("plant_power",
-                   lambda data: round(read_bytes2(data, 47) + read_bytes2(data, 81)),
+                   lambda data: round(read_bytes2(data, 47, 0) + read_bytes2(data, 81, 0)),
                    "Plant Power", "W", Kind.AC),
         Decimal("meter_power_factor", 83, 1000, "Meter Power Factor", "", Kind.GRID),  # modbus 0x531
         # Integer("xx85", 85, "Unknown sensor@85"),
@@ -135,7 +135,7 @@ class ES(Inverter):
         Integer("charge_i", 26, "Charge Current", "A", ),
         Integer("discharge_i", 28, "Discharge Current", "A", ),
         Decimal("discharge_v", 30, 10, "Discharge Voltage", "V"),
-        Calculated("dod", lambda data: 100 - read_bytes2(data, 32), "Depth of Discharge", "%"),
+        Calculated("dod", lambda data: 100 - read_bytes2(data, 32, 0), "Depth of Discharge", "%"),
         Integer("battery_activated", 34, "Battery Activated"),
         Integer("bp_off_grid_charge", 36, "BP Off-grid Charge"),
         Integer("bp_pv_discharge", 38, "BP PV Discharge"),
@@ -285,19 +285,25 @@ class ES(Inverter):
     async def get_operation_modes(self, include_emulated: bool) -> Tuple[OperationMode, ...]:
         result = [e for e in OperationMode]
         result.remove(OperationMode.PEAK_SHAVING)
+        result.remove(OperationMode.SELF_USE)
         if not include_emulated:
             result.remove(OperationMode.ECO_CHARGE)
             result.remove(OperationMode.ECO_DISCHARGE)
         return tuple(result)
 
     async def get_operation_mode(self) -> OperationMode:
-        mode = OperationMode(await self.read_setting('work_mode'))
+        mode_id = await self.read_setting('work_mode')
+        try:
+            mode = OperationMode(mode_id)
+        except ValueError:
+            logger.debug("Unknown work_mode value %d", mode_id)
+            return None
         if OperationMode.ECO != mode:
             return mode
-        ecomode = await self.read_setting('eco_mode_1')
-        if ecomode.is_eco_charge_mode():
+        eco_mode = await self.read_setting('eco_mode_1')
+        if eco_mode.is_eco_charge_mode():
             return OperationMode.ECO_CHARGE
-        elif ecomode.is_eco_discharge_mode():
+        elif eco_mode.is_eco_discharge_mode():
             return OperationMode.ECO_DISCHARGE
         else:
             return OperationMode.ECO

{goodwe-0.3.2 → goodwe-0.3.4}/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, ...] = (
@@ -35,10 +35,10 @@ class ET(Inverter):
         # ppv1 + ppv2 + ppv3 + ppv4
         Calculated("ppv",
                    lambda data:
-                   max(0, read_bytes4(data, 35105)) +
-                   max(0, read_bytes4(data, 35109)) +
-                   max(0, read_bytes4(data, 35113)) +
-                   max(0, read_bytes4(data, 35117)),
+                   max(0, read_bytes4(data, 35105, 0)) +
+                   max(0, read_bytes4(data, 35109, 0)) +
+                   max(0, read_bytes4(data, 35113, 0)) +
+                   max(0, read_bytes4(data, 35117, 0)),
                    "PV Power", "W", Kind.PV),
         ByteH("pv4_mode", 35119, "PV4 Mode code", "", Kind.PV),
         EnumH("pv4_mode_label", 35119, PV_MODES, "PV4 Mode", Kind.PV),
@@ -145,10 +145,10 @@ class ET(Inverter):
         # ppv1 + ppv2 + ppv3 + ppv4 + pbattery1 - active_power
         Calculated("house_consumption",
                    lambda data:
-                   read_bytes4(data, 35105) +
-                   read_bytes4(data, 35109) +
-                   read_bytes4(data, 35113) +
-                   read_bytes4(data, 35117) +
+                   read_bytes4(data, 35105, 0) +
+                   read_bytes4(data, 35109, 0) +
+                   read_bytes4(data, 35113, 0) +
+                   read_bytes4(data, 35117, 0) +
                    read_bytes4_signed(data, 35182) -
                    read_bytes2_signed(data, 35140),
                    "House Consumption", "W", Kind.AC),
@@ -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):
@@ -598,19 +604,26 @@ class ET(Inverter):
         result = [e for e in OperationMode]
         if not self._has_peak_shaving:
             result.remove(OperationMode.PEAK_SHAVING)
+        if not is_745_platform(self):
+            result.remove(OperationMode.SELF_USE)
         if not include_emulated:
             result.remove(OperationMode.ECO_CHARGE)
             result.remove(OperationMode.ECO_DISCHARGE)
         return tuple(result)
 
     async def get_operation_mode(self) -> OperationMode:
-        mode = OperationMode(await self.read_setting('work_mode'))
+        mode_id = await self.read_setting('work_mode')
+        try:
+            mode = OperationMode(mode_id)
+        except ValueError:
+            logger.debug("Unknown work_mode value %d", mode_id)
+            return None
         if OperationMode.ECO != mode:
             return mode
-        ecomode = await self.read_setting('eco_mode_1')
-        if ecomode.is_eco_charge_mode():
+        eco_mode = await self.read_setting('eco_mode_1')
+        if eco_mode.is_eco_charge_mode():
             return OperationMode.ECO_CHARGE
-        elif ecomode.is_eco_discharge_mode():
+        elif eco_mode.is_eco_discharge_mode():
             return OperationMode.ECO_DISCHARGE
         else:
             return OperationMode.ECO
@@ -626,6 +639,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 +650,24 @@ 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 == OperationMode.SELF_USE:
+            await self.write_setting('work_mode', 5)
+            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-0.3.2 → goodwe-0.3.4}/goodwe/inverter.py

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

goodwe-0.3.4/goodwe/model.py

@@ -0,0 +1,50 @@
+# Serial number tags to identify inverter type
+from .inverter import Inverter
+
+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")
+
+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
+
+MPPT3_MODELS = ("MSU", "MST", "PSC", "MSC",
+                "25KET", "29K9ET")
+
+MPPT4_MODELS = ("HSB",)
+
+BAT_2_MODELS = ("25KET", "29K9ET")
+
+
+def is_single_phase(inverter: Inverter) -> bool:
+    return any(model in inverter.serial_number for model in SINGLE_PHASE_MODELS)
+
+
+def is_3_mppt(inverter: Inverter) -> bool:
+    return any(model in inverter.serial_number for model in MPPT3_MODELS)
+
+
+def is_4_mppt(inverter: Inverter) -> bool:
+    return any(model in inverter.serial_number for model in MPPT4_MODELS)
+
+
+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-0.3.2 → goodwe-0.3.4}/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
@@ -179,7 +183,7 @@ class Energy(Sensor):
 
     def read_value(self, data: ProtocolResponse):
         value = read_bytes2(data)
-        return float(value) / 10
+        return float(value) / 10 if value else None
 
 
 class Energy4(Sensor):
@@ -190,7 +194,7 @@ class Energy4(Sensor):
 
     def read_value(self, data: ProtocolResponse):
         value = read_bytes4(data)
-        return float(value) / 10
+        return float(value) / 10 if value else None
 
 
 class Apparent(Sensor):
@@ -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, None, 0)
+
+    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, None, 0)
+
+    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):
@@ -384,7 +414,7 @@ class EnumH(Sensor):
 
 
 class EnumL(Sensor):
-    """Sensor representing label from enumeration encoded in 1 bytes (low 8 bits of 16bit register)"""
+    """Sensor representing label from enumeration encoded in 1 byte (low 8 bits of 16bit register)"""
 
     def __init__(self, id_: str, offset: int, labels: Dict, name: str, kind: Optional[SensorKind] = None):
         super().__init__(id_, offset, name, 1, "", kind)
@@ -403,7 +433,7 @@ class Enum2(Sensor):
         self._labels: Dict = labels
 
     def read_value(self, data: ProtocolResponse):
-        return self._labels.get(read_bytes2(data))
+        return self._labels.get(read_bytes2(data, None, 0))
 
 
 class EnumBitmap4(Sensor):
@@ -434,7 +464,8 @@ class EnumBitmap22(Sensor):
         raise NotImplementedError()
 
     def read(self, data: ProtocolResponse):
-        return decode_bitmap(read_bytes2(data, self.offset) << 16 + read_bytes2(data, self._offsetL), self._labels)
+        return decode_bitmap(read_bytes2(data, self.offset, 0) << 16 + read_bytes2(data, self._offsetL, 0),
+                             self._labels)
 
 
 class EnumCalculated(Sensor):
@@ -476,6 +507,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 +557,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 +598,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 +662,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 +723,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)
@@ -730,12 +786,12 @@ def read_byte(buffer: ProtocolResponse, offset: int = None) -> int:
     return int.from_bytes(buffer.read(1), byteorder="big", signed=True)
 
 
-def read_bytes2(buffer: ProtocolResponse, offset: int = None) -> int:
+def read_bytes2(buffer: ProtocolResponse, offset: int = None, undef: int = None) -> int:
     """Retrieve 2 byte (unsigned int) value from buffer"""
     if offset is not None:
         buffer.seek(offset)
     value = int.from_bytes(buffer.read(2), byteorder="big", signed=False)
-    return value if value != 0xffff else 0
+    return undef if value == 0xffff else value
 
 
 def read_bytes2_signed(buffer: ProtocolResponse, offset: int = None) -> int:
@@ -745,12 +801,12 @@ def read_bytes2_signed(buffer: ProtocolResponse, offset: int = None) -> int:
     return int.from_bytes(buffer.read(2), byteorder="big", signed=True)
 
 
-def read_bytes4(buffer: ProtocolResponse, offset: int = None) -> int:
+def read_bytes4(buffer: ProtocolResponse, offset: int = None, undef: int = None) -> int:
     """Retrieve 4 byte (unsigned int) value from buffer"""
     if offset is not None:
         buffer.seek(offset)
     value = int.from_bytes(buffer.read(4), byteorder="big", signed=False)
-    return value if value != 0xffffffff else 0
+    return undef if value == 0xffffffff else value
 
 
 def read_bytes4_signed(buffer: ProtocolResponse, offset: int = None) -> int:
@@ -891,6 +947,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 +964,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 → goodwe-0.3.4/goodwe.egg-info}/PKG-INFO

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

{goodwe-0.3.2 → goodwe-0.3.4}/tests/test_dt.py

@@ -95,7 +95,7 @@ class GW6000_DT_Test(DtMock):
         self.assertSensor('funbit', 0, '', data)
         self.assertSensor('vbus', 601.2, 'V', data)
         self.assertSensor('vnbus', 305.4, 'V', data)
-        self.assertSensor('derating_mode', -1, '', data)
+        self.assertSensor('derating_mode', 0, '', data)
         self.assertSensor('derating_mode_label', '', '', data)
 
         self.assertFalse(self.sensor_map, f"Some sensors were not tested {self.sensor_map}")
@@ -167,9 +167,9 @@ class GW8K_DT_Test(DtMock):
         self.assertSensor("apparent_power", 0, "VA", data),
         self.assertSensor("reactive_power", 0, "var", data),
         self.assertSensor('temperature', 45.3, 'C', data)
-        self.assertSensor('e_day', 0.0, 'kWh', data)
-        self.assertSensor('e_total', 0.0, 'kWh', data)
-        self.assertSensor('h_total', -1, 'h', data)
+        self.assertSensor('e_day', None, 'kWh', data)
+        self.assertSensor('e_total', None, 'kWh', data)
+        self.assertSensor('h_total', 0, 'h', data)
         self.assertSensor('safety_country', 32, '', data)
         self.assertSensor('safety_country_label', '50Hz 230Vac Default', '', data)
         self.assertSensor('funbit', 512, '', data)
@@ -221,7 +221,7 @@ class GW5000D_NS_Test(DtMock):
         self.assertSensor("apparent_power", -1, "VA", data),
         self.assertSensor("reactive_power", -1, "var", data),
         self.assertSensor('temperature', 1.4, 'C', data)
-        self.assertSensor('e_day', 0.0, 'kWh', data)
+        self.assertSensor('e_day', None, 'kWh', data)
         self.assertSensor('e_total', 881.7, 'kWh', data)
         self.assertSensor('h_total', 955, 'h', data)
         self.assertSensor('safety_country', 73, '', data)
@@ -229,7 +229,7 @@ class GW5000D_NS_Test(DtMock):
         self.assertSensor('funbit', 2400, '', data)
         self.assertSensor('vbus', 291.7, 'V', data)
         self.assertSensor('vnbus', 0, 'V', data)
-        self.assertSensor('derating_mode', -1, '', data)
+        self.assertSensor('derating_mode', 0, '', data)
         self.assertSensor('derating_mode_label', '', '', data)
 
     def test_get_grid_export_limit(self):
@@ -295,7 +295,7 @@ class GW5000_MS_Test(DtMock):
         self.assertSensor('funbit', 2384, '', data)
         self.assertSensor('vbus', 393.9, 'V', data)
         self.assertSensor('vnbus', 0, 'V', data)
-        self.assertSensor('derating_mode', -1, '', data)
+        self.assertSensor('derating_mode', 0, '', data)
         self.assertSensor('derating_mode_label', '', '', data)
 
 

{goodwe-0.3.2 → goodwe-0.3.4}/tests/test_et.py

@@ -164,7 +164,7 @@ class GW10K_ET_Test(EtMock):
         self.assertSensor('h_total', 9246, 'h', data)
         self.assertSensor("e_day_exp", 9.8, 'kWh', data)
         self.assertSensor("e_total_imp", 58.0, 'kWh', data)
-        self.assertSensor("e_day_imp", 0.0, 'kWh', data)
+        self.assertSensor("e_day_imp", None, 'kWh', data)
         self.assertSensor("e_load_total", 8820.2, 'kWh', data)
         self.assertSensor("e_load_day", 11.6, 'kWh', data)
         self.assertSensor("e_bat_charge_total", 2758.1, 'kWh', data)
@@ -369,7 +369,7 @@ class GW10K_ET_fw1023_Test(EtMock):
         self.assertEqual('02041-23-S00', self.arm_firmware)
 
     def test_GW10K_ET_setting_fw1023(self):
-        self.assertEqual(40, len(self.settings()))
+        self.assertEqual(46, len(self.settings()))
         settings = {s.id_: s for s in self.settings()}
         self.assertEqual('PeakShavingMode', type(settings.get("peak_shaving_mode")).__name__)
 
@@ -449,7 +449,7 @@ class GW6000_EH_Test(EtMock):
         self.assertSensor('safety_country_label', 'ES-A', '', data)
         self.assertSensor('work_mode', 1, '', data)
         self.assertSensor('work_mode_label', 'Normal (On-Grid)', '', data)
-        self.assertSensor('operation_mode', -1, '', data)
+        self.assertSensor('operation_mode', 0, '', data)
         self.assertSensor('error_codes', 0, '', data)
         self.assertSensor('errors', '', '', data)
         self.assertSensor("e_total", 59.4, 'kWh', data)
@@ -457,14 +457,14 @@ class GW6000_EH_Test(EtMock):
         self.assertSensor("e_total_exp", 58.6, 'kWh', data)
         self.assertSensor('h_total', 33, 'h', data)
         self.assertSensor("e_day_exp", 21.6, 'kWh', data)
-        self.assertSensor("e_total_imp", 0.0, 'kWh', data)
-        self.assertSensor("e_day_imp", 0.0, 'kWh', data)
+        self.assertSensor("e_total_imp", None, 'kWh', data)
+        self.assertSensor("e_day_imp", None, 'kWh', data)
         self.assertSensor("e_load_total", 70.1, 'kWh', data)
         self.assertSensor("e_load_day", 27.1, 'kWh', data)
-        self.assertSensor("e_bat_charge_total", 0.0, 'kWh', data)
-        self.assertSensor("e_bat_charge_day", 0.0, 'kWh', data)
-        self.assertSensor("e_bat_discharge_total", 0.0, 'kWh', data)
-        self.assertSensor("e_bat_discharge_day", 0.0, 'kWh', data)
+        self.assertSensor("e_bat_charge_total", None, 'kWh', data)
+        self.assertSensor("e_bat_charge_day", None, 'kWh', data)
+        self.assertSensor("e_bat_discharge_total", None, 'kWh', data)
+        self.assertSensor("e_bat_discharge_day", None, 'kWh', data)
         self.assertSensor('diagnose_result', 117983303, '', data)
         self.assertSensor('diagnose_result_label',
                           'Battery voltage low, Battery SOC low, Battery SOC in back, Discharge Driver On, Self-use load light, Battery Disconnected, Self-use off, Export power limit set, PF value set, Real power limit set',
@@ -550,7 +550,7 @@ class GEH10_1U_10_Test(EtMock):
         self.assertSensor('safety_country_label', 'Australia A', '', data)
         self.assertSensor('work_mode', 1, '', data)
         self.assertSensor('work_mode_label', 'Normal (On-Grid)', '', data)
-        self.assertSensor('operation_mode', -1, '', data)
+        self.assertSensor('operation_mode', 0, '', data)
         self.assertSensor('error_codes', 0, '', data)
         self.assertSensor('errors', '', '', data)
         self.assertSensor('e_total', 10225.8, 'kWh', data)
@@ -558,8 +558,8 @@ class GEH10_1U_10_Test(EtMock):
         self.assertSensor('e_total_exp', 10273.3, 'kWh', data)
         self.assertSensor('h_total', 3256, 'h', data)
         self.assertSensor('e_day_exp', 16.6, 'kWh', data)
-        self.assertSensor('e_total_imp', 0.0, 'kWh', data)
-        self.assertSensor('e_day_imp', 0.0, 'kWh', data)
+        self.assertSensor('e_total_imp', None, 'kWh', data)
+        self.assertSensor('e_day_imp', None, 'kWh', data)
         self.assertSensor('e_load_total', 4393.9, 'kWh', data)
         self.assertSensor('e_load_day', 10.7, 'kWh', data)
         self.assertSensor('e_bat_charge_total', 141.9, 'kWh', data)
@@ -771,7 +771,7 @@ class GW25K_ET_Test(EtMock):
         self.assertSensor('e_bat_charge_total', 91.3, 'kWh', data)
         self.assertSensor('e_bat_charge_day', 11.0, 'kWh', data)
         self.assertSensor('e_bat_discharge_total', 69.6, 'kWh', data)
-        self.assertSensor('e_bat_discharge_day', 0.0, 'kWh', data)
+        self.assertSensor('e_bat_discharge_day', None, 'kWh', data)
         self.assertSensor('diagnose_result', 33816960, '', data)
         self.assertSensor('diagnose_result_label',
                           'BMS: Discharge current low, APP: Discharge current too low, BMS: Charge disabled, PF value set',
@@ -1042,13 +1042,13 @@ class GW29K9_ET_Test(EtMock):
         self.assertSensor('h_total', 1175, 'h', data)
         self.assertSensor('e_day_exp', 1.2, 'kWh', data)
         self.assertSensor('e_total_imp', 8.7, 'kWh', data)
-        self.assertSensor('e_day_imp', 0.0, 'kWh', data)
+        self.assertSensor('e_day_imp', None, 'kWh', data)
         self.assertSensor('e_load_total', 10742.2, 'kWh', data)
         self.assertSensor('e_load_day', 43.8, 'kWh', data)
-        self.assertSensor('e_bat_charge_total', 0.0, 'kWh', data)
-        self.assertSensor('e_bat_charge_day', 0.0, 'kWh', data)
-        self.assertSensor('e_bat_discharge_total', 0.0, 'kWh', data)
-        self.assertSensor('e_bat_discharge_day', 0.0, 'kWh', data)
+        self.assertSensor('e_bat_charge_total', None, 'kWh', data)
+        self.assertSensor('e_bat_charge_day', None, 'kWh', data)
+        self.assertSensor('e_bat_discharge_total', None, 'kWh', data)
+        self.assertSensor('e_bat_discharge_day', None, 'kWh', data)
         self.assertSensor('diagnose_result', 33816782, '', data)
         self.assertSensor('diagnose_result_label',
                           'Battery SOC low, Battery SOC in back, BMS: Discharge disabled, '
@@ -1085,7 +1085,7 @@ class GW29K9_ET_Test(EtMock):
         self.assertSensor('meter_apparent_power3', -3175, 'VA', data)
         self.assertSensor('meter_apparent_power_total', -5667, 'VA', data)
         self.assertSensor('meter_type', 2, '', data)
-        self.assertSensor('meter_sw_version', -1, '', data)
+        self.assertSensor('meter_sw_version', 0, '', data)
         self.assertSensor('meter2_active_power', 0, 'W', data)
         self.assertSensor('meter2_e_total_exp', 0.0, 'kWh', data)
         self.assertSensor('meter2_e_total_imp', 0.0, 'kWh', data)

{goodwe-0.3.2 → goodwe-0.3.4}/tests/test_sensor.py

@@ -52,6 +52,17 @@ class TestUtils(TestCase):
         self.assertEqual(49, testee.read(data))
         self.assertEqual("0031", testee.encode_value(49).hex())
 
+        data = MockResponse("ff9e")
+        self.assertEqual(65438, testee.read(data))
+        self.assertEqual("ff9e", testee.encode_value(65438).hex())
+
+    def test_integer_signed(self):
+        testee = IntegerS("", 0, "", "", None)
+
+        data = MockResponse("0031")
+        self.assertEqual(49, testee.read(data))
+        self.assertEqual("0031", testee.encode_value(49).hex())
+
         data = MockResponse("ff9e")
         self.assertEqual(-98, testee.read(data))
         self.assertEqual("ff9e", testee.encode_value(-98).hex())
@@ -119,7 +130,7 @@ class TestUtils(TestCase):
         self.assertEqual(4294967293, testee.read(data))
 
         data = MockResponse("ffffffff")
-        self.assertEqual(0, testee.read(data))
+        self.assertIsNone(testee.read(data))
 
     def test_power4_signed(self):
         testee = Power4S("", 0, "", None)
@@ -142,7 +153,7 @@ class TestUtils(TestCase):
         data = MockResponse("00020972")
         self.assertEqual(13349.0, testee.read(data))
         data = MockResponse("ffffffff")
-        self.assertEqual(0.0, testee.read(data))
+        self.assertIsNone(testee.read(data))
 
     def test_timestamp(self):
         testee = Timestamp("", 0, "", None)
@@ -158,7 +169,6 @@ class TestUtils(TestCase):
         data = MockResponse("0d1e0e28ffc4ff1a")
         self.assertEqual("13:30-14:40 Mon,Wed,Thu -60% On", testee.read(data).__str__())
         self.assertEqual(bytes.fromhex("0d1e0e28ffc4ff1a"), testee.encode_value(bytes.fromhex("0d1e0e28ffc4ff1a")))
-        self.assertRaises(ValueError, lambda: testee.encode_value(bytes.fromhex("0d1e0e28ffc4ffff")))
         self.assertRaises(ValueError, lambda: testee.encode_value("some string"))
         self.assertFalse(testee.read(data).is_eco_charge_mode())
         self.assertFalse(testee.read(data).is_eco_discharge_mode())
@@ -188,7 +198,6 @@ class TestUtils(TestCase):
         self.assertEqual(ScheduleType.ECO_MODE, testee.schedule_type)
         self.assertEqual(bytes.fromhex("0d1e0e28ff1affc4005a0000"),
                          testee.encode_value(bytes.fromhex("0d1e0e28ff1affc4005a0000")))
-        self.assertRaises(ValueError, lambda: testee.encode_value(bytes.fromhex("0d1e0e28ffffffc4005a0000")))
         self.assertRaises(ValueError, lambda: testee.encode_value("some string"))
         self.assertFalse(testee.read(data).is_eco_charge_mode())
         self.assertFalse(testee.read(data).is_eco_discharge_mode())
@@ -208,6 +217,8 @@ class TestUtils(TestCase):
         self.assertFalse(testee.read(data).is_eco_charge_mode())
         self.assertFalse(testee.read(data).is_eco_discharge_mode())
 
+        data = MockResponse("0300080006fefd12005fcfff")
+        self.assertEqual("3:0-8:0 Mon -75% (SoC 95%) Off", testee.read(data).__str__())
         data = MockResponse("0000173b5500001400640000")
         self.assertEqual("0:0-23:59  20% (SoC 100%) Unset", testee.read(data).__str__())
         data = MockResponse("ffffffff557f000000010001")

goodwe-0.3.2/VERSION

@@ -1 +0,0 @@
-0.3.2

goodwe-0.3.2/goodwe/model.py

@@ -1,40 +0,0 @@
-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",
-                 "MSU", "MST", "MSC", "DSN", "DTN", "DST", "NSU", "SSN", "SST", "SSX", "SSY",
-                 "PSB", "PSC"]
-
-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
-
-MPPT3_MODELS = ["MSU", "MST", "PSC", "MSC",
-                "25KET", "29K9ET"]
-
-MPPT4_MODELS = ["HSB"]
-
-BAT_2_MODELS = ["25KET", "29K9ET"]
-
-
-def is_single_phase(inverter: Inverter) -> bool:
-    return any(model in inverter.serial_number for model in SINGLE_PHASE_MODELS)
-
-
-def is_3_mppt(inverter: Inverter) -> bool:
-    return any(model in inverter.serial_number for model in MPPT3_MODELS)
-
-
-def is_4_mppt(inverter: Inverter) -> bool:
-    return any(model in inverter.serial_number for model in MPPT4_MODELS)
-
-
-def is_2_battery(inverter: Inverter) -> bool:
-    return any(model in inverter.serial_number for model in BAT_2_MODELS)