Let set-switch functions return a bool, improve handling of locked state

Author: bouwew

plugwise/__init__.py

@@ -398,10 +398,10 @@ async def set_temperature_offset(self, dev_id: str, offset: float) -> None:
 
     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."""
         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/legacy/smile.py

@@ -234,7 +234,7 @@ async def set_schedule_state(
 
     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.
@@ -269,7 +269,7 @@ async def set_switch_state(
                 "</appliances>"
             )
             await self.call_request(APPLIANCES, method="post", data=data)
-            return
+            return True
 
         # Handle group of switches
         data = f"<{switch.func_type}><state>{state}</state></{switch.func_type}>"
@@ -280,26 +280,26 @@ async def set_switch_state(
 
         # 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 False
 
         await self.call_request(uri, method="put", data=data)
+        return True
 
     async def _set_groupswitch_member_state(
         self, data: str, members: list[str], state: str, switch: Munch
-    ) -> None:
+    ) -> bool:
         """Helper-function for set_switch_state().
 
         Set the given State of the relevant Switch (relay) within a group of members.
         """
         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)
+        
+        return True
 
     async def set_temperature(self, _: str, items: dict[str, float]) -> None:
         """Set the given Temperature on the relevant Thermostat."""

plugwise/smile.py

@@ -377,7 +377,7 @@ def determine_contexts(
 
     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."""
         switch = Munch()
         switch.actuator = "actuator_functionalities"
@@ -418,19 +418,16 @@ async def set_switch_state(
             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.")
+        if model == "relay" and self.gw_entities[appl_id]["switches"]["lock"]:
+            # Don't switch a relay when its corresponding lock-state is true
+            return False
 
         await self.call_request(uri, method="put", data=data)
+        return True
 
     async def _set_groupswitch_member_state(
         self, members: list[str], state: str, switch: Munch
-    ) -> None:
+    ) -> bool:
         """Helper-function for set_switch_state().
 
         Set the given State of the relevant Switch within a group of members.
@@ -444,7 +441,10 @@ async def _set_groupswitch_member_state(
                 f"<{switch.func}>{state}</{switch.func}>"
                 f"</{switch.func_type}>"
             )
-            await self.call_request(uri, method="put", data=data)
+            if not self.gw_entities[member]["switches"].get("lock"):
+                await self.call_request(uri, method="put", data=data)
+
+        return True
 
     async def set_temperature(self, loc_id: str, items: dict[str, float]) -> None:
         """Set the given Temperature on the relevant Thermostat."""