plugwise 1.7.5__py3-none-any.whl → 1.7.7__py3-none-any.whl

plugwise/__init__.py

@@ -5,6 +5,8 @@ Plugwise backend module for Home Assistant Core.
 
 from __future__ import annotations
 
+from typing import cast
+
 from plugwise.constants import (
     DEFAULT_LEGACY_TIMEOUT,
     DEFAULT_PORT,
@@ -15,6 +17,8 @@ from plugwise.constants import (
     MODULES,
     NONE,
     SMILES,
+    STATE_OFF,
+    STATE_ON,
     STATUS,
     SYSTEM,
     GwEntityData,
@@ -34,6 +38,7 @@ from plugwise.smilecomm import SmileComm
 
 import aiohttp
 from defusedxml import ElementTree as etree
+from munch import Munch
 from packaging.version import Version, parse
 
 
@@ -70,16 +75,17 @@ class Smile(SmileComm):
         self._smile_api: SmileAPI | SmileLegacyAPI
         self._stretch_v2 = False
         self._target_smile: str = NONE
-        self.smile_hostname: str = NONE
-        self.smile_hw_version: str | None = None
-        self.smile_legacy = False
-        self.smile_mac_address: str | None = None
-        self.smile_model: str = NONE
-        self.smile_model_id: str | None = None
-        self.smile_name: str = NONE
-        self.smile_type: str = NONE
-        self.smile_version: Version = Version("0.0.0")
-        self.smile_zigbee_mac_address: str | None = None
+        self.smile: Munch = Munch()
+        self.smile.hostname = NONE
+        self.smile.hw_version = None
+        self.smile.legacy = False
+        self.smile.mac_address = None
+        self.smile.model = NONE
+        self.smile.model_id = None
+        self.smile.name = NONE
+        self.smile.type = NONE
+        self.smile.version = Version("0.0.0")
+        self.smile.zigbee_mac_address = None
 
     @property
     def cooling_present(self) -> bool:
@@ -107,7 +113,7 @@ class Smile(SmileComm):
 
         All non-legacy devices support gateway-rebooting.
         """
-        return not self.smile_legacy
+        return not self.smile.legacy
 
     async def connect(self) -> Version:
         """Connect to the Plugwise Gateway and determine its name, type, version, and other data."""
@@ -156,16 +162,9 @@ class Smile(SmileComm):
                 self._opentherm_device,
                 self._request,
                 self._schedule_old_states,
-                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.smile,
             )
-            if not self.smile_legacy
+            if not self.smile.legacy
             else SmileLegacyAPI(
                 self._is_thermostat,
                 self._loc_data,
@@ -174,21 +173,14 @@ class Smile(SmileComm):
                 self._request,
                 self._stretch_v2,
                 self._target_smile,
-                self.smile_hostname,
-                self.smile_hw_version,
-                self.smile_mac_address,
-                self.smile_model,
-                self.smile_name,
-                self.smile_type,
-                self.smile_version,
-                self.smile_zigbee_mac_address,
+                self.smile,
             )
         )
 
         # Update all endpoints on first connect
         await self._smile_api.full_xml_update()
 
-        return self.smile_version
+        return cast(Version, self.smile.version)
 
     async def _smile_detect(
         self, result: etree.Element, dsmrmain: etree.Element
@@ -201,15 +193,17 @@ class Smile(SmileComm):
         if (gateway := result.find("./gateway")) is not None:
             if (v_model := gateway.find("vendor_model")) is not None:
                 model = v_model.text
-            self.smile_version = parse(gateway.find("firmware_version").text)
-            self.smile_hw_version = gateway.find("hardware_version").text
-            self.smile_hostname = gateway.find("hostname").text
-            self.smile_mac_address = gateway.find("mac_address").text
-            self.smile_model_id = gateway.find("vendor_model").text
+            self.smile.version = parse(gateway.find("firmware_version").text)
+            self.smile.hw_version = gateway.find("hardware_version").text
+            self.smile.hostname = gateway.find("hostname").text
+            self.smile.mac_address = gateway.find("mac_address").text
+            self.smile.model_id = gateway.find("vendor_model").text
         else:
             model = await self._smile_detect_legacy(result, dsmrmain, model)
 
-        if model == "Unknown" or self.smile_version is None:  # pragma: no cover
+        if model == "Unknown" or self.smile.version == Version(
+            "0.0.0"
+        ):  # pragma: no cover
             # Corner case check
             LOGGER.error(
                 "Unable to find model or version information, please create"
@@ -217,7 +211,7 @@ class Smile(SmileComm):
             )
             raise UnsupportedDeviceError
 
-        version_major = str(self.smile_version.major)
+        version_major = str(self.smile.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:
@@ -228,7 +222,7 @@ class Smile(SmileComm):
             )
             raise UnsupportedDeviceError
 
-        if not self.smile_legacy:
+        if not self.smile.legacy:
             self._timeout = DEFAULT_TIMEOUT
 
         if self._target_smile in ("smile_open_therm_v2", "smile_thermo_v3"):
@@ -238,14 +232,14 @@ class Smile(SmileComm):
             )  # pragma: no cover
             raise UnsupportedDeviceError  # pragma: no cover
 
-        self.smile_model = "Gateway"
-        self.smile_name = SMILES[self._target_smile].smile_name
-        self.smile_type = SMILES[self._target_smile].smile_type
+        self.smile.model = "Gateway"
+        self.smile.name = SMILES[self._target_smile].smile_name
+        self.smile.type = SMILES[self._target_smile].smile_type
 
-        if self.smile_type == "stretch":
+        if self.smile.type == "stretch":
             self._stretch_v2 = int(version_major) == 2
 
-        if self.smile_type == "thermostat":
+        if self.smile.type == "thermostat":
             self._is_thermostat = True
             # For Adam, Anna, determine the system capabilities:
             # Find the connected heating/cooling device (heater_central),
@@ -273,13 +267,13 @@ class Smile(SmileComm):
         return_model = model
         # Stretch: find the MAC of the zigbee master_controller (= Stick)
         if (network := result.find("./module/protocols/master_controller")) is not None:
-            self.smile_zigbee_mac_address = network.find("mac_address").text
+            self.smile.zigbee_mac_address = network.find("mac_address").text
         # Find the active MAC in case there is an orphaned Stick
         if zb_networks := result.findall("./network"):
             for zb_network in zb_networks:
                 if zb_network.find("./nodes/network_router") is not None:
                     network = zb_network.find("./master_controller")
-                    self.smile_zigbee_mac_address = network.find("mac_address").text
+                    self.smile.zigbee_mac_address = network.find("mac_address").text
 
         # Legacy Anna or Stretch:
         if (
@@ -287,22 +281,22 @@ class Smile(SmileComm):
             or network is not None
         ):
             system = await self._request(SYSTEM)
-            self.smile_version = parse(system.find("./gateway/firmware").text)
+            self.smile.version = parse(system.find("./gateway/firmware").text)
             return_model = str(system.find("./gateway/product").text)
-            self.smile_hostname = system.find("./gateway/hostname").text
+            self.smile.hostname = system.find("./gateway/hostname").text
             # If wlan0 contains data it's active, eth0 should be checked last as is preferred
             for network in ("wlan0", "eth0"):
                 locator = f"./{network}/mac"
                 if (net_locator := system.find(locator)) is not None:
-                    self.smile_mac_address = net_locator.text
+                    self.smile.mac_address = net_locator.text
 
         # P1 legacy:
         elif dsmrmain is not None:
             status = await self._request(STATUS)
-            self.smile_version = parse(status.find("./system/version").text)
+            self.smile.version = parse(status.find("./system/version").text)
             return_model = str(status.find("./system/product").text)
-            self.smile_hostname = status.find("./network/hostname").text
-            self.smile_mac_address = status.find("./network/mac_address").text
+            self.smile.hostname = status.find("./network/hostname").text
+            self.smile.mac_address = status.find("./network/mac_address").text
         else:  # pragma: no cover
             # No cornercase, just end of the line
             LOGGER.error(
@@ -311,7 +305,7 @@ class Smile(SmileComm):
             )
             raise ResponseError
 
-        self.smile_legacy = True
+        self.smile.legacy = True
         return return_model
 
     async def async_update(self) -> dict[str, GwEntityData]:
@@ -398,10 +392,21 @@ class Smile(SmileComm):
 
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
-    ) -> None:
-        """Set the given State of the relevant Switch."""
+    ) -> bool:
+        """Set the given State of the relevant Switch.
+
+        Return the result:
+          - True when switched to state on,
+          - False when switched to state off,
+          - the unchanged state when the switch is for instance locked.
+        """
+        if state not in (STATE_OFF, STATE_ON):
+            raise PlugwiseError("Invalid state supplied to set_switch_state")
+
         try:
-            await self._smile_api.set_switch_state(appl_id, members, model, state)
+            return 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)}"

plugwise/common.py

@@ -10,6 +10,7 @@ from typing import cast
 from plugwise.constants import (
     ANNA,
     NONE,
+    PRIORITY_DEVICE_CLASSES,
     SPECIAL_PLUG_TYPES,
     SWITCH_GROUP_TYPES,
     ApplianceType,
@@ -55,17 +56,16 @@ class SmileCommon:
         self._heater_id: str = NONE
         self._on_off_device: bool
         self.gw_entities: dict[str, GwEntityData] = {}
-        self.smile_name: str
-        self.smile_type: str
+        self.smile: Munch
 
     @property
     def heater_id(self) -> str:
         """Return the heater-id."""
         return self._heater_id
 
-    def smile(self, name: str) -> bool:
+    def check_name(self, name: str) -> bool:
         """Helper-function checking the smile-name."""
-        return self.smile_name == name
+        return bool(self.smile.name == name)
 
     def _appl_heater_central_info(
         self,
@@ -153,6 +153,16 @@ class SmileCommon:
                 self.gw_entities[appl.entity_id][appl_key] = value
                 self._count += 1
 
+    def _reorder_devices(self) -> None:
+        """Place the gateway and optional heater_central devices as 1st and 2nd."""
+        reordered = {}
+        for dev_class in PRIORITY_DEVICE_CLASSES:
+            for entity_id, entity in dict(self.gw_entities).items():
+                if entity["dev_class"] == dev_class:
+                    reordered[entity_id] = self.gw_entities.pop(entity_id)
+                    break
+        self.gw_entities = {**reordered, **self.gw_entities}
+
     def _entity_switching_group(self, entity: GwEntityData, data: GwEntityData) -> None:
         """Helper-function for _get_device_zone_data().
 
@@ -173,7 +183,7 @@ class SmileCommon:
         """
         switch_groups: dict[str, GwEntityData] = {}
         # P1 and Anna don't have switchgroups
-        if self.smile_type == "power" or self.smile(ANNA):
+        if self.smile.type == "power" or self.check_name(ANNA):
             return switch_groups
 
         for group in self._domain_objects.findall("./group"):

plugwise/constants.py

@@ -23,6 +23,8 @@ POWER_WATT: Final = "W"
 PRESET_AWAY: Final = "away"
 PRESSURE_BAR: Final = "bar"
 SIGNAL_STRENGTH_DECIBELS_MILLIWATT: Final = "dBm"
+STATE_OFF: Final = "off"
+STATE_ON: Final = "on"
 TEMP_CELSIUS: Final = "°C"
 TEMP_KELVIN: Final = "°K"
 TIME_MILLISECONDS: Final = "ms"
@@ -84,7 +86,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")
+PRIORITY_DEVICE_CLASSES = ("gateway", "heater_central")
 
 # XML data paths
 APPLIANCES: Final = "/core/appliances"

plugwise/data.py

@@ -35,7 +35,7 @@ class SmileData(SmileHelper):
         Collect data for each entity and add to self.gw_entities.
         """
         self._update_gw_entities()
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             self._update_zones()
             self.gw_entities.update(self._zones)
 
@@ -86,7 +86,7 @@ class SmileData(SmileHelper):
         mac_pattern = re.compile(r"(?:[0-9A-F]{2}){8}")
         matches = ["Battery", "below"]
         if self._notifications:
-            for msg_id, notification in list(self._notifications.items()):
+            for msg_id, notification in self._notifications.copy().items():
                 mac_address: str | None = None
                 message: str | None = notification.get("message")
                 warning: str | None = notification.get("warning")
@@ -111,7 +111,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"]
@@ -124,7 +124,7 @@ class SmileData(SmileHelper):
         """Helper-function for adding/updating various cooling-related values."""
         # For Anna and heating + cooling, replace setpoint with setpoint_high/_low
         if (
-            self.smile(ANNA)
+            self.check_name(ANNA)
             and self._cooling_present
             and entity["dev_class"] == "thermostat"
         ):
@@ -194,11 +194,11 @@ class SmileData(SmileHelper):
         # Switching groups data
         self._entity_switching_group(entity, data)
         # Adam data
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             self._get_adam_data(entity, data)
 
         # Thermostat data for Anna (presets, temperatures etc)
-        if self.smile(ANNA) and entity["dev_class"] == "thermostat":
+        if self.check_name(ANNA) and entity["dev_class"] == "thermostat":
             self._climate_data(entity_id, entity, data)
             self._get_anna_control_state(data)
 
@@ -232,12 +232,12 @@ class SmileData(SmileHelper):
             if self._on_off_device and isinstance(self._heating_valves(), int):
                 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
-                ):
-                    data["binary_sensors"]["cooling_enabled"] = self._cooling_enabled
+            if (
+                "binary_sensors" in data
+                and "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
         if entity["dev_class"] == "gateway":

plugwise/helper.py

@@ -28,7 +28,6 @@ from plugwise.constants import (
     NONE,
     OFF,
     P1_MEASUREMENTS,
-    PRIORITY_DEVICE_CLASSES,
     TEMP_CELSIUS,
     THERMOSTAT_CLASSES,
     TOGGLES,
@@ -85,11 +84,7 @@ class SmileHelper(SmileCommon):
         self._gateway_id: str = NONE
         self._zones: dict[str, GwEntityData]
         self.gw_entities: dict[str, GwEntityData]
-        self.smile_hw_version: str | None
-        self.smile_mac_address: str | None
-        self.smile_model: str
-        self.smile_model_id: str | None
-        self.smile_version: version.Version
+        self.smile: Munch = Munch()
 
     @property
     def gateway_id(self) -> str:
@@ -160,11 +155,11 @@ class SmileHelper(SmileCommon):
 
             self._create_gw_entities(appl)
 
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             self._get_p1_smartmeter_info()
 
         # Sort the gw_entities
-        self._sort_gw_entities()
+        self._reorder_devices()
 
     def _get_p1_smartmeter_info(self) -> None:
         """For P1 collect the connected SmartMeter info from the Home/building location.
@@ -197,18 +192,6 @@ class SmileHelper(SmileCommon):
 
         self._create_gw_entities(appl)
 
-    def _sort_gw_entities(self) -> None:
-        """Place the gateway and optional heater_central entities as 1st and 2nd."""
-        for dev_class in PRIORITY_DEVICE_CLASSES:
-            for entity_id, entity in dict(self.gw_entities).items():
-                if entity["dev_class"] == dev_class:
-                    priority_entity = entity
-                    self.gw_entities.pop(entity_id)
-                    other_entities = self.gw_entities
-                    priority_entities = {entity_id: priority_entity}
-                    self.gw_entities = {**priority_entities, **other_entities}
-                    break
-
     def _all_locations(self) -> None:
         """Collect all locations."""
         loc = Munch()
@@ -268,16 +251,16 @@ class SmileHelper(SmileCommon):
     def _appl_gateway_info(self, appl: Munch, appliance: etree.Element) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         self._gateway_id = appliance.attrib["id"]
-        appl.firmware = str(self.smile_version)
-        appl.hardware = self.smile_hw_version
-        appl.mac = self.smile_mac_address
-        appl.model = self.smile_model
-        appl.model_id = self.smile_model_id
-        appl.name = self.smile_name
+        appl.firmware = str(self.smile.version)
+        appl.hardware = self.smile.hw_version
+        appl.mac = self.smile.mac_address
+        appl.model = self.smile.model
+        appl.model_id = self.smile.model_id
+        appl.name = self.smile.name
         appl.vendor_name = "Plugwise"
 
         # Adam: collect the ZigBee MAC address of the Smile
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             if (
                 found := self._domain_objects.find(".//protocols/zig_bee_coordinator")
             ) is not None:
@@ -346,7 +329,7 @@ class SmileHelper(SmileCommon):
         # Get P1 smartmeter data from LOCATIONS
         entity = self.gw_entities[entity_id]
         # !! DON'T CHANGE below two if-lines, will break stuff !!
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             if entity["dev_class"] == "smartmeter":
                 data.update(self._power_data_from_location())
 
@@ -383,7 +366,7 @@ class SmileHelper(SmileCommon):
             data.pop("c_heating_state")
             self._count -= 1
 
-        if self._is_thermostat and self.smile(ANNA):
+        if self._is_thermostat and self.check_name(ANNA):
             self._update_anna_cooling(entity_id, data)
 
         self._cleanup_data(data)
@@ -484,7 +467,7 @@ class SmileHelper(SmileCommon):
                 item == "thermostat"
                 and (
                     entity["dev_class"] != "climate"
-                    if self.smile(ADAM)
+                    if self.check_name(ADAM)
                     else entity["dev_class"] != "thermostat"
                 )
             ):
@@ -539,7 +522,7 @@ class SmileHelper(SmileCommon):
 
         Collect the requested gateway mode.
         """
-        if not (self.smile(ADAM) and entity_id == self._gateway_id):
+        if not (self.check_name(ADAM) and entity_id == self._gateway_id):
             return None
 
         if (search := search_actuator_functionalities(appliance, key)) is not None:
@@ -605,10 +588,10 @@ class SmileHelper(SmileCommon):
 
         Solution for Core issue #81839.
         """
-        if self.smile(ANNA):
+        if self.check_name(ANNA):
             data["binary_sensors"]["heating_state"] = data["c_heating_state"]
 
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             # First count when not present, then create and init to False.
             # When present init to False
             if "heating_state" not in data["binary_sensors"]:
@@ -723,7 +706,7 @@ class SmileHelper(SmileCommon):
             for entity_id, entity in self.gw_entities.items():
                 self._rank_thermostat(thermo_matching, loc_id, entity_id, entity)
 
-        for loc_id, loc_data in list(self._thermo_locs.items()):
+        for loc_id, loc_data in self._thermo_locs.items():
             if loc_data["primary_prio"] != 0:
                 self._zones[loc_id] = {
                     "dev_class": "climate",
@@ -799,8 +782,8 @@ class SmileHelper(SmileCommon):
 
         # Handle missing control_state in regulation_mode off for firmware >= 3.2.0 (issue #776)
         # In newer firmware versions, default to "off" when control_state is not present
-        if self.smile_version != version.Version("0.0.0"):
-            if self.smile_version >= version.parse("3.2.0"):
+        if self.smile.version != version.Version("0.0.0"):
+            if self.smile.version >= version.parse("3.2.0"):
                 return "off"
 
             # Older Adam firmware does not have the control_state xml-key

plugwise/legacy/helper.py

@@ -23,7 +23,6 @@ from plugwise.constants import (
     NONE,
     OFF,
     P1_LEGACY_MEASUREMENTS,
-    PRIORITY_DEVICE_CLASSES,
     TEMP_CELSIUS,
     THERMOSTAT_CLASSES,
     UOM,
@@ -47,7 +46,6 @@ from plugwise.util import (
 # This way of importing aiohttp is because of patch/mocking in testing (aiohttp timeouts)
 from defusedxml import ElementTree as etree
 from munch import Munch
-from packaging.version import Version
 
 
 def etree_to_dict(element: etree.Element) -> dict[str, str]:
@@ -73,10 +71,7 @@ class SmileLegacyHelper(SmileCommon):
         self._modules: etree.Element
         self._stretch_v2: bool
         self.gw_entities: dict[str, GwEntityData] = {}
-        self.smile_mac_address: str | None
-        self.smile_model: str
-        self.smile_version: Version
-        self.smile_zigbee_mac_address: str | None
+        self.smile: Munch = Munch()
 
     @property
     def gateway_id(self) -> str:
@@ -95,7 +90,7 @@ class SmileLegacyHelper(SmileCommon):
 
         self._create_legacy_gateway()
         # For legacy P1 collect the connected SmartMeter info
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             appl = Munch()
             self._p1_smartmeter_info_finder(appl)
             # Legacy P1 has no more devices
@@ -140,17 +135,7 @@ class SmileLegacyHelper(SmileCommon):
                 continue  # pragma: no cover
 
             self._create_gw_entities(appl)
-
-        # Place the gateway and optional heater_central devices as 1st and 2nd
-        for dev_class in PRIORITY_DEVICE_CLASSES:
-            for entity_id, entity in dict(self.gw_entities).items():
-                if entity["dev_class"] == dev_class:
-                    tmp_entity = entity
-                    self.gw_entities.pop(entity_id)
-                    cleared_dict = self.gw_entities
-                    add_to_front = {entity_id: tmp_entity}
-                    self.gw_entities = {**add_to_front, **cleared_dict}
-                    break
+            self._reorder_devices()
 
     def _all_locations(self) -> None:
         """Collect all locations."""
@@ -167,13 +152,13 @@ class SmileLegacyHelper(SmileCommon):
             loc.loc_id = location.attrib["id"]
             # Filter the valid single location for P1 legacy: services not empty
             locator = "./services"
-            if self.smile_type == "power" and len(location.find(locator)) == 0:
+            if self.smile.type == "power" and len(location.find(locator)) == 0:
                 continue
 
             if loc.name == "Home":
                 self._home_loc_id = loc.loc_id
             # Replace location-name for P1 legacy, can contain privacy-related info
-            if self.smile_type == "power":
+            if self.smile.type == "power":
                 loc.name = "Home"
                 self._home_loc_id = loc.loc_id
 
@@ -185,18 +170,18 @@ class SmileLegacyHelper(SmileCommon):
         Use the home_location or FAKE_APPL as entity id.
         """
         self._gateway_id = self._home_loc_id
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             self._gateway_id = FAKE_APPL
 
         self.gw_entities[self._gateway_id] = {"dev_class": "gateway"}
         self._count += 1
         for key, value in {
-            "firmware": str(self.smile_version),
+            "firmware": str(self.smile.version),
             "location": self._home_loc_id,
-            "mac_address": self.smile_mac_address,
-            "model": self.smile_model,
-            "name": self.smile_name,
-            "zigbee_mac_address": self.smile_zigbee_mac_address,
+            "mac_address": self.smile.mac_address,
+            "model": self.smile.model,
+            "name": self.smile.name,
+            "zigbee_mac_address": self.smile.zigbee_mac_address,
             "vendor": "Plugwise",
         }.items():
             if value is not None:
@@ -224,14 +209,14 @@ class SmileLegacyHelper(SmileCommon):
 
         Collect energy entity info (Smartmeter, Circle, Stealth, etc.): firmware, model and vendor name.
         """
-        if self.smile_type in ("power", "stretch"):
+        if self.smile.type in ("power", "stretch"):
             locator = "./services/electricity_point_meter"
             module_data = self._get_module_data(
                 appliance, locator, self._modules, legacy=True
             )
             appl.zigbee_mac = module_data["zigbee_mac_address"]
             # Filter appliance without zigbee_mac, it's an orphaned device
-            if appl.zigbee_mac is None and self.smile_type != "power":
+            if appl.zigbee_mac is None and self.smile.type != "power":
                 return None
 
             appl.hardware = module_data["hardware_version"]
@@ -253,7 +238,7 @@ class SmileLegacyHelper(SmileCommon):
         appl.entity_id = loc_id
         appl.location = loc_id
         appl.mac = None
-        appl.model = self.smile_model
+        appl.model = self.smile.model
         appl.model_id = None
         appl.name = "P1"
         appl.pwclass = "smartmeter"
@@ -272,7 +257,7 @@ class SmileLegacyHelper(SmileCommon):
         # Get P1 smartmeter data from MODULES
         entity = self.gw_entities[entity_id]
         # !! DON'T CHANGE below two if-lines, will break stuff !!
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             if entity["dev_class"] == "smartmeter":
                 data.update(self._power_data_from_modules())
 

plugwise/legacy/smile.py

@@ -18,6 +18,8 @@ from plugwise.constants import (
     OFF,
     REQUIRE_APPLIANCES,
     RULES,
+    STATE_OFF,
+    STATE_ON,
     GwEntityData,
     ThermoLoc,
 )
@@ -25,7 +27,6 @@ from plugwise.exceptions import ConnectionFailedError, DataMissingError, Plugwis
 from plugwise.legacy.data import SmileLegacyData
 
 from munch import Munch
-from packaging.version import Version
 
 
 class SmileLegacyAPI(SmileLegacyData):
@@ -42,14 +43,7 @@ class SmileLegacyAPI(SmileLegacyData):
         _request: Callable[..., Awaitable[Any]],
         _stretch_v2: bool,
         _target_smile: str,
-        smile_hostname: str,
-        smile_hw_version: str | None,
-        smile_mac_address: str | None,
-        smile_model: str,
-        smile_name: str,
-        smile_type: str,
-        smile_version: Version,
-        smile_zigbee_mac_address: str | None,
+        smile: Munch,
     ) -> None:
         """Set the constructor for this class."""
         super().__init__()
@@ -61,14 +55,7 @@ class SmileLegacyAPI(SmileLegacyData):
         self._request = _request
         self._stretch_v2 = _stretch_v2
         self._target_smile = _target_smile
-        self.smile_hostname = smile_hostname
-        self.smile_hw_version = smile_hw_version
-        self.smile_mac_address = smile_mac_address
-        self.smile_model = smile_model
-        self.smile_name = smile_name
-        self.smile_type = smile_type
-        self.smile_version = smile_version
-        self.smile_zigbee_mac_address = smile_zigbee_mac_address
+        self.smile = smile
 
         self._first_update = True
         self._previous_day_number: str = "0"
@@ -84,7 +71,7 @@ class SmileLegacyAPI(SmileLegacyData):
         self._locations = await self._request(LOCATIONS)
         self._modules = await self._request(MODULES)
         # P1 legacy has no appliances
-        if self.smile_type != "power":
+        if self.smile.type != "power":
             self._appliances = await self._request(APPLIANCES)
 
     def get_all_gateway_entities(self) -> None:
@@ -195,7 +182,7 @@ class SmileLegacyAPI(SmileLegacyData):
         Determined from - DOMAIN_OBJECTS.
         Used in HA Core to set the hvac_mode: in practice switch between schedule on - off.
         """
-        if state not in ("on", "off"):
+        if state not in (STATE_OFF, STATE_ON):
             raise PlugwiseError("Plugwise: invalid schedule state.")
 
         # Handle no schedule-name / Off-schedule provided
@@ -214,7 +201,7 @@ class SmileLegacyAPI(SmileLegacyData):
             )  # pragma: no cover
 
         new_state = "false"
-        if state == "on":
+        if state == STATE_ON:
             new_state = "true"
 
         locator = f'.//*[@id="{schedule_rule_id}"]/template'
@@ -234,13 +221,16 @@ class SmileLegacyAPI(SmileLegacyData):
 
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
-    ) -> None:
+    ) -> bool:
         """Set the given state of the relevant switch.
 
         For individual switches, sets the state directly.
         For group switches, sets the state for each member in the group separately.
         For switch-locks, sets the lock state using a different data format.
+        Return the requested state when succesful, the current state otherwise.
         """
+        current_state = self.gw_entities[appl_id]["switches"]["relay"]
+        requested_state = state == STATE_ON
         switch = Munch()
         switch.actuator = "actuator_functionalities"
         switch.func_type = "relay_functionality"
@@ -250,7 +240,7 @@ class SmileLegacyAPI(SmileLegacyData):
 
         # Handle switch-lock
         if model == "lock":
-            state = "false" if state == "off" else "true"
+            state = "true" if state == STATE_ON else "false"
             appliance = self._appliances.find(f'appliance[@id="{appl_id}"]')
             appl_name = appliance.find("name").text
             appl_type = appliance.find("type").text
@@ -269,37 +259,45 @@ class SmileLegacyAPI(SmileLegacyData):
                 "</appliances>"
             )
             await self.call_request(APPLIANCES, method="post", data=data)
-            return
+            return requested_state
 
         # Handle group of switches
         data = f"<{switch.func_type}><state>{state}</state></{switch.func_type}>"
         if members is not None:
             return await self._set_groupswitch_member_state(
-                data, members, state, switch
+                appl_id, data, members, state, switch
             )
 
         # Handle individual relay switches
         uri = f"{APPLIANCES};id={appl_id}/relay"
-        if model == "relay":
-            locator = (
-                f'appliance[@id="{appl_id}"]/{switch.actuator}/{switch.func_type}/lock'
-            )
+        if model == "relay" and self.gw_entities[appl_id]["switches"]["lock"]:
             # Don't bother switching a relay when the corresponding lock-state is true
-            if self._appliances.find(locator).text == "true":
-                raise PlugwiseError("Plugwise: the locked Relay was not switched.")
+            return current_state
 
         await self.call_request(uri, method="put", data=data)
+        return requested_state
 
     async def _set_groupswitch_member_state(
-        self, data: str, members: list[str], state: str, switch: Munch
-    ) -> None:
+        self, appl_id: str, data: str, members: list[str], state: str, switch: Munch
+    ) -> bool:
         """Helper-function for set_switch_state().
 
-        Set the given State of the relevant Switch (relay) within a group of members.
+        Set the requested state of the relevant switch within a group of switches.
+        Return the current group-state when none of the switches has changed its state, the requested state otherwise.
         """
+        current_state = self.gw_entities[appl_id]["switches"]["relay"]
+        requested_state = state == STATE_ON
+        switched = 0
         for member in members:
-            uri = f"{APPLIANCES};id={member}/relay"
-            await self.call_request(uri, method="put", data=data)
+            if not self.gw_entities[member]["switches"]["lock"]:
+                uri = f"{APPLIANCES};id={member}/relay"
+                await self.call_request(uri, method="put", data=data)
+                switched += 1
+
+        if switched > 0:
+            return requested_state
+
+        return current_state  # pragma: no cover
 
     async def set_temperature(self, _: str, items: dict[str, float]) -> None:
         """Set the given Temperature on the relevant Thermostat."""
@@ -310,7 +308,7 @@ class SmileLegacyAPI(SmileLegacyData):
         if setpoint is None:
             raise PlugwiseError(
                 "Plugwise: failed setting temperature: no valid input provided"
-            )  # pragma: no cover"
+            )  # pragma: no cover
 
         temperature = str(setpoint)
         data = (

plugwise/smile.py

@@ -7,7 +7,7 @@ from __future__ import annotations
 
 from collections.abc import Awaitable, Callable
 import datetime as dt
-from typing import Any
+from typing import Any, cast
 
 from plugwise.constants import (
     ADAM,
@@ -22,7 +22,10 @@ from plugwise.constants import (
     NOTIFICATIONS,
     OFF,
     RULES,
+    STATE_OFF,
+    STATE_ON,
     GwEntityData,
+    SwitchType,
     ThermoLoc,
 )
 from plugwise.data import SmileData
@@ -32,7 +35,27 @@ from defusedxml import ElementTree as etree
 
 # Dict as class
 from munch import Munch
-from packaging.version import Version
+
+
+def model_to_switch_items(model: str, state: str, switch: Munch) -> tuple[str, Munch]:
+    """Translate state and switch attributes based on model name.
+
+    Helper function for set_switch_state().
+    """
+    match model:
+        case "dhw_cm_switch":
+            switch.device = "toggle"
+            switch.func_type = "toggle_functionality"
+            switch.act_type = "domestic_hot_water_comfort_mode"
+        case "cooling_ena_switch":
+            switch.device = "toggle"
+            switch.func_type = "toggle_functionality"
+            switch.act_type = "cooling_enabled"
+        case "lock":
+            switch.func = "lock"
+            state = "true" if state == STATE_ON else "false"
+
+    return state, switch
 
 
 class SmileAPI(SmileData):
@@ -51,14 +74,7 @@ class SmileAPI(SmileData):
         _opentherm_device: bool,
         _request: Callable[..., Awaitable[Any]],
         _schedule_old_states: dict[str, dict[str, str]],
-        smile_hostname: str | None,
-        smile_hw_version: str | None,
-        smile_mac_address: str | None,
-        smile_model: str,
-        smile_model_id: str | None,
-        smile_name: str,
-        smile_type: str,
-        smile_version: Version,
+        smile: Munch,
     ) -> None:
         """Set the constructor for this class."""
         super().__init__()
@@ -71,14 +87,7 @@ class SmileAPI(SmileData):
         self._opentherm_device = _opentherm_device
         self._request = _request
         self._schedule_old_states = _schedule_old_states
-        self.smile_hostname = smile_hostname
-        self.smile_hw_version = smile_hw_version
-        self.smile_mac_address = smile_mac_address
-        self.smile_model = smile_model
-        self.smile_model_id = smile_model_id
-        self.smile_name = smile_name
-        self.smile_type = smile_type
-        self.smile_version = smile_version
+        self.smile = smile
         self.therms_with_offset_func: list[str] = []
 
     @property
@@ -104,7 +113,7 @@ class SmileAPI(SmileData):
             self.therms_with_offset_func = (
                 self._get_appliances_with_offset_functionality()
             )
-            if self.smile(ADAM):
+            if self.check_name(ADAM):
                 self._scan_thermostats()
 
         if group_data := self._get_group_switches():
@@ -309,12 +318,12 @@ class SmileAPI(SmileData):
         Used in HA Core to set the hvac_mode: in practice switch between schedule on - off.
         """
         # Input checking
-        if new_state not in ("on", "off"):
+        if new_state not in (STATE_OFF, STATE_ON):
             raise PlugwiseError("Plugwise: invalid schedule state.")
 
         # Translate selection of Off-schedule-option to disabling the active schedule
         if name == OFF:
-            new_state = "off"
+            new_state = STATE_OFF
 
         # Handle no schedule-name / Off-schedule provided
         if name is None or name == OFF:
@@ -337,7 +346,7 @@ class SmileAPI(SmileData):
         template = (
             '<template tag="zone_preset_based_on_time_and_presence_with_override" />'
         )
-        if self.smile(ANNA):
+        if self.check_name(ANNA):
             locator = f'.//*[@id="{schedule_rule_id}"]/template'
             template_id = self._domain_objects.find(locator).attrib["id"]
             template = f'<template id="{template_id}" />'
@@ -367,39 +376,43 @@ class SmileAPI(SmileData):
             subject = f'<context><zone><location id="{loc_id}" /></zone></context>'
             subject = etree.fromstring(subject)
 
-        if state == "off":
+        if state == STATE_OFF:
             self._last_active[loc_id] = name
             contexts.remove(subject)
-        if state == "on":
+        if state == STATE_ON:
             contexts.append(subject)
 
         return str(etree.tostring(contexts, encoding="unicode").rstrip())
 
     async def set_switch_state(
         self, appl_id: str, members: list[str] | None, model: str, state: str
-    ) -> None:
-        """Set the given State of the relevant Switch."""
+    ) -> bool:
+        """Set the given state of the relevant Switch.
+
+        For individual switches, sets the state directly.
+        For group switches, sets the state for each member in the group separately.
+        For switch-locks, sets the lock state using a different data format.
+        Return the requested state when succesful, the current state otherwise.
+        """
+        model_type = cast(SwitchType, model)
+        current_state = self.gw_entities[appl_id]["switches"][model_type]
+        requested_state = state == STATE_ON
         switch = Munch()
         switch.actuator = "actuator_functionalities"
         switch.device = "relay"
         switch.func_type = "relay_functionality"
         switch.func = "state"
-        if model == "dhw_cm_switch":
-            switch.device = "toggle"
-            switch.func_type = "toggle_functionality"
-            switch.act_type = "domestic_hot_water_comfort_mode"
-
-        if model == "cooling_ena_switch":
-            switch.device = "toggle"
-            switch.func_type = "toggle_functionality"
-            switch.act_type = "cooling_enabled"
-
-        if model == "lock":
-            switch.func = "lock"
-            state = "false" if state == "off" else "true"
+        state, switch = model_to_switch_items(model, state, switch)
+        data = (
+            f"<{switch.func_type}>"
+            f"<{switch.func}>{state}</{switch.func}>"
+            f"</{switch.func_type}>"
+        )
 
         if members is not None:
-            return await self._set_groupswitch_member_state(members, state, switch)
+            return await self._set_groupswitch_member_state(
+                appl_id, data, members, state, switch
+            )
 
         locator = f'appliance[@id="{appl_id}"]/{switch.actuator}/{switch.func_type}'
         found = self._domain_objects.findall(locator)
@@ -412,39 +425,42 @@ class SmileAPI(SmileData):
             else:  # actuators with a single item like relay_functionality
                 switch_id = item.attrib["id"]
 
-        data = (
-            f"<{switch.func_type}>"
-            f"<{switch.func}>{state}</{switch.func}>"
-            f"</{switch.func_type}>"
-        )
         uri = f"{APPLIANCES};id={appl_id}/{switch.device};id={switch_id}"
         if model == "relay":
-            locator = (
-                f'appliance[@id="{appl_id}"]/{switch.actuator}/{switch.func_type}/lock'
-            )
-            # Don't bother switching a relay when the corresponding lock-state is true
-            if self._domain_objects.find(locator).text == "true":
-                raise PlugwiseError("Plugwise: the locked Relay was not switched.")
+            lock_blocked = self.gw_entities[appl_id]["switches"].get("lock")
+            if lock_blocked or lock_blocked is None:
+                # Don't switch a relay when its corresponding lock-state is true or no
+                # lock is present. That means the relay can't be controlled by the user.
+                return current_state
 
         await self.call_request(uri, method="put", data=data)
+        return requested_state
 
     async def _set_groupswitch_member_state(
-        self, members: list[str], state: str, switch: Munch
-    ) -> None:
+        self, appl_id: str, data: str, members: list[str], state: str, switch: Munch
+    ) -> bool:
         """Helper-function for set_switch_state().
 
-        Set the given State of the relevant Switch within a group of members.
+        Set the requested state of the relevant switch within a group of switches.
+        Return the current group-state when none of the switches has changed its state, the requested state otherwise.
         """
+        current_state = self.gw_entities[appl_id]["switches"]["relay"]
+        requested_state = state == STATE_ON
+        switched = 0
         for member in members:
             locator = f'appliance[@id="{member}"]/{switch.actuator}/{switch.func_type}'
             switch_id = self._domain_objects.find(locator).attrib["id"]
             uri = f"{APPLIANCES};id={member}/{switch.device};id={switch_id}"
-            data = (
-                f"<{switch.func_type}>"
-                f"<{switch.func}>{state}</{switch.func}>"
-                f"</{switch.func_type}>"
-            )
-            await self.call_request(uri, method="put", data=data)
+            lock_blocked = self.gw_entities[member]["switches"].get("lock")
+            # Assume Plugs under Plugwise control are not part of a group
+            if lock_blocked is not None and not lock_blocked:
+                await self.call_request(uri, method="put", data=data)
+                switched += 1
+
+        if switched > 0:
+            return requested_state
+
+        return current_state
 
     async def set_temperature(self, loc_id: str, items: dict[str, float]) -> None:
         """Set the given Temperature on the relevant Thermostat."""
@@ -453,7 +469,7 @@ class SmileAPI(SmileData):
         if "setpoint" in items:
             setpoint = items["setpoint"]
 
-        if self.smile(ANNA) and self._cooling_present:
+        if self.check_name(ANNA) and self._cooling_present:
             if "setpoint_high" not in items:
                 raise PlugwiseError(
                     "Plugwise: failed setting temperature: no valid input provided"

{plugwise-1.7.5.dist-info → plugwise-1.7.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plugwise
-Version: 1.7.5
+Version: 1.7.7
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Author: Plugwise device owners
 Maintainer: bouwew, CoMPaTech
@@ -16,6 +16,7 @@ Classifier: Topic :: Home Automation
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiofiles
 Requires-Dist: aiohttp
 Requires-Dist: defusedxml
 Requires-Dist: munch

plugwise-1.7.7.dist-info/RECORD

@@ -0,0 +1,18 @@
+plugwise/__init__.py,sha256=tctQhmRTvr70Am9x5V1UZf_VtPlw6o2if1MlgMVGcYo,17408
+plugwise/common.py,sha256=vP4DgD1_Sv5B-7MwSjiYn7xoke20oDWggQ3aY5W1Jeg,10084
+plugwise/constants.py,sha256=V7piQ9xOrJ8nDK-RBcMiodSX3L-vEgRwnWmmxyRZCX8,16917
+plugwise/data.py,sha256=ZS6Oo05R0vXksYwsReKQLGCoyQd8bo-hg8jGE2uMH-w,12495
+plugwise/exceptions.py,sha256=Ce-tO9uNsMB-8FP6VAxBvsHNJ-NIM9F0onUZOdZI4Ys,1110
+plugwise/helper.py,sha256=LmepTNlN_EtamwZ-ur8A-MWY04X4wG1ZPN-E1f9Y1W0,38908
+plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugwise/smile.py,sha256=hk_KTOzajekJvxi05g4sJoJ49YvlSLLUiNluvMUbKBM,20319
+plugwise/smilecomm.py,sha256=DRQ3toRNEf3oo_mej49fPJ47m5das-jvo-8GnIrSPzw,5208
+plugwise/util.py,sha256=rMcqfaB4dkQEZFJY-bBJISmlYgTnb6Ns3-Doxelf92Q,10689
+plugwise/legacy/data.py,sha256=Z-7nw21s9-L4DcwPCZ_yoRGeI_fWBS1Q48kHmyh2pkY,3145
+plugwise/legacy/helper.py,sha256=vUuYX-vJErbVwGJu7On1ITDh8X8nzO8WoqN-whS9FJ4,16710
+plugwise/legacy/smile.py,sha256=RBfasiOrAXUWwvUqciO0xzel4VMNsY0Nzb44GHqDPpo,12837
+plugwise-1.7.7.dist-info/licenses/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
+plugwise-1.7.7.dist-info/METADATA,sha256=dDEkjG-sCbjz4Hscb23yRpRuCT8vZkCVXZvFy2IHOTQ,7903
+plugwise-1.7.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+plugwise-1.7.7.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
+plugwise-1.7.7.dist-info/RECORD,,

plugwise-1.7.5.dist-info/RECORD

@@ -1,18 +0,0 @@
-plugwise/__init__.py,sha256=BKT3BagtOOy2Efk2m8uQLFPE4vizEjjPMj61Zs7MwMw,17492
-plugwise/common.py,sha256=_O7cC7fPGHZkrxQTaK2y8_trr9lOjEtgbS6plOfp2jk,9589
-plugwise/constants.py,sha256=zJFm0J14PJWasKSvepriOc6mYLljRVGNGAF5QDtzyl0,16869
-plugwise/data.py,sha256=OxZufaAmnyVDkRGJBdk6tf-I65FaCwcT69scNsZnmiA,12490
-plugwise/exceptions.py,sha256=Ce-tO9uNsMB-8FP6VAxBvsHNJ-NIM9F0onUZOdZI4Ys,1110
-plugwise/helper.py,sha256=AdQ4Tno5zheFI5y5A-YovVGYW_islxCxkt0B77TfC-o,39701
-plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plugwise/smile.py,sha256=WPZ0v45RpgJxBWEy_Sy_vsX87V4UPaVkkSgY7yZouAQ,19550
-plugwise/smilecomm.py,sha256=DRQ3toRNEf3oo_mej49fPJ47m5das-jvo-8GnIrSPzw,5208
-plugwise/util.py,sha256=rMcqfaB4dkQEZFJY-bBJISmlYgTnb6Ns3-Doxelf92Q,10689
-plugwise/legacy/data.py,sha256=Z-7nw21s9-L4DcwPCZ_yoRGeI_fWBS1Q48kHmyh2pkY,3145
-plugwise/legacy/helper.py,sha256=cDi8zvUtoCqxVrLksqjlCHUmjXjulXCf-l9fMjFPOfs,17417
-plugwise/legacy/smile.py,sha256=Q133Ub5W6VB1MyxzAZze3cFyXvTxIeIbCxSUP4eXNXM,12867
-plugwise-1.7.5.dist-info/licenses/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
-plugwise-1.7.5.dist-info/METADATA,sha256=UwtDKfDR3OtdpQ09Ra4KwD2xcQte8t9db-X81VRAkfw,7879
-plugwise-1.7.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-plugwise-1.7.5.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
-plugwise-1.7.5.dist-info/RECORD,,