Merge pull request #456 from plugwise/improve-2

Improve - part 2

Author: bouwew

plugwise/__init__.py

@@ -72,13 +72,13 @@ def _update_gw_devices(self) -> None:
         """
         for device_id, device in self.gw_devices.items():
             data = self._get_device_data(device_id)
-            self._add_or_update_notifications(data, device_id, device)
+            self._add_or_update_notifications(device_id, device, data)
             device.update(data)
             self._update_for_cooling(device)
             remove_empty_platform_dicts(device)
 
     def _add_or_update_notifications(
-        self, data: DeviceData, device_id: str, device: DeviceData
+        self, device_id: str, device: DeviceData, data: DeviceData
     ) -> None:
         """Helper-function adding or updating the Plugwise notifications."""
         if (
@@ -169,99 +169,83 @@ def _all_device_data(self) -> None:
             )
 
     def _device_data_switching_group(
-        self, device: DeviceData, device_data: DeviceData
-    ) -> DeviceData:
+        self, device: DeviceData, data: DeviceData
+    ) -> None:
         """Helper-function for _get_device_data().
 
         Determine switching group device data.
         """
-        if device["dev_class"] not in SWITCH_GROUP_TYPES:
-            return device_data
-
-        counter = 0
-        for member in device["members"]:
-            if self.gw_devices[member]["switches"].get("relay"):
-                counter += 1
-        device_data["switches"]["relay"] = counter != 0
-        self._count += 1
-        return device_data
+        if device["dev_class"] in SWITCH_GROUP_TYPES:
+            counter = 0
+            for member in device["members"]:
+                if self.gw_devices[member]["switches"].get("relay"):
+                    counter += 1
+            data["switches"]["relay"] = counter != 0
+            self._count += 1
 
-    def _device_data_adam(
-        self, device: DeviceData, device_data: DeviceData
-    ) -> DeviceData:
+    def _device_data_adam(self, device: DeviceData, data: DeviceData) -> None:
         """Helper-function for _get_device_data().
 
         Determine Adam heating-status for on-off heating via valves,
         available regulations_modes and thermostat control_states.
         """
-        if not self.smile(ADAM):
-            return device_data
-
-        # Indicate heating_state based on valves being open in case of city-provided heating
-        if (
-            device["dev_class"] == "heater_central"
-            and self._on_off_device
-            and isinstance(self._heating_valves(), int)
-        ):
-            device_data["binary_sensors"]["heating_state"] = self._heating_valves() != 0
-
-        # Show the allowed regulation modes for Adam
-        if device["dev_class"] == "gateway" and self._reg_allowed_modes:
-            device_data["regulation_modes"] = self._reg_allowed_modes
-            self._count += 1
-
-        # Control_state, only for Adam master thermostats
-        if device["dev_class"] in ZONE_THERMOSTATS:
-            loc_id = device["location"]
-            if ctrl_state := self._control_state(loc_id):
-                device_data["control_state"] = ctrl_state
+        if self.smile(ADAM):
+            # Indicate heating_state based on valves being open in case of city-provided heating
+            if (
+                device["dev_class"] == "heater_central"
+                and self._on_off_device
+                and isinstance(self._heating_valves(), int)
+            ):
+                data["binary_sensors"]["heating_state"] = self._heating_valves() != 0
+
+            # Show the allowed regulation modes for Adam
+            if device["dev_class"] == "gateway" and self._reg_allowed_modes:
+                data["regulation_modes"] = self._reg_allowed_modes
                 self._count += 1
 
-        return device_data
+            # Control_state, only for Adam master thermostats
+            if device["dev_class"] in ZONE_THERMOSTATS:
+                loc_id = device["location"]
+                if ctrl_state := self._control_state(loc_id):
+                    data["control_state"] = ctrl_state
+                    self._count += 1
 
-    def _device_data_climate(
-        self, device: DeviceData, device_data: DeviceData
-    ) -> DeviceData:
+    def _device_data_climate(self, device: DeviceData, data: DeviceData) -> None:
         """Helper-function for _get_device_data().
 
         Determine climate-control device data.
         """
         loc_id = device["location"]
 
         # Presets
-        device_data["preset_modes"] = None
-        device_data["active_preset"] = None
+        data["preset_modes"] = None
+        data["active_preset"] = None
         self._count += 2
         if presets := self._presets(loc_id):
-            device_data["preset_modes"] = list(presets)
-            device_data["active_preset"] = self._preset(loc_id)
+            data["preset_modes"] = list(presets)
+            data["active_preset"] = self._preset(loc_id)
 
         # Schedule
         avail_schedules, sel_schedule = self._schedules(loc_id)
-        device_data["available_schedules"] = avail_schedules
-        device_data["select_schedule"] = sel_schedule
+        data["available_schedules"] = avail_schedules
+        data["select_schedule"] = sel_schedule
         self._count += 2
 
         # Operation modes: auto, heat, heat_cool, cool and off
-        device_data["mode"] = "auto"
+        data["mode"] = "auto"
         self._count += 1
         if sel_schedule == NONE:
-            device_data["mode"] = "heat"
+            data["mode"] = "heat"
             if self._cooling_present:
-                device_data["mode"] = (
-                    "cool" if self.check_reg_mode("cooling") else "heat_cool"
-                )
+                data["mode"] = "cool" if self.check_reg_mode("cooling") else "heat_cool"
 
         if self.check_reg_mode("off"):
-            device_data["mode"] = "off"
-
-        if NONE in avail_schedules:
-            return device_data
+            data["mode"] = "off"
 
-        self._get_schedule_states_with_off(
-            loc_id, avail_schedules, sel_schedule, device_data
-        )
-        return device_data
+        if NONE not in avail_schedules:
+            self._get_schedule_states_with_off(
+                loc_id, avail_schedules, sel_schedule, data
+            )
 
     def check_reg_mode(self, mode: str) -> bool:
         """Helper-function for device_data_climate()."""
@@ -293,53 +277,53 @@ def _get_schedule_states_with_off(
             if all_off:
                 data["select_schedule"] = OFF
 
-    def _check_availability(self, device: DeviceData, device_data: DeviceData) -> None:
+    def _check_availability(
+        self, device: DeviceData, dev_class: str, data: DeviceData, message: str
+    ) -> None:
         """Helper-function for _get_device_data().
 
         Provide availability status for the wired-commected devices.
         """
-        # OpenTherm device
-        if device["dev_class"] == "heater_central" and device["name"] != "OnOff":
-            device_data["available"] = True
-            self._count += 1
-            for data in self._notifications.values():
-                for msg in data.values():
-                    if "no OpenTherm communication" in msg:
-                        device_data["available"] = False
-
-        # Smartmeter
-        if device["dev_class"] == "smartmeter":
-            device_data["available"] = True
+        if device["dev_class"] == dev_class:
+            data["available"] = True
             self._count += 1
-            for data in self._notifications.values():
-                for msg in data.values():
-                    if "P1 does not seem to be connected to a smart meter" in msg:
-                        device_data["available"] = False
+            for item in self._notifications.values():
+                for msg in item.values():
+                    if message in msg:
+                        data["available"] = False
 
     def _get_device_data(self, dev_id: str) -> DeviceData:
         """Helper-function for _all_device_data() and async_update().
 
         Provide device-data, based on Location ID (= dev_id), from APPLIANCES.
         """
         device = self.gw_devices[dev_id]
-        device_data = self._get_measurement_data(dev_id)
+        data = self._get_measurement_data(dev_id)
 
         # Check availability of non-legacy wired-connected devices
         if not self._smile_legacy:
-            self._check_availability(device, device_data)
+            # Smartmeter
+            self._check_availability(
+                device, "smartmeter", data, "P1 does not seem to be connected"
+            )
+            # OpenTherm device
+            if device["name"] != "OnOff":
+                self._check_availability(
+                    device, "heater_central", data, "no OpenTherm communication"
+                )
 
         # Switching groups data
-        device_data = self._device_data_switching_group(device, device_data)
+        self._device_data_switching_group(device, data)
         # Adam data
-        device_data = self._device_data_adam(device, device_data)
+        self._device_data_adam(device, data)
         # Skip obtaining data for non master-thermostats
         if device["dev_class"] not in ZONE_THERMOSTATS:
-            return device_data
+            return data
 
         # Thermostat data (presets, temperatures etc)
-        device_data = self._device_data_climate(device, device_data)
+        self._device_data_climate(device, data)
 
-        return device_data
+        return data
 
 
 class Smile(SmileComm, SmileData):