Merge pull request #64 from plugwise/dhw_mode

Implement support for the dhw_comform_mode switch

Author: bouwew

.github/workflows/verify.yml

@@ -4,7 +4,7 @@
 name: Latest commit
 
 env:
-  CACHE_VERSION: 2
+  CACHE_VERSION: 3
   DEFAULT_PYTHON: 3.9
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.9.0"
+__version__ = "0.9.1"
 
 from plugwise.smile import Smile
 from plugwise.stick import stick

plugwise/constants.py

@@ -383,6 +383,10 @@
         ATTR_NAME: "water_temperature",
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
     },
+    "domestic_hot_water_comfort_mode": {
+        ATTR_NAME: "dhw_comf_mode",
+        ATTR_UNIT_OF_MEASUREMENT: None,
+    },
     "domestic_hot_water_state": {
         ATTR_NAME: "dhw_state",
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,

plugwise/smile.py

@@ -1207,35 +1207,39 @@ def __get_temperature_uri(self, loc_id):
 
         return f"{LOCATIONS};id={loc_id}/thermostat;id={thermostat_functionality_id}"
 
-    async def set_relay_state(self, appl_id, members, state):
-        """Switch the Plug off/on."""
+    async def set_switch_state(self, appl_id, members, model, state):
+        """Switch the Switch off/on."""
         actuator = "actuator_functionalities"
-        relay = "relay_functionality"
+        func_type = "relay_functionality"
+        device = "relay"
+        if model == "dhw_cm_switch":
+            func_type = "toggle_functionality"
+            device = "toggle"
         stretch_v2 = self.smile_type == "stretch" and self.smile_version[1].major == 2
         if stretch_v2:
             actuator = "actuators"
-            relay = "relay"
+            func_type = "relay"
 
         if members is not None:
             for member in members:
-                locator = f'appliance[@id="{member}"]/{actuator}/{relay}'
-                relay_functionality_id = self._appliances.find(locator).attrib["id"]
-                uri = f"{APPLIANCES};id={member}/relay;id={relay_functionality_id}"
+                locator = f'appliance[@id="{member}"]/{actuator}/{func_type}'
+                switch_id = self._appliances.find(locator).attrib["id"]
+                uri = f"{APPLIANCES};id={member}/{device};id={switch_id}"
                 if stretch_v2:
-                    uri = f"{APPLIANCES};id={member}/relay"
+                    uri = f"{APPLIANCES};id={member}/{device}"
                 state = str(state)
-                data = f"<{relay}><state>{state}</state></{relay}>"
+                data = f"<{func_type}><state>{state}</state></{func_type}>"
 
                 await self.request(uri, method="put", data=data)
             return True
 
-        locator = f'appliance[@id="{appl_id}"]/{actuator}/{relay}'
-        relay_functionality_id = self._appliances.find(locator).attrib["id"]
-        uri = f"{APPLIANCES};id={appl_id}/relay;id={relay_functionality_id}"
+        locator = f'appliance[@id="{appl_id}"]/{actuator}/{func_type}'
+        switch_id = self._appliances.find(locator).attrib["id"]
+        uri = f"{APPLIANCES};id={appl_id}/{device};id={switch_id}"
         if stretch_v2:
-            uri = f"{APPLIANCES};id={appl_id}/relay"
+            uri = f"{APPLIANCES};id={appl_id}/{device}"
         state = str(state)
-        data = f"<{relay}><state>{state}</state></{relay}>"
+        data = f"<{func_type}><state>{state}</state></{func_type}>"
 
         await self.request(uri, method="put", data=data)
         return True

tests/test_smile.py

@@ -329,18 +329,20 @@ async def device_test(self, smile=pw_smile.Smile, testdata=None):
                         assert data[measure_key] == measure_assert
 
     @pytest.mark.asyncio
-    async def tinker_relay(self, smile, dev_ids=None, members=None, unhappy=False):
-        """Switch a relay on and off to test functionality."""
-        _LOGGER.info("Asserting modifying settings for relay devices:")
+    async def tinker_switch(
+        self, smile, dev_ids=None, members=None, model=None, unhappy=False
+    ):
+        """Turn a Switch on and off to test functionality."""
+        _LOGGER.info("Asserting modifying settings for switch devices:")
         for dev_id in dev_ids:
             _LOGGER.info("- Devices (%s):", dev_id)
             for new_state in [False, True, False]:
                 _LOGGER.info("- Switching %s", new_state)
                 try:
-                    relay_change = await smile.set_relay_state(
-                        dev_id, members, new_state
+                    switch_change = await smile.set_switch_state(
+                        dev_id, members, model, new_state
                     )
-                    assert relay_change
+                    assert switch_change
                     _LOGGER.info("  + worked as intended")
                 except (
                     pw_exceptions.ErrorSendingCommandError,
@@ -878,7 +880,7 @@ async def test_connect_adam_plus_anna(self):
         await self.tinker_thermostat(
             smile, "009490cc2f674ce6b576863fbb64f867", good_schemas=["Weekschema"]
         )
-        await self.tinker_relay(smile, ["aa6b0002df0a46e1b1eb94beb61eddfe"])
+        await self.tinker_switch(smile, ["aa6b0002df0a46e1b1eb94beb61eddfe"])
         await smile.close_connection()
         await self.disconnect(server, client)
 
@@ -889,7 +891,7 @@ async def test_connect_adam_plus_anna(self):
             good_schemas=["Weekschema"],
             unhappy=True,
         )
-        await self.tinker_relay(
+        await self.tinker_switch(
             smile, ["aa6b0002df0a46e1b1eb94beb61eddfe"], unhappy=True
         )
         await smile.close_connection()
@@ -913,12 +915,14 @@ async def test_connect_adam_plus_anna_new(self):
         _LOGGER.info(" # Assert version")
         assert smile.smile_version[0] == "3.2.4"
 
-        await self.tinker_relay(
+        await self.tinker_switch(
             smile,
             ["b83f9f9758064c0fab4af6578cba4c6d"],
             ["aa6b0002df0a46e1b1eb94beb61eddfe", "f2be121e4a9345ac83c6e99ed89a98be"],
         )
-
+        await self.tinker_switch(
+            smile, ["2743216f626f43948deec1f7ab3b3d70"], model="dhw_cm_switch"
+        )
         await self.device_test(smile, testdata)
         await smile.close_connection()
         await self.disconnect(server, client)
@@ -986,7 +990,7 @@ async def test_connect_adam_zone_per_device(self):
         await self.tinker_thermostat(
             smile, "82fa13f017d240daa0d0ea1775420f24", good_schemas=["CV Jessie"]
         )
-        await self.tinker_relay(smile, ["675416a629f343c495449970e2ca37b5"])
+        await self.tinker_switch(smile, ["675416a629f343c495449970e2ca37b5"])
         await smile.close_connection()
         await self.disconnect(server, client)
 
@@ -1069,7 +1073,7 @@ async def test_connect_adam_multiple_devices_per_zone(self):
         await self.tinker_thermostat(
             smile, "82fa13f017d240daa0d0ea1775420f24", good_schemas=["CV Jessie"]
         )
-        await self.tinker_relay(smile, ["675416a629f343c495449970e2ca37b5"])
+        await self.tinker_switch(smile, ["675416a629f343c495449970e2ca37b5"])
         await smile.close_connection()
         await self.disconnect(server, client)
 
@@ -1360,7 +1364,7 @@ async def test_connect_stretch_v23(self):
         _LOGGER.info(" # Assert legacy")
         assert smile._smile_legacy  # pylint: disable=protected-access
 
-        await self.tinker_relay(smile, ["2587a7fcdd7e482dab03fda256076b4b"])
+        await self.tinker_switch(smile, ["2587a7fcdd7e482dab03fda256076b4b"])
 
         await self.device_test(smile, testdata)