plugwise 1.5.1a3__py3-none-any.whl → 1.6.0__py3-none-any.whl

plugwise/data.py

@@ -13,9 +13,8 @@ from plugwise.constants import (
     MIN_SETPOINT,
     NONE,
     OFF,
-    ZONE_THERMOSTATS,
     ActuatorData,
-    DeviceData,
+    GwEntityData,
 )
 from plugwise.helper import SmileHelper
 from plugwise.util import remove_empty_platform_dicts
@@ -29,12 +28,16 @@ class SmileData(SmileHelper):
         SmileHelper.__init__(self)
 
 
-    def _all_device_data(self) -> None:
-        """Helper-function for get_all_devices().
+    def _all_entity_data(self) -> None:
+        """Helper-function for get_all_gateway_entities().
 
-        Collect data for each device and add to self.gw_data and self.gw_devices.
+        Collect data for each entity and add to self.gw_data and self.gw_entities.
         """
-        self._update_gw_devices()
+        self._update_gw_entities()
+        if self.smile(ADAM):
+            self._update_zones()
+            self.gw_entities.update(self._zones)
+
         self.gw_data.update(
             {
                 "gateway_id": self.gateway_id,
@@ -49,31 +52,40 @@ class SmileData(SmileHelper):
                 {"heater_id": self._heater_id, "cooling_present": self._cooling_present}
             )
 
-    def _update_gw_devices(self) -> None:
-        """Helper-function for _all_device_data() and async_update().
+    def _update_zones(self) -> None:
+        """Helper-function for _all_entity_data() and async_update().
+
+        Collect data for each zone/location and add to self._zones.
+        """
+        for location_id, zone in self._zones.items():
+            data = self._get_location_data(location_id)
+            zone.update(data)
+
+    def _update_gw_entities(self) -> None:
+        """Helper-function for _all_entities_data() and async_update().
 
-        Collect data for each device and add to self.gw_devices.
+        Collect data for each entity and add to self.gw_entities.
         """
         mac_list: list[str] = []
-        for device_id, device in self.gw_devices.items():
-            data = self._get_device_data(device_id)
-            if device_id == self.gateway_id:
+        for entity_id, entity in self.gw_entities.items():
+            data = self._get_entity_data(entity_id)
+            if entity_id == self.gateway_id:
                 mac_list = self._detect_low_batteries()
-                self._add_or_update_notifications(device_id, device, data)
+                self._add_or_update_notifications(entity_id, entity, data)
 
-            device.update(data)
+            entity.update(data)
             is_battery_low = (
                 mac_list
-                and "low_battery" in device["binary_sensors"]
-                and device["zigbee_mac_address"] in mac_list
-                and device["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve", "zone_thermometer", "zone_thermostat")
+                and "low_battery" in entity["binary_sensors"]
+                and entity["zigbee_mac_address"] in mac_list
+                and entity["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve", "zone_thermometer", "zone_thermostat")
             )
             if is_battery_low:
-                device["binary_sensors"]["low_battery"] = True
+                entity["binary_sensors"]["low_battery"] = True
 
-            self._update_for_cooling(device)
+            self._update_for_cooling(entity)
 
-            remove_empty_platform_dicts(device)
+            remove_empty_platform_dicts(entity)
 
     def _detect_low_batteries(self) -> list[str]:
         """Helper-function updating the low-battery binary_sensor status from a Battery-is-low message."""
@@ -97,31 +109,31 @@ class SmileData(SmileHelper):
         return mac_address_list
 
     def _add_or_update_notifications(
-        self, device_id: str, device: DeviceData, data: DeviceData
+        self, entity_id: str, entity: GwEntityData, data: GwEntityData
     ) -> None:
         """Helper-function adding or updating the Plugwise notifications."""
         if (
-            device_id == self.gateway_id
+            entity_id == self.gateway_id
             and (
                 self._is_thermostat or self.smile_type == "power"
             )
         ) or (
-            "binary_sensors" in device
-            and "plugwise_notification" in device["binary_sensors"]
+            "binary_sensors" in entity
+            and "plugwise_notification" in entity["binary_sensors"]
         ):
             data["binary_sensors"]["plugwise_notification"] = bool(self._notifications)
             self._count += 1
 
-    def _update_for_cooling(self, device: DeviceData) -> None:
+    def _update_for_cooling(self, entity: GwEntityData) -> None:
         """Helper-function for adding/updating various cooling-related values."""
         # For Anna and heating + cooling, replace setpoint with setpoint_high/_low
         if (
             self.smile(ANNA)
             and self._cooling_present
-            and device["dev_class"] == "thermostat"
+            and entity["dev_class"] == "thermostat"
         ):
-            thermostat = device["thermostat"]
-            sensors = device["sensors"]
+            thermostat = entity["thermostat"]
+            sensors = entity["sensors"]
             temp_dict: ActuatorData = {
                 "setpoint_low": thermostat["setpoint"],
                 "setpoint_high": MAX_SETPOINT,
@@ -133,53 +145,68 @@ class SmileData(SmileHelper):
                 }
             thermostat.pop("setpoint")
             temp_dict.update(thermostat)
-            device["thermostat"] = temp_dict
+            entity["thermostat"] = temp_dict
             if "setpoint" in sensors:
                 sensors.pop("setpoint")
             sensors["setpoint_low"] = temp_dict["setpoint_low"]
             sensors["setpoint_high"] = temp_dict["setpoint_high"]
-            self._count += 2
+            self._count += 2  # add 4, remove 2
+
+
+    def _get_location_data(self, loc_id: str) -> GwEntityData:
+        """Helper-function for _all_entity_data() and async_update().
+
+        Provide entity-data, based on Location ID (= loc_id).
+        """
+        zone = self._zones[loc_id]
+        data = self._get_zone_data(loc_id)
+        if ctrl_state := self._control_state(loc_id):
+            data["control_state"] = ctrl_state
+            self._count += 1
 
-    def _get_device_data(self, dev_id: str) -> DeviceData:
-        """Helper-function for _all_device_data() and async_update().
+        # Thermostat data (presets, temperatures etc)
+        self._climate_data(loc_id, zone, data)
+
+        return data
 
-        Provide device-data, based on Location ID (= dev_id), from APPLIANCES.
+    def _get_entity_data(self, entity_id: str) -> GwEntityData:
+        """Helper-function for _update_gw_entities() and async_update().
+
+        Provide entity-data, based on appliance_id (= entity_id).
         """
-        device = self.gw_devices[dev_id]
-        data = self._get_measurement_data(dev_id)
+        entity = self.gw_entities[entity_id]
+        data = self._get_measurement_data(entity_id)
 
-        # Check availability of wired-connected devices
+        # Check availability of wired-connected entities
         # Smartmeter
         self._check_availability(
-            device, "smartmeter", data, "P1 does not seem to be connected"
+            entity, "smartmeter", data, "P1 does not seem to be connected"
         )
-        # OpenTherm device
-        if device["name"] != "OnOff":
+        # OpenTherm entity
+        if entity["name"] != "OnOff":
             self._check_availability(
-                device, "heater_central", data, "no OpenTherm communication"
+                entity, "heater_central", data, "no OpenTherm communication"
             )
 
         # Switching groups data
-        self._device_data_switching_group(device, data)
+        self._entity_switching_group(entity, data)
         # Adam data
-        self._device_data_adam(device, data)
-        # Skip obtaining data for (Adam) secondary thermostats
-        if device["dev_class"] not in ZONE_THERMOSTATS:
-            return data
+        self._get_adam_data(entity, data)
 
-        # Thermostat data (presets, temperatures etc)
-        self._device_data_climate(device, data)
+        # Thermostat data for Anna (presets, temperatures etc)
+        if self.smile(ANNA) and entity["dev_class"] == "thermostat":
+            self._climate_data(entity_id, entity, data)
 
         return data
 
     def _check_availability(
-        self, device: DeviceData, dev_class: str, data: DeviceData, message: str
+        self, entity: GwEntityData, dev_class: str, data: GwEntityData, message: str
     ) -> None:
-        """Helper-function for _get_device_data().
+        """Helper-function for _get_entity_data().
 
-        Provide availability status for the wired-commected devices.
+        Provide availability status for the wired-connected devices.
         """
-        if device["dev_class"] == dev_class:
+        if entity["dev_class"] == dev_class:
             data["available"] = True
             self._count += 1
             for item in self._notifications.values():
@@ -187,8 +214,8 @@ class SmileData(SmileHelper):
                     if message in msg:
                         data["available"] = False
 
-    def _device_data_adam(self, device: DeviceData, data: DeviceData) -> None:
-        """Helper-function for _get_device_data().
+    def _get_adam_data(self, entity: GwEntityData, data: GwEntityData) -> None:
+        """Helper-function for _get_entity_data().
 
         Determine Adam heating-status for on-off heating via valves,
         available regulations_modes and thermostat control_states.
@@ -196,14 +223,14 @@ class SmileData(SmileHelper):
         if self.smile(ADAM):
             # Indicate heating_state based on valves being open in case of city-provided heating
             if (
-                device["dev_class"] == "heater_central"
+                entity["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 and gateway_modes
-            if device["dev_class"] == "gateway":
+            if entity["dev_class"] == "gateway":
                 if self._reg_allowed_modes:
                     data["regulation_modes"] = self._reg_allowed_modes
                     self._count += 1
@@ -211,19 +238,20 @@ class SmileData(SmileHelper):
                     data["gateway_modes"] = self._gw_allowed_modes
                     self._count += 1
 
-            # Control_state, only available for Adam primary 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, data: DeviceData) -> None:
-        """Helper-function for _get_device_data().
+    def _climate_data(
+        self,
+        location_id: str,
+        entity: GwEntityData,
+        data: GwEntityData
+    ) -> None:
+        """Helper-function for _get_entity_data().
 
-        Determine climate-control device data.
+        Determine climate-control entity data.
         """
-        loc_id = device["location"]
+        loc_id = location_id
+        if entity.get("location") is not None:
+            loc_id = entity["location"]
 
         # Presets
         data["preset_modes"] = None
@@ -258,13 +286,13 @@ class SmileData(SmileHelper):
 
     def check_reg_mode(self, mode: str) -> bool:
         """Helper-function for device_data_climate()."""
-        gateway = self.gw_devices[self.gateway_id]
+        gateway = self.gw_entities[self.gateway_id]
         return (
             "regulation_modes" in gateway and gateway["select_regulation_mode"] == mode
         )
 
     def _get_schedule_states_with_off(
-        self, location: str, schedules: list[str], selected: str, data: DeviceData
+        self, location: str, schedules: list[str], selected: str, data: GwEntityData
     ) -> None:
         """Collect schedules with states for each thermostat.