Merge pull request #162 from plugwise/anna_fix

Anna fix

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+# v0.16.8 - Smile: bugfixes, continued
+- Fix for https://github.com/home-assistant/core/issues/68003
+- Refix solution for #158 
+
 # v0.16.7 - Smile: Bugfixes, more changes and improvements
 - Fix for #158: error setting up for systems with an Anna and and Elga (heatpump).
 - Block connecting to the Anna when an Adam is present (fixes pw-beta #231).

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.16.8a1"
+__version__ = "0.16.8"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -437,7 +437,7 @@
     # Added measurements from actuator_functionalities/thermostat_functionality
     "lower_bound": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     "upper_bound": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
-    "resolution": {ATTR_UNIT_OF_MEASUREMENT: None},
+    "resolution": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
 }
 
 # Heater Central related measurements

plugwise/helper.py

@@ -290,6 +290,9 @@ def __init__(self):
         """Set the constructor for this class."""
         self._appl_data: dict[str, Any] = {}
         self._appliances: etree | None = None
+        self._anna_cooling_present: bool = False
+        self._cooling_activation_outdoor_temp: float | None = None
+        self._cooling_deactivation_threshold: float | None = None
         self._cooling_present = False
         self._devices: dict[str, str] = {}
         self._domain_objects: etree | None = None
@@ -816,7 +819,13 @@ def _appliance_measurements(
                     appl_p_loc.text, attrs.get(ATTR_UNIT_OF_MEASUREMENT)
                 )
 
-                # Anna: use the local outdoor temperature as reference for turning cooling on/off
+                # Anna: save cooling-related measurements for later use
+                # Use the local outdoor temperature as reference for turning cooling on/off
+                if measurement == "cooling_activation_outdoor_temperature":
+                    self._anna_cooling_present = self._cooling_present = True
+                    self._cooling_activation_outdoor_temp = data.get(measurement)
+                if measurement == "cooling_deactivation_threshold":
+                    self._cooling_deactivation_threshold = data.get(measurement)
                 if measurement == "outdoor_temperature":
                     self._outdoor_temp = data.get(measurement)
 
@@ -838,7 +847,7 @@ def _appliance_measurements(
                     continue
 
                 data[measurement] = format_measure(
-                    t_function.text, attrs[ATTR_UNIT_OF_MEASUREMENT]
+                    t_function.text, attrs.get(ATTR_UNIT_OF_MEASUREMENT)
                 )
 
         return data

plugwise/smile.py

@@ -91,6 +91,20 @@ def get_all_devices(self) -> None:
         # Collect data for each device via helper function
         self._all_device_data()
 
+        # Anna: indicate possible active heating/cooling operation-mode
+        # Actual ongoing heating/cooling is shown via heating_state/cooling_state
+        if self._anna_cooling_present:
+            if (
+                not self.cooling_active
+                and self._outdoor_temp > self._cooling_activation_outdoor_temp
+            ):
+                self.cooling_active = True
+            if (
+                self.cooling_active
+                and self._outdoor_temp < self._cooling_deactivation_threshold
+            ):
+                self.cooling_active = False
+
         # Don't show cooling_state when no cooling present
         for _, device in self.gw_devices.items():
             if (
@@ -161,19 +175,6 @@ def _device_data_climate(
         if ctrl_state := self._control_state(loc_id):
             device_data["control_state"] = ctrl_state
 
-        # 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:
-            self._cooling_present = True
-            if not self.cooling_active and self._outdoor_temp > device_data.get(
-                "cooling_activation_outdoor_temperature"
-            ):
-                self.cooling_active = True
-            if self.cooling_active and self._outdoor_temp < device_data.get(
-                "cooling_deactivation_threshold"
-            ):
-                self.cooling_active = False
-
         # Operation mode: auto, heat, cool
         device_data["mode"] = "auto"
         if sel_schema == "None":

plugwise/util.py

@@ -18,6 +18,7 @@
     LOGADDR_OFFSET,
     PERCENTAGE,
     PLUGWISE_EPOCH,
+    TEMP_CELSIUS,
     UTF8_DECODE,
     VOLUME_CUBIC_METERS,
 )
@@ -98,6 +99,8 @@ def format_measure(measure: str, unit: str) -> float | int | bool:
     """Format measure to correct type."""
     try:
         measure = int(measure)
+        if unit == TEMP_CELSIUS:
+            measure = float(measure)
     except ValueError:
         if unit == PERCENTAGE:
             if 0 < float(measure) <= 1:

tests/test_smile.py

@@ -250,9 +250,7 @@ async def connect(
         client = aiohttp.test_utils.TestClient(server)
         websession = client.session
 
-        url = "{}://{}:{}/core/locations".format(
-            server.scheme, server.host, server.port
-        )
+        url = f"{server.scheme}://{server.host}:{server.port}/core/locations"
 
         # Try/exceptpass to accommodate for Timeout of aoihttp
         try:
@@ -376,15 +374,11 @@ def show_setup(location_list, device_list):
                 assert False
 
     @pytest.mark.asyncio
-    async def device_test(self, smile=pw_smile.Smile, testdata=None, preset=False):
+    async def device_test(self, smile=pw_smile.Smile, testdata=None):
         """Perform basic device tests."""
         _LOGGER.info("Asserting testdata:")
         bsw_list = ["binary_sensors", "central", "climate", "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]
@@ -426,9 +420,7 @@ async def device_test(self, smile=pw_smile.Smile, testdata=None, preset=False):
                     for measure_key, measure_assert in measurements.items():
                         _LOGGER.info(
                             "%s",
-                            "  + Testing {} (should be {})".format(
-                                measure_key, measure_assert
-                            ),
+                            f"  + Testing {measure_key} (should be {measure_assert})",
                         )
                         tests += 1
                         if measure_key in bsw_list:
@@ -2151,7 +2143,7 @@ async def test_connect_anna_heatpump(self):
         assert not smile._smile_legacy
 
         # Preset cooling_active to True, will turn to False due to the lowered outdoor temp
-        await self.device_test(smile, testdata, True)
+        await self.device_test(smile, testdata)
         assert self.cooling_present
         assert not self.notifications
 
@@ -2160,7 +2152,12 @@ async def test_connect_anna_heatpump(self):
 
     @pytest.mark.asyncio
     async def test_connect_anna_heatpump_cooling(self):
-        """Test a Anna with Elga setup in cooling mode."""
+        """
+        Test an Anna with Elga setup in cooling mode.
+        This test also covers the situation that the operation-mode it switched
+        from heating to cooliing due to the outdoor temperature rising above the
+        cooling_activation_outdoor_temperature threshold.
+        """
         testdata = {
             # Anna
             "3cb70739631c4d17a86b8b12e8a5161b": {
@@ -2211,6 +2208,153 @@ async def test_connect_anna_heatpump_cooling(self):
         await smile.close_connection()
         await self.disconnect(server, client)
 
+    @pytest.mark.asyncio
+    async def test_connect_anna_heatpump_cooling_to_off(self):
+        """
+        This test covers the situation that the operation-mode it switched back
+        from cooling to heating due to the outdoor temperature dropping below the
+        cooling_deactivation_threshold.
+        """
+        testdata = {
+            # Anna
+            "3cb70739631c4d17a86b8b12e8a5161b": {
+                "selected_schedule": "None",
+                "active_preset": "home",
+                "mode": "heat",
+                "sensors": {
+                    "illuminance": 25.5,
+                    "cooling_activation_outdoor_temperature": 21.0,
+                    "cooling_deactivation_threshold": 6,
+                },
+            },
+            # Heater central
+            "1cbf783bb11e4a7c8a6843dee3a86927": {
+                "binary_sensors": {
+                    "cooling_state": False,
+                    "dhw_state": False,
+                    "heating_state": False,
+                },
+                "sensors": {
+                    "outdoor_temperature": 3.0,
+                    "water_temperature": 24.7,
+                    "water_pressure": 1.61,
+                },
+            },
+            # Gateway
+            "015ae9ea3f964e668e490fa39da3870b": {
+                "sensors": {"outdoor_temperature": 22.0}
+            },
+        }
+
+        self.smile_setup = "anna_heatpump_cooling_to_off"
+        server, smile, client = await self.connect_wrapper()
+
+        smile.cooling_active = True
+        await self.device_test(smile, testdata)
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
+    @pytest.mark.asyncio
+    async def test_connect_anna_elga_2(self):
+        """Test a Anna with Elga setup in cooling mode (with missing outdoor temperature - solved)."""
+        testdata = {
+            # Anna
+            "ebd90df1ab334565b5895f37590ccff4": {
+                "class": "thermostat",
+                "fw": "2018-02-08T11:15:53+01:00",
+                "hw": "6539-1301-5002",
+                "location": "d3ce834534114348be628b61b26d9220",
+                "mac_address": None,
+                "model": "Anna",
+                "name": "Anna",
+                "vendor": "Plugwise",
+                "lower_bound": 4,
+                "upper_bound": 30,
+                "resolution": 0.1,
+                "preset_modes": ["away", "no_frost", "vacation", "home", "asleep"],
+                "active_preset": "home",
+                "presets": {
+                    "away": [15.0, 25.0],
+                    "no_frost": [10.0, 30.0],
+                    "vacation": [15.0, 27.0],
+                    "home": [19.5, 23.0],
+                    "asleep": [19.0, 23.0],
+                },
+                "available_schedules": ["Thermostat schedule"],
+                "selected_schedule": "Thermostat schedule",
+                "last_used": "Thermostat schedule",
+                "schedule_temperature": 19.5,
+                "mode": "auto",
+                "sensors": {
+                    "temperature": 20.9,
+                    "setpoint": 19.5,
+                    "illuminance": 0.5,
+                    "cooling_activation_outdoor_temperature": 26.0,
+                    "cooling_deactivation_threshold": 3,
+                },
+            },
+            # Heater central
+            "573c152e7d4f4720878222bd75638f5b": {
+                "class": "heater_central",
+                "fw": None,
+                "hw": None,
+                "location": "d34dfe6ab90b410c98068e75de3eb631",
+                "mac_address": None,
+                "model": "Generic heater",
+                "name": "OpenTherm",
+                "vendor": "Techneco",
+                "compressor_state": False,
+                "binary_sensors": {
+                    "dhw_state": False,
+                    "heating_state": False,
+                    "cooling_state": False,
+                    "slave_boiler_state": False,
+                    "flame_state": False,
+                },
+                "sensors": {
+                    "outdoor_temperature": 14.0,
+                    "water_temperature": 22.8,
+                    "intended_boiler_temperature": 0.0,
+                    "modulation_level": 0.0,
+                    "return_temperature": 23.4,
+                    "water_pressure": 0.5,
+                },
+                "switches": {"dhw_cm_switch": True},
+            },
+            # Gateway
+            "fb49af122f6e4b0f91267e1cf7666d6f": {
+                "class": "gateway",
+                "fw": "4.2.1",
+                "hw": "AME Smile 2.0 board",
+                "location": "d34dfe6ab90b410c98068e75de3eb631",
+                "mac_address": "C4930002FE76",
+                "model": "Anna",
+                "name": "Anna",
+                "vendor": "Plugwise B.V.",
+                "binary_sensors": {"plugwise_notification": False},
+                "sensors": {"outdoor_temperature": 13.0},
+            },
+        }
+
+        self.smile_setup = "anna_elga_2"
+        server, smile, client = await self.connect_wrapper()
+        assert smile.smile_hostname == "smile000000"
+
+        _LOGGER.info("Basics:")
+        _LOGGER.info(" # Assert type = thermostat")
+        assert smile.smile_type == "thermostat"
+        _LOGGER.info(" # Assert version")
+        assert smile.smile_version[0] == "4.2.1"
+        _LOGGER.info(" # Assert no legacy")
+        assert not smile._smile_legacy
+
+        await self.device_test(smile, testdata)
+        assert self.cooling_present
+        assert not self.notifications
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
     @pytest.mark.asyncio
     async def test_connect_adam_plus_anna_copy_with_error_domain_added(self):
         """Test erroneous domain_objects file from user."""
@@ -2233,7 +2377,7 @@ async def test_connect_adam_plus_anna_copy_with_error_domain_added(self):
         _LOGGER.info(" # Assert legacy")
         assert not smile._smile_legacy
 
-        await self.device_test(smile, testdata, True)
+        await self.device_test(smile, testdata)
 
         assert "3d28a20e17cb47dca210a132463721d5" in self.notifications