python-qube-heatpump 1.7.0__tar.gz → 1.9.0__tar.gz

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-qube-heatpump
-Version: 1.7.0
+Version: 1.9.0
 Summary: Async Modbus client for Qube Heat Pumps
 Project-URL: Homepage, https://github.com/MattieGit/python-qube-heatpump
 Project-URL: Bug Tracker, https://github.com/MattieGit/python-qube-heatpump/issues

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "python-qube-heatpump"
-version = "1.7.0"
+version = "1.9.0"
 authors = [
   { name="MattieGit", email="6250046+MattieGit@users.noreply.github.com" },
 ]

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/src/python_qube_heatpump/__init__.py

@@ -7,6 +7,7 @@ from .const import (
     StatusCode,
     STATUS_CODE_MAP,
     get_status_code,
+    resolve_status,
 )
 from .entities import (
     BINARY_SENSORS,
@@ -37,6 +38,7 @@ __all__ = [
     "StatusCode",
     "STATUS_CODE_MAP",
     "get_status_code",
+    "resolve_status",
     # Network
     "async_get_mac_address",
 ]

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/src/python_qube_heatpump/client.py

@@ -121,6 +121,16 @@ class QubeClient:
         state.setpoint_dhw = await _read(const.USER_DHW_SETPOINT)
 
         self._apply_monotonic_clamping(state)
+
+        # Fetch binary sensors
+        binary_data = await self.read_all_binary_sensors()
+        for key, value in binary_data.items():
+            if hasattr(state, key):
+                setattr(state, key, value)
+
+        # Compute unified status (status_code + anti-legionella override)
+        state.status = const.resolve_status(state.status_code, state.req_antileg_1)
+
         return state
 
     @property

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/src/python_qube_heatpump/const.py

@@ -32,6 +32,7 @@ class StatusCode(str, Enum):
     HEATING = "heating"
     START_FAIL = "start_fail"
     HEATING_DHW = "heating_dhw"
+    ANTI_LEGIONELLA = "anti_legionella"
     UNKNOWN = "unknown"
 
 
@@ -56,6 +57,33 @@ def get_status_code(code: int) -> StatusCode:
     return STATUS_CODE_MAP.get(code, StatusCode.UNKNOWN)
 
 
+def resolve_status(code: int | None, antileg_active: bool | None) -> StatusCode:
+    """Resolve the unified heat pump status.
+
+    Combines the raw status code with the anti-legionella signal so consumers
+    receive a single status value. When anti-legionella is active the heat
+    pump is running a special DHW cycle that is otherwise hidden behind the
+    regular ``HEATING_DHW`` code; surfacing it as its own status makes the
+    device state visible without a separate binary sensor.
+
+    ``ALARM`` always takes precedence over anti-legionella: safety signals
+    must not be masked by normal operational modes.
+
+    Args:
+        code: Raw numeric status code from register 38, or ``None`` when
+            unavailable.
+        antileg_active: Current value of the anti-legionella discrete input
+            (``req_antileg_1``), or ``None`` when unavailable.
+
+    Returns:
+        The resolved :class:`StatusCode` value.
+    """
+    status = get_status_code(code) if code is not None else StatusCode.UNKNOWN
+    if antileg_active and status is not StatusCode.ALARM:
+        return StatusCode.ANTI_LEGIONELLA
+    return status
+
+
 # Register definitions (Address, Type, Data Type, Scale, Offset)
 # Scale/Offset are None if not used.
 # Format: KEY = (Address, ModbusType, DataType, Scale, Offset)

python_qube_heatpump-1.9.0/src/python_qube_heatpump/models.py

@@ -0,0 +1,111 @@
+"""Models for Qube Heat Pump."""
+
+from dataclasses import dataclass, field
+from typing import Any
+
+from .const import StatusCode
+
+
+@dataclass
+class QubeState:
+    """Representation of the Qube Heat Pump state.
+
+    Typed fields for core sensors (used by official HA integration).
+    Extended dict for additional entities (used by HACS integration).
+    """
+
+    # Temperatures
+    temp_supply: float | None = None
+    temp_return: float | None = None
+    temp_source_in: float | None = None
+    temp_source_out: float | None = None
+    temp_room: float | None = None
+    temp_dhw: float | None = None
+    temp_outside: float | None = None
+
+    # Power/Energy
+    power_thermic: float | None = None
+    power_electric: float | None = None
+    energy_total_electric: float | None = None
+    energy_total_thermic: float | None = None
+    cop_calc: float | None = None
+
+    # Operation
+    status_code: int | None = None
+    # Unified status combining status_code with req_antileg_1 override.
+    # Computed by QubeClient.get_all_data(); see const.resolve_status().
+    status: StatusCode | None = None
+    compressor_speed: float | None = None
+    flow_rate: float | None = None
+
+    # Setpoints (Read/Write)
+    setpoint_room_heat_day: float | None = None
+    setpoint_room_heat_night: float | None = None
+    setpoint_room_cool_day: float | None = None
+    setpoint_room_cool_night: float | None = None
+    setpoint_dhw: float | None = None
+
+    # Binary sensors - Outputs
+    dout_srcpmp_val: bool | None = None
+    dout_usrpmp_val: bool | None = None
+    dout_fourwayvlv_val: bool | None = None
+    dout_cooling_val: bool | None = None
+    dout_threewayvlv_val: bool | None = None
+    dout_bufferpmp_val: bool | None = None
+    dout_heaterstep1_val: bool | None = None
+    dout_heaterstep2_val: bool | None = None
+    dout_heaterstep3_val: bool | None = None
+
+    # Binary sensors - System status
+    keybonoff: bool | None = None
+    daynightmode: bool | None = None
+
+    # Binary sensors - Alarms
+    al_maxtime_antileg_active: bool | None = None
+    al_maxtime_dhw_active: bool | None = None
+    al_dewpoint_active: bool | None = None
+    al_underfloorsafety_active: bool | None = None
+    alrm_flw: bool | None = None
+    usralrms: bool | None = None
+    coolingalrms: bool | None = None
+    heatingalrms: bool | None = None
+    alarmmng_al_workinghour: bool | None = None
+    srsalrm: bool | None = None
+    glbal: bool | None = None
+    alarmmng_al_pwrplus: bool | None = None
+
+    # Binary sensors - Sensor/controller status
+    roomprb_en: bool | None = None
+    plantprb_en: bool | None = None
+    bufferprb_en: bool | None = None
+    en_dhwpid: bool | None = None
+
+    # Binary sensors - Demand signals
+    plantdemand: bool | None = None
+    id_demand: bool | None = None
+    thermostatdemand: bool | None = None
+    bms_demand: bool | None = None
+
+    # Binary sensors - Digital inputs
+    id_summerwinter: bool | None = None
+    dewpoint: bool | None = None
+    boostersecurity: bool | None = None
+    srcflw: bool | None = None
+    req_antileg_1: bool | None = None
+
+    # Binary sensors - Energy
+    surplus_pv: bool | None = None
+
+    # Extended dict for additional entities not covered by typed fields
+    _extended: dict[str, Any] = field(default_factory=dict)
+
+    def get(self, key: str, default: Any = None) -> Any:
+        """Get a value by key, checking typed fields first, then _extended."""
+        if hasattr(self, key) and key != "_extended":
+            value = getattr(self, key)
+            return value if value is not None else default
+        return self._extended.get(key, default)
+
+    def set_extended(self, key: str, value: Any) -> None:
+        """Set a value in the extended dict."""
+        self._extended[key] = value

{python_qube_heatpump-1.7.0 → python_qube_heatpump-1.9.0}/tests/test_const.py

@@ -4,6 +4,7 @@ from python_qube_heatpump.const import (
     StatusCode,
     STATUS_CODE_MAP,
     get_status_code,
+    resolve_status,
 )
 
 
@@ -55,3 +56,30 @@ def test_get_status_code_unknown():
     assert get_status_code(0) == StatusCode.UNKNOWN
     assert get_status_code(99) == StatusCode.UNKNOWN
     assert get_status_code(-1) == StatusCode.UNKNOWN
+
+
+def test_resolve_status_without_antileg():
+    """Without anti-legionella active, resolve_status follows the code map."""
+    assert resolve_status(16, False) == StatusCode.HEATING
+    assert resolve_status(22, False) == StatusCode.HEATING_DHW
+    assert resolve_status(1, None) == StatusCode.STANDBY
+
+
+def test_resolve_status_antileg_overrides_normal_statuses():
+    """Anti-legionella overrides every non-alarm status."""
+    assert resolve_status(16, True) == StatusCode.ANTI_LEGIONELLA
+    assert resolve_status(22, True) == StatusCode.ANTI_LEGIONELLA
+    assert resolve_status(1, True) == StatusCode.ANTI_LEGIONELLA
+    assert resolve_status(99, True) == StatusCode.ANTI_LEGIONELLA
+
+
+def test_resolve_status_alarm_not_masked_by_antileg():
+    """ALARM must not be masked by anti-legionella."""
+    assert resolve_status(2, True) == StatusCode.ALARM
+
+
+def test_resolve_status_none_code():
+    """None code resolves to UNKNOWN (or ANTI_LEGIONELLA if active)."""
+    assert resolve_status(None, False) == StatusCode.UNKNOWN
+    assert resolve_status(None, None) == StatusCode.UNKNOWN
+    assert resolve_status(None, True) == StatusCode.ANTI_LEGIONELLA

python_qube_heatpump-1.7.0/src/python_qube_heatpump/models.py

@@ -1,55 +0,0 @@
-"""Models for Qube Heat Pump."""
-
-from dataclasses import dataclass, field
-from typing import Any
-
-
-@dataclass
-class QubeState:
-    """Representation of the Qube Heat Pump state.
-
-    Typed fields for core sensors (used by official HA integration).
-    Extended dict for additional entities (used by HACS integration).
-    """
-
-    # Temperatures
-    temp_supply: float | None = None
-    temp_return: float | None = None
-    temp_source_in: float | None = None
-    temp_source_out: float | None = None
-    temp_room: float | None = None
-    temp_dhw: float | None = None
-    temp_outside: float | None = None
-
-    # Power/Energy
-    power_thermic: float | None = None
-    power_electric: float | None = None
-    energy_total_electric: float | None = None
-    energy_total_thermic: float | None = None
-    cop_calc: float | None = None
-
-    # Operation
-    status_code: int | None = None
-    compressor_speed: float | None = None
-    flow_rate: float | None = None
-
-    # Setpoints (Read/Write)
-    setpoint_room_heat_day: float | None = None
-    setpoint_room_heat_night: float | None = None
-    setpoint_room_cool_day: float | None = None
-    setpoint_room_cool_night: float | None = None
-    setpoint_dhw: float | None = None
-
-    # Extended dict for additional entities not covered by typed fields
-    _extended: dict[str, Any] = field(default_factory=dict)
-
-    def get(self, key: str, default: Any = None) -> Any:
-        """Get a value by key, checking typed fields first, then _extended."""
-        if hasattr(self, key) and key != "_extended":
-            value = getattr(self, key)
-            return value if value is not None else default
-        return self._extended.get(key, default)
-
-    def set_extended(self, key: str, value: Any) -> None:
-        """Set a value in the extended dict."""
-        self._extended[key] = value