Merge pull request #114 from plugwise/cooling_anna

Anna: implement detection of cooling presence

Author: bouwew

CHANGELOG.md

@@ -1,7 +1,9 @@
 # Changelog
 
-# ongoing
-  - Improved dependency handling (@dependabot)
+# v0.15.7 - Smile - Anna: better implementation of cooling-function-detection
+ - Anna: add two sensors related to automatic switching between heating and cooling and add a heating/cooling mode active indication
+ - Adam: also provide a heating/cooling mode active indication
+ - Improved dependency handling (@dependabot)
 
 # v0.15.6 - Smile - Various fixes and improvements
   - Adam: collect `control_state` from master thermostats, allows showing the thermostat state as on the Plugwise App

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.15.6"
+__version__ = "0.15.7a5"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -397,24 +397,26 @@
 # zone_thermosstat 'temperature_offset'
 # radiator_valve 'uncorrected_temperature', 'temperature_offset'
 DEVICE_MEASUREMENTS = {
-    # HA Core current_temperature
+    # HA Core thermostat current_temperature
     "temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
-    # HA Core setpoint
+    # HA Core thermostat setpoint
     "thermostat": {ATTR_NAME: "setpoint", ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    # Specific for an Anna
     "illuminance": {ATTR_UNIT_OF_MEASUREMENT: UNIT_LUMEN},
-    "outdoor_temperature": {
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
-    },  # Outdoor temp as reported on the Anna, in the App
-    "schedule_temperature": {
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
-    },  # Only present on legacy Anna and Anna_v3
-    # Lisa and Tom
+    # Outdoor temperature from APPLIANCES - present for a heatpump
+    "outdoor_temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    # Schedule temperature - only present for a legacy Anna or an Anna v3
+    "schedule_temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    # Specific for an Anna with heatpump extension installed
+    "cooling_activation_outdoor_temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "cooling_deactivation_threshold": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    # Specific for a Lisa a Tom/Floor
     "battery": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
     "temperature_difference": {ATTR_UNIT_OF_MEASUREMENT: DEGREE},
     "valve_position": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
-    # Jip
+    # Specific for a Jip
     "humidity": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
-    # Plug
+    # Specific for a Plug
     "electricity_consumed": {ATTR_UNIT_OF_MEASUREMENT: POWER_WATT},
     "electricity_produced": {ATTR_UNIT_OF_MEASUREMENT: POWER_WATT},
     "relay": {ATTR_UNIT_OF_MEASUREMENT: None},
@@ -435,15 +437,15 @@
     },
     "intended_boiler_temperature": {
         ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS
-    },  # non-zero when heating, zero when dhw-heating
+    },  # Non-zero when heating, zero when dhw-heating
     "central_heating_state": {
         ATTR_NAME: "c_heating_state",
         ATTR_UNIT_OF_MEASUREMENT: None,
-    },  # for Elga (heatpump) use this instead of intended_central_heating_state
+    },  # For Elga (heatpump) use this instead of intended_central_heating_state
     "intended_central_heating_state": {
         ATTR_NAME: "heating_state",
         ATTR_UNIT_OF_MEASUREMENT: None,
-    },  # use intended_c_h_state, this key shows the heating-behavior better than c-h_state
+    },  # This key shows in general the heating-behavior better than c-h_state. except when connected to a heatpump
     "modulation_level": {ATTR_UNIT_OF_MEASUREMENT: PERCENTAGE},
     "return_water_temperature": {
         ATTR_NAME: "return_temperature",
@@ -456,15 +458,14 @@
     "slave_boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
     "flame_state": {
         ATTR_UNIT_OF_MEASUREMENT: None
-    },  # also present when there is a single gas-heater
-    # Anna only
+    },  # Also present when there is a single gas-heater
     "central_heater_water_pressure": {
         ATTR_NAME: "water_pressure",
         ATTR_UNIT_OF_MEASUREMENT: PRESSURE_BAR,
     },
     # Legacy Anna: similar to flame-state on Anna/Adam
     "boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
-    # Legacy Anna: shows when heating is active, don't show dhw_state, cannot be determined reliably
+    # Legacy Anna: shows when heating is active, we don't show dhw_state, cannot be determined reliably
     "intended_boiler_state": {ATTR_UNIT_OF_MEASUREMENT: None},
 }
 
@@ -553,6 +554,14 @@
     ATTR_ID: "battery",
     ATTR_STATE: None,
 }
+COOL_ACT_THRESHOLD = {
+    ATTR_ID: "cooling_activation_outdoor_temperature",
+    ATTR_STATE: None,
+}
+COOL_DEACT_THRESHOLD = {
+    ATTR_ID: "cooling_deactivation_threshold",
+    ATTR_STATE: None,
+}
 CURRENT_TEMP = {
     ATTR_ID: "temperature",
     ATTR_STATE: None,
@@ -695,6 +704,8 @@
 }
 SENSORS = [
     BATTERY,
+    COOL_ACT_THRESHOLD,
+    COOL_DEACT_THRESHOLD,
     CURRENT_TEMP,
     DEVICE_STATE,
     EL_CONSUMED,

plugwise/helper.py

@@ -445,14 +445,17 @@ def _appliance_info_finder(self, appliance, appl):
             appl.model = appl.name = self.smile_name
             appl.v_name = "Plugwise B.V."
 
-            # Adam: check for cooling capability, assume heating capability is always present
+            # Adam: check for cooling capability and active heating/cooling operation-mode
             mode_list = []
-            locator = "./actuator_functionalities/regulation_mode_control_functionality/allowed_modes"
-            if appliance.find(locator) is not None:
-                self._cooling_present = False
-                for mode in appliance.find(locator):
-                    mode_list.append(mode.text)
-                self._cooling_present = "cooling" in mode_list
+            locator = "./actuator_functionalities/regulation_mode_control_functionality"
+            search = appliance.find(locator)
+            if search is not None:
+                if search.find("mode") is not None:
+                    self.cooling_active = search.find("mode").text == "cooling"
+                if search.find("allowed_modes") is not None:
+                    for mode in search.find("allowed_modes"):
+                        mode_list.append(mode.text)
+                    self._cooling_present = "cooling" in mode_list
 
             return appl
 
@@ -463,6 +466,7 @@ def _appliance_info_finder(self, appliance, appl):
             appl.v_name = module_data[0]
             appl.model = check_model(module_data[1], appl.v_name)
             appl.fw = module_data[3]
+
             return appl
 
         if appl.pwclass == "heater_central":
@@ -741,6 +745,11 @@ def _get_appliance_data(self, d_id):
         if "temperature" in data:
             data.pop("heating_state", None)
 
+        # Anna: check for cooling capability
+        if "cooling_activation_outdoor_temperature" in data:
+            data["cooling_active"] = False
+            self._cooling_present = True
+
         return data
 
     def _rank_thermostat(

plugwise/smile.py

@@ -149,6 +149,22 @@ def _device_data_anna(self, dev_id, details, device_data):
             device_data.pop("boiler_state", None)
             device_data.pop("intended_boiler_state", None)
 
+        # Anna: indicate possible active heating/cooling operation-mode
+        # Actual ongoing heating/cooling is shown via heating_state/cooling_state
+        if "cooling_activation_outdoor_temperature" in device_data:
+            if (
+                not self.cooling_active
+                and device_data["temperature"]
+                > device_data["cooling_activation_outdoor_temperature"]
+            ):
+                device_data["cooling_active"] = self.cooling_active = True
+            if (
+                self.cooling_active
+                and device_data["temperature"]
+                < device_data["cooling_deactivation_threshold"]
+            ):
+                device_data["cooling_active"] = self.cooling_active = False
+
         return device_data
 
     def _device_data_adam(self, details, device_data):
@@ -166,6 +182,11 @@ def _device_data_adam(self, details, device_data):
                     if self._heating_valves() == 0:
                         device_data["heating_state"] = False
 
+            # Adam: indicate active heating/cooling operation-mode
+            # Actual ongoing heating/cooling is shown via heating_state/cooling_state
+            if details["class"] == "heater_central":
+                device_data["cooling_active"] = self.cooling_active
+
         return device_data
 
     def _device_data_climate(self, details, device_data):
@@ -185,7 +206,7 @@ def _device_data_climate(self, details, device_data):
         else:
             device_data["last_used"] = self._last_active_schema(details["location"])
 
-        # Find the thermostat control_state of a location, from domain_objects
+        # Find the thermostat control_state of a location, from DOMAIN_OBJECTS
         # The control_state represents the heating/cooling demand-state of the master thermostat
         # Note: heating or cooling can still be active when the setpoint has been reached
         locator = f'location[@id="{details["location"]}"]'
@@ -287,7 +308,7 @@ def __init__(
         self._active_device_present = None
         self._appliances = None
         self._appl_data = None
-        self._cooling_present = None
+        self._cooling_present = False
         self._domain_objects = None
         self._heater_id = None
         self._home_location = None
@@ -300,6 +321,7 @@ def __init__(
         self._stretch_v3 = False
         self._thermo_locs = None
 
+        self.cooling_active = False
         self.gateway_id = None
         self.gw_data = {}
         self.gw_devices = {}

tests/test_smile.py

@@ -365,14 +365,19 @@ def show_setup(location_list, device_list):
                 _LOGGER.info("      ! no devices found in this location")
 
     @pytest.mark.asyncio
-    async def device_test(self, smile=pw_smile.Smile, testdata=None):
+    async def device_test(self, smile=pw_smile.Smile, testdata=None, preset=False):
         """Perform basic device tests."""
         _LOGGER.info("Asserting testdata:")
         bsw_list = ["binary_sensors", "sensors", "switches"]
         smile.get_all_devices()
+        # Preset smile.cooling_active for testing of a state-change
+        smile.cooling_active = False
+        if preset:
+            smile.cooling_active = True
         data = await smile.async_update()
         extra = data[0]
         device_list = data[1]
+
         self.active_device_present = extra["active_device"]
         self.cooling_present = extra["cooling_present"]
         self.notifications = extra["notifications"]
@@ -1085,6 +1090,7 @@ async def test_connect_adam_plus_anna_new(self):
             "ee62cad889f94e8ca3d09021f03a660b": {"control_state": "off"},
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
+                "cooling_active": False,
                 "binary_sensors": [{"id": "dhw_state", "state": True}],
                 "sensors": [{"id": "device_state", "state": "dhw-heating"}],
             },
@@ -1108,7 +1114,6 @@ async def test_connect_adam_plus_anna_new(self):
         _LOGGER.info(" # Assert master thermostat")
         assert not smile._sm_thermostat
         assert self.active_device_present
-        assert not self.cooling_present
 
         switch_change = await self.tinker_switch(
             smile,
@@ -1473,7 +1478,7 @@ async def test_connect_p1v3(self):
 
         await self.device_test(smile, testdata)
         assert smile._sm_thermostat is None  # it's not a thermostat :)
-        assert self.cooling_present is None  # not a heating/cooling system
+        assert not self.cooling_present
         assert not self.notifications
 
         await smile.close_connection()
@@ -1565,9 +1570,14 @@ async def test_connect_anna_heatpump(self):
             "3cb70739631c4d17a86b8b12e8a5161b": {
                 "selected_schedule": "standaard",
                 "active_preset": "home",
-                "sensors": [{"id": "illuminance", "state": 86.0}],
+                "cooling_active": False,
+                "sensors": [
+                    {"id": "illuminance", "state": 86.0},
+                    {"id": "cooling_activation_outdoor_temperature", "state": 21.0},
+                    {"id": "cooling_deactivation_threshold", "state": 4},
+                ],
             },
-            # Central
+            # Heater central
             "1cbf783bb11e4a7c8a6843dee3a86927": {
                 "cooling_state": False,
                 "heating_state": True,
@@ -1578,10 +1588,12 @@ async def test_connect_anna_heatpump(self):
                     }
                 ],
                 "sensors": [
+                    {"id": "outdoor_temperature", "state": 18.0},
                     {"id": "water_temperature", "state": 29.1},
                     {"id": "water_pressure", "state": 1.57},
                 ],
             },
+            # Gateway
             "015ae9ea3f964e668e490fa39da3870b": {
                 "sensors": [{"id": "outdoor_temperature", "state": 20.2}]
             },
@@ -1599,10 +1611,11 @@ async def test_connect_anna_heatpump(self):
         _LOGGER.info(" # Assert no legacy")
         assert not smile._smile_legacy  # pylint: disable=protected-access
 
-        await self.device_test(smile, testdata)
+        await self.device_test(smile, testdata, True)
         _LOGGER.info(" # Assert master thermostat")
         assert smile._sm_thermostat
         assert self.active_device_present
+        assert self.cooling_present
         assert not self.notifications
 
         await smile.close_connection()
@@ -1617,7 +1630,12 @@ async def test_connect_anna_heatpump_cooling(self):
             "3cb70739631c4d17a86b8b12e8a5161b": {
                 "selected_schedule": None,
                 "active_preset": "home",
-                "sensors": [{"id": "illuminance", "state": 25.5}],
+                "cooling_active": True,
+                "sensors": [
+                    {"id": "illuminance", "state": 25.5},
+                    {"id": "cooling_activation_outdoor_temperature", "state": 21.0},
+                    {"id": "cooling_deactivation_threshold", "state": 6},
+                ],
             },
             # Central
             "1cbf783bb11e4a7c8a6843dee3a86927": {
@@ -1655,6 +1673,7 @@ async def test_connect_anna_heatpump_cooling(self):
         _LOGGER.info(" # Assert master thermostat")
         assert smile._sm_thermostat
         assert self.active_device_present
+        assert self.cooling_present
         assert not self.notifications
 
         await smile.close_connection()

userdata/anna_heatpump/core.appliances.xml

@@ -1015,7 +1015,7 @@
 				<unit>C</unit>
 				<last_consecutive_log_date>2020-04-09T14:12:19.497+02:00</last_consecutive_log_date>
 				<period start_date="2020-04-09T14:12:19.497+02:00" end_date="2020-04-09T14:12:19.497+02:00">
-					<measurement log_date="2020-04-09T14:12:19.497+02:00">23.30</measurement>
+					<measurement log_date="2020-04-09T14:12:19.497+02:00">3.0</measurement>
 				</period>
 				<thermo_meter id='0961c99850a942319310d93d2074127b'/>
 			</point_log>