Merge pull request #110 from plugwise/cooling_function

Various updates and improvements

Author: bouwew

CHANGELOG.md

@@ -1,9 +1,19 @@
 # Changelog
 
-## In progress
+# 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
+  - Adam: collect `allowed_modes` and look for `cooling`, indicating cooling capability being available
+  - Optimize code: use `_all_appliances()` once instead of 3 times, by updating/changing `single_master_thermostat()`,
+  - Protect several more variables,
+  - Change/improve how `illuminance` and `outdoor_temperature` are obtained,
+  - Use walrus operator where applicable,
+  - Various small code improvements,
+  - Add and adapt testcode
   - Add testing for python 3.10, improve dependencies (github workflow)
   - Bump aiohttp to 3.8.1, remove fixed dependencies
 
+# v0.15.5 - Skipping, not released
+
 ## 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

plugwise/__init__.py

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

plugwise/constants.py

@@ -19,7 +19,10 @@
 PRESSURE_BAR = "bar"
 SIGNAL_STRENGTH_DECIBELS_MILLIWATT = "dBm"
 TEMP_CELSIUS = "°C"
+TEMP_KELVIN = "°K"
 TIME_MILLISECONDS = "ms"
+UNIT = "unit"
+UNIT_LUMEN = "lm"
 VOLUME_CUBIC_METERS = "m³"
 VOLUME_CUBIC_METERS_PER_HOUR = "m³/h"
 
@@ -388,10 +391,6 @@
         ATTR_TYPE: "gas",
         ATTR_UNIT_OF_MEASUREMENT: VOLUME_CUBIC_METERS,
     },
-    "outdoor_temperature": {
-        ATTR_TYPE: "temperature",
-        ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS,
-    },
 }
 
 # Excluded:
@@ -402,6 +401,7 @@
     "temperature": {ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
     # HA Core setpoint
     "thermostat": {ATTR_NAME: "setpoint", ATTR_UNIT_OF_MEASUREMENT: TEMP_CELSIUS},
+    "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
@@ -511,9 +511,6 @@
 ATTR_ENABLED = "enabled_default"
 ATTR_ID = "id"
 ATTR_ICON = "icon"
-TEMP_KELVIN = "°K"
-UNIT = "unit"
-UNIT_LUMEN = "lm"
 
 EXTRA_STATE_ATTRIBS = {}
 

plugwise/helper.py

@@ -86,11 +86,12 @@ def update_device_state(data, d_dict):
     _heating_state = False
     state = "idle"
 
-    for _, item in enumerate(d_dict["binary_sensors"]):
-        if item[ATTR_ID] == "dhw_state":
-            if item[ATTR_STATE]:
-                state = "dhw-heating"
-                _dhw_state = True
+    if "binary_sensors" in d_dict:
+        for _, item in enumerate(d_dict["binary_sensors"]):
+            if item[ATTR_ID] == "dhw_state":
+                if item[ATTR_STATE]:
+                    state = "dhw-heating"
+                    _dhw_state = True
 
     if "heating_state" in data:
         if data["heating_state"]:
@@ -168,10 +169,6 @@ def types_finder(data):
         locator = f".//logs/point_log[type='{measure}']"
         if data.find(locator) is not None:
             log = data.find(locator)
-
-            if measure == "outdoor_temperature":
-                types.add(attrs[ATTR_TYPE])
-
             p_locator = ".//electricity_point_meter"
             if log.find(p_locator) is not None:
                 if log.find(p_locator).get("id"):
@@ -403,8 +400,8 @@ def _get_module_data(self, appliance, locator, mod_type):
         appl_search = appliance.find(locator)
         if appl_search is not None:
             link_id = appl_search.attrib["id"]
-            module = self._modules.find(f".//{mod_type}[@id='{link_id}']....")
-            if module is not None:
+            locator = f".//{mod_type}[@id='{link_id}']...."
+            if (module := self._modules.find(locator)) is not None:
                 v_name = module.find("vendor_name").text
                 v_model = module.find("vendor_model").text
                 hw_version = module.find("hardware_version").text
@@ -447,6 +444,16 @@ def _appliance_info_finder(self, appliance, appl):
             appl.fw = self.smile_version[0]
             appl.model = appl.name = self.smile_name
             appl.v_name = "Plugwise B.V."
+
+            # Adam: check for cooling capability, assume heating capability is always present
+            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
+
             return appl
 
         if appl.pwclass in THERMOSTAT_CLASSES:
@@ -621,14 +628,15 @@ def _presets_legacy(self):
     def _presets(self, loc_id):
         """Collect Presets for a Thermostat based on location_id."""
         presets = {}
-        tag = "zone_setpoint_and_state_based_on_preset"
+        tag_1 = "zone_setpoint_and_state_based_on_preset"
+        tag_2 = "Thermostat presets"
 
         if self._smile_legacy:
             return self._presets_legacy()
 
-        rule_ids = self._rule_ids_by_tag(tag, loc_id)
-        if rule_ids is None:
-            rule_ids = self._rule_ids_by_name("Thermostat presets", loc_id)
+        if not (rule_ids := self._rule_ids_by_tag(tag_1, loc_id)):
+            if not (rule_ids := self._rule_ids_by_name(tag_2, loc_id)):
+                return presets
 
         for rule_id in rule_ids:
             directives = self._domain_objects.find(f'rule[@id="{rule_id}"]/directives')
@@ -656,8 +664,7 @@ def _rule_ids_by_name(self, name, loc_id):
             if rule.find(locator) is not None:
                 schema_ids[rule.attrib["id"]] = loc_id
 
-        if schema_ids != {}:
-            return schema_ids
+        return schema_ids
 
     def _rule_ids_by_tag(self, tag, loc_id):
         """Helper-function for _presets(), _schemas() and _last_active_schema().
@@ -671,13 +678,11 @@ def _rule_ids_by_tag(self, tag, loc_id):
                 if rule.find(locator2) is not None:
                     schema_ids[rule.attrib["id"]] = loc_id
 
-        if schema_ids != {}:
-            return schema_ids
+        return schema_ids
 
     def _appliance_measurements(self, appliance, data, measurements):
         """Helper-function for _get_appliance_data() - collect appliance measurement data."""
         for measurement, attrs in measurements:
-
             p_locator = f'.//logs/point_log[type="{measurement}"]/period/measurement'
             if appliance.find(p_locator) is not None:
                 if self._smile_legacy:
@@ -720,12 +725,7 @@ def _get_appliance_data(self, d_id):
         if self._smile_legacy and self.smile_type == "power":
             return data
 
-        search = self._appliances
-        if self._smile_legacy and self.smile_type != "stretch":
-            search = self._domain_objects
-
-        appliances = search.findall(f'.//appliance[@id="{d_id}"]')
-
+        appliances = self._appliances.findall(f'.//appliance[@id="{d_id}"]')
         for appliance in appliances:
             measurements = DEVICE_MEASUREMENTS.items()
             if self._active_device_present:
@@ -735,7 +735,6 @@ def _get_appliance_data(self, d_id):
                 }.items()
 
             data = self._appliance_measurements(appliance, data, measurements)
-
             data.update(self._get_lock_state(appliance))
 
         # Fix for Adam + Anna: heating_state also present under Anna, remove
@@ -918,8 +917,7 @@ def _power_data_peak_value(self, loc):
             loc.found = False
             return loc
 
-        peak = loc.peak_select.split("_")[1]
-        if peak == "offpeak":
+        if (peak := loc.peak_select.split("_")[1]) == "offpeak":
             peak = "off_peak"
         log_found = loc.log_type.split("_")[0]
         loc.key_string = f"{loc.measurement}_{peak}_{log_found}"
@@ -941,22 +939,17 @@ def _power_data_from_location(self, loc_id):
         direct_data = {}
         loc = Munch()
 
-        search = self._domain_objects
-        t_string = "tariff"
-        if self.smile_type == "power":
-            # P1: use data from LOCATIONS
-            search = self._locations
-            if self._smile_legacy:
-                t_string = "tariff_indicator"
-
-        loc.logs = search.find(f'.//location[@id="{loc_id}"]/logs')
-
-        if loc.logs is None:
+        if self.smile_type != "power":
             return
 
+        search = self._locations
         log_list = ["point_log", "cumulative_log", "interval_log"]
         peak_list = ["nl_peak", "nl_offpeak"]
+        t_string = "tariff"
+        if self._smile_legacy:
+            t_string = "tariff_indicator"
 
+        loc.logs = search.find(f'.//location[@id="{loc_id}"]/logs')
         # meter_string = ".//{}[type='{}']/"
         for loc.measurement, loc.attrs in HOME_MEASUREMENTS.items():
             for loc.log_type in log_list:
@@ -965,19 +958,16 @@ def _power_data_from_location(self, loc_id):
                         f'.//{loc.log_type}[type="{loc.measurement}"]/period/'
                         f'measurement[@{t_string}="{loc.peak_select}"]'
                     )
-
                     loc = self._power_data_peak_value(loc)
                     if not loc.found:
                         continue
 
                     direct_data = power_data_energy_diff(
                         loc.measurement, loc.net_string, loc.f_val, direct_data
                     )
-
                     direct_data[loc.key_string] = loc.f_val
 
-        if direct_data != {}:
-            return direct_data
+        return direct_data
 
     def _preset(self, loc_id):
         """Helper-function for smile.py: device_data_climate().
@@ -1007,8 +997,7 @@ def _schemas_legacy(self):
         selected = None
 
         for schema in self._domain_objects.findall(".//rule"):
-            rule_name = schema.find("name").text
-            if rule_name:
+            if rule_name := schema.find("name").text:
                 if "preset" not in rule_name:
                     name = rule_name
 
@@ -1040,9 +1029,7 @@ def _schemas(self, loc_id):
 
         # Current schemas
         tag = "zone_preset_based_on_time_and_presence_with_override"
-        rule_ids = self._rule_ids_by_tag(tag, loc_id)
-
-        if rule_ids is None:
+        if not (rule_ids := self._rule_ids_by_tag(tag, loc_id)):
             return available, selected, schedule_temperature
 
         for rule_id, dummy in rule_ids.items():
@@ -1082,8 +1069,7 @@ def _last_active_schema(self, loc_id):
 
         tag = "zone_preset_based_on_time_and_presence_with_override"
 
-        rule_ids = self._rule_ids_by_tag(tag, loc_id)
-        if rule_ids is None:
+        if not (rule_ids := self._rule_ids_by_tag(tag, loc_id)):
             return
 
         for rule_id, dummy in rule_ids.items():
@@ -1099,14 +1085,13 @@ def _last_active_schema(self, loc_id):
 
         return last_modified
 
-    def _object_value(self, obj_type, obj_id, measurement):
+    def _object_value(self, obj_id, measurement):
         """Helper-function for smile.py: _get_device_data() and _device_data_anna().
         Obtain the value/state for the given object.
         """
         search = self._domain_objects
-
         locator = (
-            f'.//{obj_type}[@id="{obj_id}"]/logs/point_log'
+            f'.//location[@id="{obj_id}"]/logs/point_log'
             f'[type="{measurement}"]/period/measurement'
         )
         if search.find(locator) is not None: