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

plugwise/__init__.py

@@ -2,6 +2,7 @@
 
 Plugwise backend module for Home Assistant Core.
 """
+
 from __future__ import annotations
 
 from plugwise.constants import (
@@ -63,7 +64,7 @@ class Smile(SmileComm):
             self._timeout,
             self._username,
             self._websession,
-         )
+        )
 
         self._cooling_present = False
         self._elga = False
@@ -125,52 +126,56 @@ class Smile(SmileComm):
         # Determine smile specifics
         await self._smile_detect(result, dsmrmain)
 
-        self._smile_api = SmileAPI(
-            self._host,
-            self._password,
-            self._request,
-            self._websession,
-            self._cooling_present,
-            self._elga,
-            self._is_thermostat,
-            self._last_active,
-            self._loc_data,
-            self._on_off_device,
-            self._opentherm_device,
-            self._schedule_old_states,
-            self.gateway_id,
-            self.smile_fw_version,
-            self.smile_hostname,
-            self.smile_hw_version,
-            self.smile_mac_address,
-            self.smile_model,
-            self.smile_model_id,
-            self.smile_name,
-            self.smile_type,
-            self.smile_version,
-            self._port,
-            self._username,
-         ) if not self.smile_legacy else SmileLegacyAPI(
-            self._host,
-            self._password,
-            self._request,
-            self._websession,
-            self._is_thermostat,
-            self._loc_data,
-            self._on_off_device,
-            self._opentherm_device,
-            self._stretch_v2,
-            self._target_smile,
-            self.smile_fw_version,
-            self.smile_hostname,
-            self.smile_hw_version,
-            self.smile_mac_address,
-            self.smile_model,
-            self.smile_name,
-            self.smile_type,
-            self.smile_zigbee_mac_address,
-            self._port,
-            self._username,
+        self._smile_api = (
+            SmileAPI(
+                self._host,
+                self._password,
+                self._request,
+                self._websession,
+                self._cooling_present,
+                self._elga,
+                self._is_thermostat,
+                self._last_active,
+                self._loc_data,
+                self._on_off_device,
+                self._opentherm_device,
+                self._schedule_old_states,
+                self.gateway_id,
+                self.smile_fw_version,
+                self.smile_hostname,
+                self.smile_hw_version,
+                self.smile_mac_address,
+                self.smile_model,
+                self.smile_model_id,
+                self.smile_name,
+                self.smile_type,
+                self.smile_version,
+                self._port,
+                self._username,
+            )
+            if not self.smile_legacy
+            else SmileLegacyAPI(
+                self._host,
+                self._password,
+                self._request,
+                self._websession,
+                self._is_thermostat,
+                self._loc_data,
+                self._on_off_device,
+                self._opentherm_device,
+                self._stretch_v2,
+                self._target_smile,
+                self.smile_fw_version,
+                self.smile_hostname,
+                self.smile_hw_version,
+                self.smile_mac_address,
+                self.smile_model,
+                self.smile_name,
+                self.smile_type,
+                self.smile_zigbee_mac_address,
+                self._port,
+                self._username,
+            )
         )
 
         # Update all endpoints on first connect
@@ -203,7 +208,7 @@ class Smile(SmileComm):
             )
             raise UnsupportedDeviceError
 
-        version_major= str(self.smile_fw_version.major)
+        version_major = str(self.smile_fw_version.major)
         self._target_smile = f"{model}_v{version_major}"
         LOGGER.debug("Plugwise identified as %s", self._target_smile)
         if self._target_smile not in SMILES:
@@ -318,9 +323,9 @@ class Smile(SmileComm):
 
         return data
 
-########################################################################################################
-###  API Set and HA Service-related Functions                                                        ###
-########################################################################################################
+    ########################################################################################################
+    ###  API Set and HA Service-related Functions                                                        ###
+    ########################################################################################################
 
     async def set_select(
         self,
@@ -333,7 +338,9 @@ class Smile(SmileComm):
         try:
             await self._smile_api.set_select(key, loc_id, option, state)
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to set select option '{option}': {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to set select option '{option}': {str(exc)}"
+            ) from exc
 
     async def set_schedule_state(
         self,
@@ -345,8 +352,9 @@ class Smile(SmileComm):
         try:
             await self._smile_api.set_schedule_state(loc_id, state, name)
         except ConnectionFailedError as exc:  # pragma no cover
-            raise ConnectionFailedError(f"Failed to set schedule state: {str(exc)}") from exc  # pragma no cover
-
+            raise ConnectionFailedError(
+                f"Failed to set schedule state: {str(exc)}"
+            ) from exc  # pragma no cover
 
     async def set_preset(self, loc_id: str, preset: str) -> None:
         """Set the given Preset on the relevant Thermostat."""
@@ -360,7 +368,9 @@ class Smile(SmileComm):
         try:
             await self._smile_api.set_temperature(loc_id, items)
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to set temperature: {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to set temperature: {str(exc)}"
+            ) from exc
 
     async def set_number(
         self,
@@ -372,14 +382,18 @@ class Smile(SmileComm):
         try:
             await self._smile_api.set_number(dev_id, key, temperature)
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to set number '{key}': {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to set number '{key}': {str(exc)}"
+            ) from exc
 
     async def set_temperature_offset(self, dev_id: str, offset: float) -> None:
         """Set the Temperature offset for thermostats that support this feature."""
         try:  # pragma no cover
             await self._smile_api.set_offset(dev_id, offset)  # pragma: no cover
         except ConnectionFailedError as exc:  # pragma no cover
-            raise ConnectionFailedError(f"Failed to set temperature offset: {str(exc)}") from exc  # pragma no cover
+            raise ConnectionFailedError(
+                f"Failed to set temperature offset: {str(exc)}"
+            ) from exc  # pragma no cover
 
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
@@ -388,39 +402,51 @@ class Smile(SmileComm):
         try:
             await self._smile_api.set_switch_state(appl_id, members, model, state)
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to set switch state: {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to set switch state: {str(exc)}"
+            ) from exc
 
     async def set_gateway_mode(self, mode: str) -> None:
         """Set the gateway mode."""
         try:  # pragma no cover
             await self._smile_api.set_gateway_mode(mode)  # pragma: no cover
         except ConnectionFailedError as exc:  # pragma no cover
-            raise ConnectionFailedError(f"Failed to set gateway mode: {str(exc)}") from exc  # pragma no cover
+            raise ConnectionFailedError(
+                f"Failed to set gateway mode: {str(exc)}"
+            ) from exc  # pragma no cover
 
     async def set_regulation_mode(self, mode: str) -> None:
         """Set the heating regulation mode."""
         try:  # pragma no cover
             await self._smile_api.set_regulation_mode(mode)  # pragma: no cover
         except ConnectionFailedError as exc:  # pragma no cover
-            raise ConnectionFailedError(f"Failed to set regulation mode: {str(exc)}") from exc  # pragma no cover
+            raise ConnectionFailedError(
+                f"Failed to set regulation mode: {str(exc)}"
+            ) from exc  # pragma no cover
 
     async def set_dhw_mode(self, mode: str) -> None:
         """Set the domestic hot water heating regulation mode."""
         try:  # pragma no cover
             await self._smile_api.set_dhw_mode(mode)  # pragma: no cover
         except ConnectionFailedError as exc:  # pragma no cover
-            raise ConnectionFailedError(f"Failed to set dhw mode: {str(exc)}") from exc  # pragma no cover
+            raise ConnectionFailedError(
+                f"Failed to set dhw mode: {str(exc)}"
+            ) from exc  # pragma no cover
 
     async def delete_notification(self) -> None:
         """Delete the active Plugwise Notification."""
         try:
             await self._smile_api.delete_notification()
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to delete notification: {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to delete notification: {str(exc)}"
+            ) from exc
 
     async def reboot_gateway(self) -> None:
         """Reboot the Plugwise Gateway."""
         try:
             await self._smile_api.reboot_gateway()
         except ConnectionFailedError as exc:
-            raise ConnectionFailedError(f"Failed to reboot gateway: {str(exc)}") from exc
+            raise ConnectionFailedError(
+                f"Failed to reboot gateway: {str(exc)}"
+            ) from exc

plugwise/common.py

@@ -2,6 +2,7 @@
 
 Plugwise Smile protocol helpers.
 """
+
 from __future__ import annotations
 
 from typing import cast
@@ -83,21 +84,23 @@ class SmileCommon:
         appl.hardware = module_data["hardware_version"]
         appl.model_id = module_data["vendor_model"] if not legacy else None
         appl.model = (
-            "Generic heater/cooler"
-            if self._cooling_present
-            else "Generic heater"
+            "Generic heater/cooler" if self._cooling_present else "Generic heater"
         )
 
         return appl
 
-    def _appl_thermostat_info(self, appl: Munch, xml_1: etree, xml_2: etree = None) -> Munch:
+    def _appl_thermostat_info(
+        self, appl: Munch, xml_1: etree, xml_2: etree = None
+    ) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         locator = "./logs/point_log[type='thermostat']/thermostat"
         xml_2 = return_valid(xml_2, self._domain_objects)
         module_data = self._get_module_data(xml_1, locator, xml_2)
         appl.vendor_name = module_data["vendor_name"]
         appl.model = module_data["vendor_model"]
-        if appl.model != "ThermoTouch":  # model_id for Anna not present as stand-alone device
+        if (
+            appl.model != "ThermoTouch"
+        ):  # model_id for Anna not present as stand-alone device
             appl.model_id = appl.model
             appl.model = check_model(appl.model, appl.vendor_name)
 
@@ -108,7 +111,9 @@ class SmileCommon:
 
         return appl
 
-    def _collect_power_values(self, data: GwEntityData, loc: Munch, tariff: str, legacy: bool = False) -> None:
+    def _collect_power_values(
+        self, data: GwEntityData, loc: Munch, tariff: str, legacy: bool = False
+    ) -> None:
         """Something."""
         for loc.peak_select in ("nl_peak", "nl_offpeak"):
             loc.locator = (
@@ -220,9 +225,7 @@ class SmileCommon:
                 self.gw_entities[appl.entity_id][appl_key] = value
                 self._count += 1
 
-    def _entity_switching_group(
-        self, entity: GwEntityData, data: GwEntityData
-    ) -> None:
+    def _entity_switching_group(self, entity: GwEntityData, data: GwEntityData) -> None:
         """Helper-function for _get_device_zone_data().
 
         Determine switching group device data.
@@ -268,7 +271,9 @@ class SmileCommon:
 
         return switch_groups
 
-    def _get_lock_state(self, xml: etree, data: GwEntityData, stretch_v2: bool = False) -> None:
+    def _get_lock_state(
+        self, xml: etree, data: GwEntityData, stretch_v2: bool = False
+    ) -> None:
         """Helper-function for _get_measurement_data().
 
         Adam & Stretches: obtain the relay-switch lock state.
@@ -323,7 +328,9 @@ class SmileCommon:
 
         return module_data
 
-    def _get_zigbee_data(self, module: etree, module_data: ModuleData, legacy: bool) -> None:
+    def _get_zigbee_data(
+        self, module: etree, module_data: ModuleData, legacy: bool
+    ) -> None:
         """Helper-function for _get_module_data()."""
         if legacy:
             # Stretches
@@ -334,5 +341,5 @@ class SmileCommon:
                 module_data["zigbee_mac_address"] = coord.find("mac_address").text
         # Adam
         elif (zb_node := module.find("./protocols/zig_bee_node")) is not None:
-                module_data["zigbee_mac_address"] = zb_node.find("mac_address").text
-                module_data["reachable"] = zb_node.find("reachable").text == "true"
+            module_data["zigbee_mac_address"] = zb_node.find("mac_address").text
+            module_data["reachable"] = zb_node.find("reachable").text == "true"

plugwise/constants.py

@@ -1,4 +1,5 @@
 """Plugwise Smile constants."""
+
 from __future__ import annotations
 
 from collections import namedtuple
@@ -84,6 +85,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 +169,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
@@ -585,4 +585,3 @@ class PlugwiseData:
 
     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
@@ -27,7 +28,6 @@ class SmileData(SmileHelper):
         """Init."""
         SmileHelper.__init__(self)
 
-
     def _all_entity_data(self) -> None:
         """Helper-function for get_all_gateway_entities().
 
@@ -78,7 +78,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 +104,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:
@@ -114,9 +124,7 @@ class SmileData(SmileHelper):
         """Helper-function adding or updating the Plugwise notifications."""
         if (
             entity_id == self.gateway_id
-            and (
-                self._is_thermostat or self.smile_type == "power"
-            )
+            and (self._is_thermostat or self.smile_type == "power")
         ) or (
             "binary_sensors" in entity
             and "plugwise_notification" in entity["binary_sensors"]
@@ -152,7 +160,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 +167,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 +212,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 +244,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 +260,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 +291,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"
@@ -299,6 +310,19 @@ class SmileData(SmileHelper):
             "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"
+        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: