plugwise 1.6.3__py3-none-any.whl → 1.7.0__py3-none-any.whl

plugwise/constants.py

@@ -1,8 +1,8 @@
 """Plugwise Smile constants."""
+
 from __future__ import annotations
 
 from collections import namedtuple
-from dataclasses import dataclass
 import logging
 from typing import Final, Literal, TypedDict, get_args
 
@@ -84,6 +84,7 @@ MIN_SETPOINT: Final[float] = 4.0
 MODULE_LOCATOR: Final = "./logs/point_log/*[@id]"
 NONE: Final = "None"
 OFF: Final = "off"
+PRIORITY_DEVICE_CLASSES = ("heater_central", "gateway")
 
 # XML data paths
 APPLIANCES: Final = "/core/appliances"
@@ -167,9 +168,7 @@ HEATER_CENTRAL_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
     "intended_boiler_state": DATA(
         "heating_state", NONE
     ),  # Legacy Anna: shows when heating is active, we don't show dhw_state, cannot be determined reliably
-    "flame_state": UOM(
-        NONE
-    ),  # Also present when there is a single gas-heater
+    "flame_state": UOM(NONE),  # Also present when there is a single gas-heater
     "intended_boiler_temperature": UOM(
         TEMP_CELSIUS
     ),  # Non-zero when heating, zero when dhw-heating
@@ -394,14 +393,13 @@ ZONE_THERMOSTATS: Final[tuple[str, ...]] = (
 )
 
 
-class GatewayData(TypedDict, total=False):
-    """The Gateway Data class."""
+class SmileProps(TypedDict, total=False):
+    """The SmileProps Data class."""
 
     cooling_present: bool
     gateway_id: str
     heater_id: str
     item_count: int
-    notifications: dict[str, dict[str, str]]
     reboot: bool
     smile_name: str
 
@@ -552,6 +550,7 @@ class GwEntityData(TypedDict, total=False):
 
     # Gateway
     gateway_modes: list[str]
+    notifications: dict[str, dict[str, str]]
     regulation_modes: list[str]
     select_gateway_mode: str
     select_regulation_mode: str
@@ -577,12 +576,3 @@ class GwEntityData(TypedDict, total=False):
     switches: SmileSwitches
     temperature_offset: ActuatorData
     thermostat: ActuatorData
-
-
-@dataclass
-class PlugwiseData:
-    """Plugwise data provided as output."""
-
-    devices: dict[str, GwEntityData]
-    gateway: GatewayData
-

plugwise/data.py

@@ -2,6 +2,7 @@
 
 Plugwise Smile protocol data-collection helpers.
 """
+
 from __future__ import annotations
 
 import re
@@ -15,6 +16,7 @@ from plugwise.constants import (
     OFF,
     ActuatorData,
     GwEntityData,
+    SmileProps,
 )
 from plugwise.helper import SmileHelper
 from plugwise.util import remove_empty_platform_dicts
@@ -25,32 +27,27 @@ class SmileData(SmileHelper):
 
     def __init__(self) -> None:
         """Init."""
+        self._smile_props: SmileProps
+        self._zones: dict[str, GwEntityData] = {}
         SmileHelper.__init__(self)
 
-
     def _all_entity_data(self) -> None:
         """Helper-function for get_all_gateway_entities().
 
-        Collect data for each entity and add to self.gw_data and self.gw_entities.
+        Collect data for each entity and add to self._smile_props and self.gw_entities.
         """
         self._update_gw_entities()
         if self.smile(ADAM):
             self._update_zones()
             self.gw_entities.update(self._zones)
 
-        self.gw_data.update(
-            {
-                "gateway_id": self.gateway_id,
-                "item_count": self._count,
-                "notifications": self._notifications,
-                "reboot": True,
-                "smile_name": self.smile_name,
-            }
-        )
+        self._smile_props["gateway_id"] = self._gateway_id
+        self._smile_props["item_count"] = self._count
+        self._smile_props["reboot"] = True
+        self._smile_props["smile_name"] = self.smile_name
         if self._is_thermostat:
-            self.gw_data.update(
-                {"heater_id": self._heater_id, "cooling_present": self._cooling_present}
-            )
+            self._smile_props["heater_id"] = self._heater_id
+            self._smile_props["cooling_present"] = self._cooling_present
 
     def _update_zones(self) -> None:
         """Helper-function for _all_entity_data() and async_update().
@@ -69,7 +66,7 @@ class SmileData(SmileHelper):
         mac_list: list[str] = []
         for entity_id, entity in self.gw_entities.items():
             data = self._get_entity_data(entity_id)
-            if entity_id == self.gateway_id:
+            if entity_id == self._gateway_id:
                 mac_list = self._detect_low_batteries()
                 self._add_or_update_notifications(entity_id, entity, data)
 
@@ -78,7 +75,13 @@ class SmileData(SmileHelper):
                 mac_list
                 and "low_battery" in entity["binary_sensors"]
                 and entity["zigbee_mac_address"] in mac_list
-                and entity["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve", "zone_thermometer", "zone_thermostat")
+                and entity["dev_class"]
+                in (
+                    "thermo_sensor",
+                    "thermostatic_radiator_valve",
+                    "zone_thermometer",
+                    "zone_thermostat",
+                )
             )
             if is_battery_low:
                 entity["binary_sensors"]["low_battery"] = True
@@ -98,7 +101,11 @@ class SmileData(SmileHelper):
                 message: str | None = notification.get("message")
                 warning: str | None = notification.get("warning")
                 notify = message or warning
-                if notify is not None and all(x in notify for x in matches) and (mac_addresses := mac_pattern.findall(notify)):
+                if (
+                    notify is not None
+                    and all(x in notify for x in matches)
+                    and (mac_addresses := mac_pattern.findall(notify))
+                ):
                     mac_address = mac_addresses[0]  # re.findall() outputs a list
 
                 if mac_address is not None:
@@ -113,16 +120,15 @@ class SmileData(SmileHelper):
     ) -> None:
         """Helper-function adding or updating the Plugwise notifications."""
         if (
-            entity_id == self.gateway_id
-            and (
-                self._is_thermostat or self.smile_type == "power"
-            )
+            entity_id == self._gateway_id
+            and (self._is_thermostat or self.smile_type == "power")
         ) or (
             "binary_sensors" in entity
             and "plugwise_notification" in entity["binary_sensors"]
         ):
             data["binary_sensors"]["plugwise_notification"] = bool(self._notifications)
-            self._count += 1
+            data["notifications"] = self._notifications
+            self._count += 2
 
     def _update_for_cooling(self, entity: GwEntityData) -> None:
         """Helper-function for adding/updating various cooling-related values."""
@@ -152,7 +158,6 @@ class SmileData(SmileHelper):
             sensors["setpoint_high"] = temp_dict["setpoint_high"]
             self._count += 2  # add 4, remove 2
 
-
     def _get_location_data(self, loc_id: str) -> GwEntityData:
         """Helper-function for _all_entity_data() and async_update().
 
@@ -160,13 +165,14 @@ class SmileData(SmileHelper):
         """
         zone = self._zones[loc_id]
         data = self._get_zone_data(loc_id)
-        if ctrl_state := self._control_state(data, loc_id):
-            if str(ctrl_state) in ("cooling", "heating", "preheating"):
-                data["control_state"] = str(ctrl_state)
-                self._count += 1
-            if str(ctrl_state) == "off":
-                data["control_state"] = "idle"
-                self._count += 1
+        data["control_state"] = "idle"
+        self._count += 1
+        if (ctrl_state := self._control_state(data, loc_id)) and str(ctrl_state) in (
+            "cooling",
+            "heating",
+            "preheating",
+        ):
+            data["control_state"] = str(ctrl_state)
 
         data["sensors"].pop("setpoint")  # remove, only used in _control_state()
         self._count -= 1
@@ -204,6 +210,7 @@ class SmileData(SmileHelper):
         # Thermostat data for Anna (presets, temperatures etc)
         if self.smile(ANNA) and entity["dev_class"] == "thermostat":
             self._climate_data(entity_id, entity, data)
+            self._get_anna_control_state(data)
 
         return data
 
@@ -235,7 +242,10 @@ class SmileData(SmileHelper):
                 data["binary_sensors"]["heating_state"] = self._heating_valves() != 0
             # Add cooling_enabled binary_sensor
             if "binary_sensors" in data:
-                if "cooling_enabled" not in data["binary_sensors"] and self._cooling_present:
+                if (
+                    "cooling_enabled" not in data["binary_sensors"]
+                    and self._cooling_present
+                ):
                     data["binary_sensors"]["cooling_enabled"] = self._cooling_enabled
 
         # Show the allowed regulation_modes and gateway_modes
@@ -248,10 +258,7 @@ class SmileData(SmileHelper):
                 self._count += 1
 
     def _climate_data(
-        self,
-        location_id: str,
-        entity: GwEntityData,
-        data: GwEntityData
+        self, location_id: str, entity: GwEntityData, data: GwEntityData
     ) -> None:
         """Helper-function for _get_entity_data().
 
@@ -282,7 +289,9 @@ class SmileData(SmileHelper):
         if sel_schedule in (NONE, OFF):
             data["climate_mode"] = "heat"
             if self._cooling_present:
-                data["climate_mode"] = "cool" if self.check_reg_mode("cooling") else "heat_cool"
+                data["climate_mode"] = (
+                    "cool" if self.check_reg_mode("cooling") else "heat_cool"
+                )
 
         if self.check_reg_mode("off"):
             data["climate_mode"] = "off"
@@ -294,11 +303,25 @@ class SmileData(SmileHelper):
 
     def check_reg_mode(self, mode: str) -> bool:
         """Helper-function for device_data_climate()."""
-        gateway = self.gw_entities[self.gateway_id]
+        gateway = self.gw_entities[self._gateway_id]
         return (
             "regulation_modes" in gateway and gateway["select_regulation_mode"] == mode
         )
 
+    def _get_anna_control_state(self, data: GwEntityData) -> None:
+        """Set the thermostat control_state based on the opentherm/onoff device state."""
+        data["control_state"] = "idle"
+        self._count += 1
+        for entity in self.gw_entities.values():
+            if entity["dev_class"] != "heater_central":
+                continue
+
+            binary_sensors = entity["binary_sensors"]
+            if binary_sensors["heating_state"]:
+                data["control_state"] = "heating"
+            if binary_sensors.get("cooling_state"):
+                data["control_state"] = "cooling"
+
     def _get_schedule_states_with_off(
         self, location: str, schedules: list[str], selected: str, data: GwEntityData
     ) -> None: