Merge pull request #167 from plugwise/regulation_mode

Add regulation_mode(s) and max_boiler_temp to output

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+# v0.17.0 - Smile: add more outputs
+- Add regulation_mode and regulation_modes to gateway dict, add related set-function
+- Add max_boiler_temperature to heater_central dict, add related set-function
+- Improve typing hints
+
 # v0.16.9 - Smile: bugfix and improve
 - Fix for https://github.com/plugwise/plugwise-beta/issues/250
 - Rename heatpump outdoor_temperature sensor to outdoor_air_temperature sensor

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.16.10a0"
+__version__ = "0.17.0"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -441,6 +441,8 @@
     "lower_bound": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     "upper_bound": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     "resolution": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "regulation_mode": {ATTR_UNIT_OF_MEASUREMENT: None},
+    "maximum_boiler_temperature": {ATTR_UNIT_OF_MEASUREMENT: None},
 }
 
 # Heater Central related measurements

plugwise/helper.py

@@ -290,6 +290,7 @@ def __init__(self):
         """Set the constructor for this class."""
         self._appl_data: dict[str, Any] = {}
         self._appliances: etree | None = None
+        self._allowed_modes: list[str] = []
         self._anna_cooling_present: bool = False
         self._cooling_activation_outdoor_temp: float | None = None
         self._cooling_deactivation_threshold: float | None = None
@@ -500,6 +501,7 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
                     for mode in search.find("allowed_modes"):
                         mode_list.append(mode.text)
                     self._cooling_present = "cooling" in mode_list
+                    self._allowed_modes = mode_list
 
             return appl
 
@@ -815,9 +817,12 @@ def _appliance_measurements(
                 except KeyError:
                     pass
 
-                data[measurement] = format_measure(
-                    appl_p_loc.text, attrs.get(ATTR_UNIT_OF_MEASUREMENT)
-                )
+                data[measurement] = appl_p_loc.text
+                # measurements with states "on" or "off" that need to be passed directly
+                if measurement not in ["regulation_mode"]:
+                    data[measurement] = format_measure(
+                        appl_p_loc.text, attrs.get(ATTR_UNIT_OF_MEASUREMENT)
+                    )
 
                 # Anna: save cooling-related measurements for later use
                 # Use the local outdoor temperature as reference for turning cooling on/off

plugwise/smile.py

@@ -193,15 +193,19 @@ def _get_device_data(self, dev_id: str) -> dict[str, Any]:
 
         # Generic
         if details.get("class") == "gateway" or dev_id == self.gateway_id:
-            # Adam & Anna: the Smile outdoor_temperature is present in DOMAIN_OBJECTS and LOCATIONS - under Home
-            # The outdoor_temperature present in APPLIANCES is a local sensor connected to the active device
             if self.smile_type == "thermostat":
+                # Adam & Anna: the Smile outdoor_temperature is present in DOMAIN_OBJECTS and LOCATIONS - under Home
+                # The outdoor_temperature present in APPLIANCES is a local sensor connected to the active device
                 outdoor_temperature = self._object_value(
                     self._home_location, "outdoor_temperature"
                 )
                 if outdoor_temperature is not None:
                     device_data["outdoor_temperature"] = outdoor_temperature
 
+                if self.smile_name == "Adam":
+                    # Show the allowed regulation modes
+                    device_data["regulation_modes"] = self._allowed_modes
+
             # Get P1 data from LOCATIONS
             power_data = self._power_data_from_location(details.get("location"))
             if power_data is not None:
@@ -565,7 +569,6 @@ async def set_preset(self, loc_id: str, preset: str) -> bool:
 
     async def set_temperature(self, loc_id: str, temperature: str) -> bool:
         """Set the given Temperature on the relevant Thermostat."""
-        temperature = str(temperature)
         uri = self._thermostat_uri(loc_id)
         data = (
             "<thermostat_functionality><setpoint>"
@@ -575,6 +578,19 @@ async def set_temperature(self, loc_id: str, temperature: str) -> bool:
         await self._request(uri, method="put", data=data)
         return True
 
+    async def set_max_boiler_temperature(self, temperature: str) -> bool:
+        """Set the max. Boiler Temperature on the Central heating boiler."""
+        locator = f'appliance[@id="{self._heater_id}"]/actuator_functionalities/thermostat_functionality'
+        th_func = self._appliances.find(locator)
+        if th_func.find("type").text == "maximum_boiler_temperature":
+            thermostat_id = th_func.attrib["id"]
+
+        uri = f"{APPLIANCES};id={self._heater_id}/thermostat;id={thermostat_id}"
+        data = f"<thermostat_functionality><setpoint>{temperature}</setpoint></thermostat_functionality>"
+
+        await self._request(uri, method="put", data=data)
+        return True
+
     async def _set_groupswitch_member_state(
         self, members: list[str] | None, state: str, switch: Munch
     ) -> bool:
@@ -636,6 +652,20 @@ async def set_switch_state(
         await self._request(uri, method="put", data=data)
         return True
 
+    async def set_regulation_mode(self, mode: str) -> bool:
+        """Set the heating regulation mode."""
+        if mode not in self._allowed_modes:
+            return False
+
+        uri = f"{APPLIANCES};type=gateway/regulation_mode_control"
+        duration = ""
+        if "bleeding" in mode:
+            duration = "<duration>300</duration>"
+        data = f"<regulation_mode_control_functionality>{duration}<mode>{mode}</mode></regulation_mode_control_functionality>"
+
+        await self._request(uri, method="put", data=data)
+        return True
+
     async def delete_notification(self) -> bool:
         """Delete the active Plugwise Notification."""
         uri = NOTIFICATIONS

tests/test_smile.py

@@ -564,6 +564,30 @@ async def tinker_thermostat(self, smile, loc_id, good_schemas=None, unhappy=Fals
         await self.tinker_thermostat_preset(smile, loc_id, unhappy)
         await self.tinker_thermostat_schema(smile, loc_id, good_schemas, unhappy)
 
+    @staticmethod
+    async def tinker_regulation_mode(smile):
+        """Toggle regulation_mode to test functionality."""
+        for mode in ["off", "heating", "bleeding_cold", "!bogus"]:
+            assert_state = True
+            warning = ""
+            if mode[0] == "!":
+                assert_state = False
+                warning = " Negative test"
+                mode = mode[1:]
+            _LOGGER.info("%s", f"- Adjusting regulation mode to {mode}{warning}")
+            mode_change = await smile.set_regulation_mode(mode)
+            assert mode_change == assert_state
+            _LOGGER.info("  + worked as intended")
+
+    @staticmethod
+    async def tinker_max_boiler_temp(smile):
+        """Change max boiler temp setpoint to test functionality."""
+        new_temp = 60.0
+        _LOGGER.info("- Adjusting temperature to %s", new_temp)
+        temp_change = await smile.set_max_boiler_temperature(new_temp)
+        assert temp_change
+        _LOGGER.info("  + worked as intended")
+
     @pytest.mark.asyncio
     async def test_connect_legacy_anna(self):
         """Test a legacy Anna device."""
@@ -603,6 +627,7 @@ async def test_connect_legacy_anna(self):
                 "model": "4.21",
                 "name": "OpenTherm",
                 "vendor": "Bosch Thermotechniek B.V.",
+                "maximum_boiler_temperature": 50.0,
                 "binary_sensors": {"flame_state": True, "heating_state": True},
                 "sensors": {
                     "water_temperature": 23.6,
@@ -1447,6 +1472,9 @@ async def test_connect_adam_plus_anna_new(self):
                 "model": "Adam",
                 "name": "Adam",
                 "vendor": "Plugwise B.V.",
+                "zigbee_mac_address": "ABCD012345670101",
+                "regulation_mode": "heating",
+                "regulation_modes": ["heating", "off", "bleeding_cold", "bleeding_hot"],
                 "binary_sensors": {"plugwise_notification": False},
                 "sensors": {"outdoor_temperature": -1.25},
             },
@@ -1458,6 +1486,7 @@ async def test_connect_adam_plus_anna_new(self):
                 "model": "Generic heater",
                 "name": "OpenTherm",
                 "vendor": None,
+                "maximum_boiler_temperature": 60.0,
                 "binary_sensors": {
                     "dhw_state": False,
                     "flame_state": False,
@@ -1516,6 +1545,11 @@ async def test_connect_adam_plus_anna_new(self):
             smile, "2568cc4b9c1e401495d4741a5f89bee1"
         )
         assert not switch_change
+
+        await self.tinker_regulation_mode(smile)
+
+        await self.tinker_max_boiler_temp(smile)
+
         await smile.close_connection()
         await self.disconnect(server, client)