Merge pull request #109 from plugwise/removed_thermostat

Detect removed thermostats

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.15.4 - Smile - Bugfix: handle removed thermostats
+  - Recognize when a thermostat has been removed from a zone and don't show it in Core
+  - Rename Group Switch to Switchgroup, remove vendor name
+
 ## v0.15.3 - Skipping, not released
 
 ## v0.15.2 - Smile: Implement possible fix for HA Core issue #59711

plugwise/__init__.py

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

plugwise/constants.py

@@ -365,6 +365,7 @@
 DEFAULT_TIMEOUT = 30
 DEFAULT_USERNAME = "smile"
 DEFAULT_PORT = 80
+FAKE_LOC = "0000aaaa0000aaaa0000aaaa0000aa00"
 
 SEVERITIES = ["other", "info", "warning", "error"]
 SWITCH_GROUP_TYPES = ["switching", "report"]
@@ -396,8 +397,6 @@
 # Excluded:
 # zone_thermosstat 'temperature_offset'
 # radiator_valve 'uncorrected_temperature', 'temperature_offset'
-
-
 DEVICE_MEASUREMENTS = {
     # HA Core current_temperature
     "temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},

plugwise/helper.py

@@ -29,6 +29,7 @@
     DOMAIN_OBJECTS,
     ENERGY_KILO_WATT_HOUR,
     ENERGY_WATT_HOUR,
+    FAKE_LOC,
     FLAME_ICON,
     HEATER_CENTRAL_MEASUREMENTS,
     HEATING_ICON,
@@ -314,20 +315,20 @@ def _locations_legacy(self):
         Create locations for legacy devices.
         """
         appliances = set()
-        self._home_location = 0
+        self._home_location = FAKE_LOC
 
         # Add Anna appliances
         for appliance in self._appliances.findall("./appliance"):
             appliances.add(appliance.attrib["id"])
 
         if self.smile_type == "thermostat":
-            self._loc_data[0] = {
+            self._loc_data[FAKE_LOC] = {
                 "name": "Legacy Anna",
                 "types": {"temperature"},
                 "members": appliances,
             }
         if self.smile_type == "stretch":
-            self._loc_data[0] = {
+            self._loc_data[FAKE_LOC] = {
                 "name": "Legacy Stretch",
                 "types": {"power"},
                 "members": appliances,
@@ -421,7 +422,7 @@ def _energy_device_info_finder(self, appliance, appl):
             mod_type = "electricity_point_meter"
             module_data = self._get_module_data(appliance, locator, mod_type)
             appl.v_name = module_data[0]
-            if appl.model != "Group Switch":
+            if appl.model != "Switchgroup":
                 appl.model = None
             if module_data[2] is not None:
                 hw_version = module_data[2].replace("-", "")
@@ -492,7 +493,11 @@ def _appliance_types_finder(self, appliance, appl):
             for appl_type in types_finder(appliance):
                 appl.types.add(appl_type)
         else:
-            # Preset all types applicable to home
+            # Provide a home_location for legacy_anna, preset all types applicable to home
+            if self._smile_legacy and self.smile_type == "thermostat":
+                appl.location = self._home_location
+                # For legacy_anna gateway and heater_central is the same device
+                self.gateway_id = self._heater_id
             appl.types = self._loc_data[self._home_location]["types"]
 
         # Determine appliance_type from functionality
@@ -583,10 +588,6 @@ def _all_appliances(self):
             ):
                 self._appl_data.pop(appl.id)
 
-        # For legacy Anna gateway and heater_central is the same device
-        if self._smile_legacy and self.smile_type == "thermostat":
-            self.gateway_id = self._heater_id
-
     def _match_locations(self):
         """Helper-function for _scan_thermostats().
         Update locations with present appliance-types.
@@ -835,7 +836,7 @@ def _group_switches(self):
         Collect switching- or pump-group info.
         """
         switch_groups = {}
-        # P1 and Anna don't have switch groups
+        # P1 and Anna don't have switchgroups
         if self.smile_type == "power" or self.smile_name == "Anna":
             return switch_groups
 
@@ -867,11 +868,11 @@ def _group_switches(self):
                     "class": group_type,
                     "fw": None,
                     "location": None,
-                    "members": members,
-                    "model": "Group Switch",
+                    "model": "Switchgroup",
                     "name": group_name,
+                    "members": members,
                     "types": {"switch_group"},
-                    "vendor": "Plugwise",
+                    "vendor": None,
                 }
 
             switch_groups.update(group_appl)

plugwise/smile.py

@@ -56,7 +56,7 @@ def _append_special(self, data, d_id, bs_list, s_list):
                 bs_list.append(PW_NOTIFICATION)
             if not self._active_device_present and "heating_state" in data:
                 s_list.append(DEVICE_STATE)
-        if d_id == self._heater_id and self.single_master_thermostat() is False:
+        if d_id == self._heater_id and self.single_master_thermostat() is not None:
             s_list.append(DEVICE_STATE)
 
     def _all_device_data(self):
@@ -100,7 +100,8 @@ def get_all_devices(self):
 
         for appliance, details in self._appl_data.items():
             loc_id = details["location"]
-            if loc_id is None:
+            # Don't assign the _home_location to thermostat-devices without a location, they are not active
+            if loc_id is None and details["class"] not in THERMOSTAT_CLASSES:
                 details["location"] = self._home_location
 
             # Override slave thermostat class
@@ -109,7 +110,9 @@ def get_all_devices(self):
                     if appliance in self._thermo_locs[loc_id]["slaves"]:
                         details["class"] = "thermo_sensor"
 
-            self._devices[appliance] = details
+            # Filter for thermostat-devices without a location
+            if details["location"] is not None:
+                self._devices[appliance] = details
 
         group_data = self._group_switches()
         if group_data is not None:

tests/test_smile.py

@@ -380,6 +380,8 @@ async def device_test(self, smile=pw_smile.Smile, testdata=None):
 
         _LOGGER.info("Gateway id = %s", extra["gateway_id"])
         _LOGGER.info("Hostname = %s", smile.smile_hostname)
+        _LOGGER.info("Extra = %s", extra)
+        _LOGGER.info("Device list = %s", device_list)
         self.show_setup(location_list, device_list)
 
         tests = 0
@@ -548,7 +550,6 @@ async def test_connect_legacy_anna(self):
                 "available_schedules": ["Thermostat schedule"],
                 "selected_schedule": "Thermostat schedule",
                 "last_used": "Thermostat schedule",
-                "location": 0,
                 "presets": {
                     "asleep": [19.0, 0],
                     "away": [19.0, 0],
@@ -566,13 +567,15 @@ async def test_connect_legacy_anna(self):
             },
             # Central
             "04e4cbfe7f4340f090f85ec3b9e6a950": {
+                "location": pw_constants.FAKE_LOC,
                 "heating_state": True,
                 "sensors": [
                     {"id": "water_temperature", "state": 23.6},
                     {"id": "intended_boiler_temperature", "state": 17.0},
                     {"id": "modulation_level", "state": 0.0},
                     {"id": "return_temperature", "state": 21.7},
                     {"id": "water_pressure", "state": 1.2},
+                    {"id": "device_state", "state": "heating"},
                 ],
             },
         }
@@ -784,6 +787,7 @@ async def test_connect_anna_v4(self):
                 "sensors": [
                     {"id": "water_pressure", "state": 2.1},
                     {"id": "water_temperature", "state": 52.0},
+                    {"id": "device_state", "state": "heating"},
                 ],
             },
             "0466eae8520144c78afb29628384edeb": {
@@ -1001,12 +1005,8 @@ async def test_connect_adam_plus_anna(self):
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
                 "heating_state": False,
-                "binary_sensors": [
-                    {
-                        "id": "flame_state",
-                        "state": False,
-                    }
-                ],
+                "binary_sensors": [{"id": "flame_state", "state": False}],
+                "sensors": [{"id": "device_state", "state": "idle"}],
             },
             "b128b4bbbd1f47e9bf4d756e8fb5ee94": {
                 "sensors": [{"id": "outdoor_temperature", "state": 11.9}]
@@ -1070,12 +1070,8 @@ async def test_connect_adam_plus_anna_new(self):
         testdata = {
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
-                "binary_sensors": [
-                    {
-                        "id": "dhw_state",
-                        "state": True,
-                    }
-                ]
+                "binary_sensors": [{"id": "dhw_state", "state": True}],
+                "sensors": [{"id": "device_state", "state": "dhw-heating"}],
             },
             # Test Switch
             "b83f9f9758064c0fab4af6578cba4c6d": {
@@ -1126,12 +1122,8 @@ async def test_connect_adam_plus_anna_new_copy_dhw_and_heating(self):
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
                 "heating_state": True,
-                "binary_sensors": [
-                    {
-                        "id": "dhw_state",
-                        "state": True,
-                    }
-                ],
+                "binary_sensors": [{"id": "dhw_state", "state": True}],
+                "sensors": [{"id": "device_state", "state": "dhw and heating"}],
             }
         }
 
@@ -1150,6 +1142,7 @@ async def test_connect_adam_plus_anna_new_copy_cooling(self):
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
                 "cooling_state": True,
+                "sensors": [{"id": "device_state", "state": "cooling"}],
             },
         }
 
@@ -1168,12 +1161,8 @@ async def test_connect_adam_plus_anna_new_copy_dhw_and_cooling(self):
             # Central
             "2743216f626f43948deec1f7ab3b3d70": {
                 "cooling_state": True,
-                "binary_sensors": [
-                    {
-                        "id": "dhw_state",
-                        "state": True,
-                    }
-                ],
+                "binary_sensors": [{"id": "dhw_state", "state": True}],
+                "sensors": [{"id": "device_state", "state": "dhw and cooling"}],
             }
         }
 
@@ -1232,6 +1221,7 @@ async def test_connect_adam_zone_per_device(self):
                 ],
                 "sensors": [
                     {"id": "outdoor_temperature", "state": 7.69},
+                    {"id": "device_state", "state": "idle"},
                 ],
             },
             # Modem
@@ -1346,6 +1336,7 @@ async def test_connect_adam_multiple_devices_per_zone(self):
                 "heating_state": True,
                 "sensors": [
                     {"id": "outdoor_temperature", "state": 7.81},
+                    {"id": "device_state", "state": "heating"},
                 ],
             },
             # Modem