Combine to DeviceZoneData

Author: bouwew

plugwise/common.py

@@ -11,7 +11,7 @@
     SPECIAL_PLUG_TYPES,
     SWITCH_GROUP_TYPES,
     ApplianceType,
-    DeviceData,
+    DeviceZoneData,
     ModelData,
     SensorType,
 )
@@ -40,7 +40,7 @@ def __init__(self) -> None:
         self._heater_id: str
         self._on_off_device: bool
         self._opentherm_device: bool
-        self.gw_devices: dict[str, DeviceData]
+        self.gw_devices: dict[str, DeviceZoneData]
         self.smile_name: str
         self.smile_type: str
 
@@ -108,7 +108,7 @@ def _appl_thermostat_info(self, appl: Munch, xml_1: etree, xml_2: etree = None)
 
         return appl
 
-    def _collect_power_values(self, data: DeviceData, loc: Munch, tariff: str, legacy: bool = False) -> None:
+    def _collect_power_values(self, data: DeviceZoneData, loc: Munch, tariff: str, legacy: bool = False) -> None:
         """Something."""
         for loc.peak_select in ("nl_peak", "nl_offpeak"):
             loc.locator = (
@@ -160,8 +160,8 @@ def _power_data_energy_diff(
         measurement: str,
         net_string: SensorType,
         f_val: float | int,
-        direct_data: DeviceData,
-    ) -> DeviceData:
+        direct_data: DeviceZoneData,
+    ) -> DeviceZoneData:
         """Calculate differential energy."""
         if (
             "electricity" in measurement
@@ -208,7 +208,7 @@ def _create_gw_devices(self, appl: Munch) -> None:
                 self._count += 1
 
     def _device_data_switching_group(
-        self, device: DeviceData, data: DeviceData
+        self, device: DeviceZoneData, data: DeviceZoneData
     ) -> None:
         """Helper-function for _get_device_data().
 
@@ -222,12 +222,12 @@ def _device_data_switching_group(
             data["switches"]["relay"] = counter != 0
             self._count += 1
 
-    def _get_group_switches(self) -> dict[str, DeviceData]:
+    def _get_group_switches(self) -> dict[str, DeviceZoneData]:
         """Helper-function for smile.py: get_all_devices().
 
         Collect switching- or pump-group info.
         """
-        switch_groups: dict[str, DeviceData] = {}
+        switch_groups: dict[str, DeviceZoneData] = {}
         # P1 and Anna don't have switchgroups
         if self.smile_type == "power" or self.smile(ANNA):
             return switch_groups
@@ -258,7 +258,7 @@ def _get_group_switches(self) -> dict[str, DeviceData]:
 
         return switch_groups
 
-    def _get_lock_state(self, xml: etree, data: DeviceData, stretch_v2: bool = False) -> None:
+    def _get_lock_state(self, xml: etree, data: DeviceZoneData, stretch_v2: bool = False) -> None:
         """Helper-function for _get_measurement_data().
 
         Adam & Stretches: obtain the relay-switch lock state.

plugwise/constants.py

@@ -516,35 +516,11 @@ class ActuatorData(TypedDict, total=False):
     upper_bound: float
 
 
-class MemberData:
-    """ZoneData Member data class."""
+class DeviceZoneData(TypedDict, total=False):
+    """The DeviceZone data class.
 
-    primary: list[str]
-    secondary: list[str]
-
-
-class ZoneData(TypedDict, total=False):
-    """The Climate Data class, covering the collected and ordered output-data per location."""
-
-    dev_class: str
-    name: str
-    members: dict[str, list[str]]
-    climate_mode: str
-    # Extra for Adam Master Thermostats
-    control_state: str | bool
-    # Presets:
-    active_preset: str | None
-    preset_modes: list[str] | None
-    # Schedules:
-    available_schedules: list[str]
-    select_schedule: str
-
-    sensors: SmileSensors
-    thermostat: ActuatorData
-
-
-class DeviceData(TypedDict, total=False):
-    """The Device Data class, covering the collected and ordered output-data per device."""
+    Covering the collected output-data per device or location.
+    """
 
     # Appliance base data
     dev_class: str
@@ -579,7 +555,8 @@ class DeviceData(TypedDict, total=False):
     select_gateway_mode: str
     select_regulation_mode: str
 
-    # Single thermostat (Anna)
+    # Thermostat-related
+    thermostats: dict[str, list[str]]
     # Presets:
     active_preset: str | None
     preset_modes: list[str] | None
@@ -606,5 +583,5 @@ class PlugwiseData:
     """Plugwise data provided as output."""
 
     gateway: GatewayData
-    devices: dict[str, DeviceData]
-    zones: dict[str, ZoneData]
+    devices: dict[str, DeviceZoneData]
+    zones: dict[str, DeviceZoneData]

plugwise/data.py

@@ -14,8 +14,7 @@
     NONE,
     OFF,
     ActuatorData,
-    DeviceData,
-    ZoneData,
+    DeviceZoneData,
 )
 from plugwise.helper import SmileHelper
 from plugwise.util import remove_empty_platform_dicts
@@ -108,7 +107,7 @@ def _detect_low_batteries(self) -> list[str]:
         return mac_address_list
 
     def _add_or_update_notifications(
-        self, device_id: str, device: DeviceData, data: DeviceData
+        self, device_id: str, device: DeviceZoneData, data: DeviceZoneData
     ) -> None:
         """Helper-function adding or updating the Plugwise notifications."""
         if (
@@ -123,7 +122,7 @@ def _add_or_update_notifications(
             data["binary_sensors"]["plugwise_notification"] = bool(self._notifications)
             self._count += 1
 
-    def _update_for_cooling(self, device: DeviceData) -> None:
+    def _update_for_cooling(self, device: DeviceZoneData) -> None:
         """Helper-function for adding/updating various cooling-related values."""
         # For Anna and heating + cooling, replace setpoint with setpoint_high/_low
         if (
@@ -152,7 +151,7 @@ def _update_for_cooling(self, device: DeviceData) -> None:
             self._count += 2  # add 4, remove 2
 
 
-    def _get_location_data(self, loc_id: str) -> ZoneData:
+    def _get_location_data(self, loc_id: str) -> DeviceZoneData:
         """Helper-function for _all_device_data() and async_update().
 
         Provide device-data, based on Location ID (= loc_id).
@@ -168,7 +167,7 @@ def _get_location_data(self, loc_id: str) -> ZoneData:
 
         return data
 
-    def _get_device_data(self, dev_id: str) -> DeviceData:
+    def _get_device_data(self, dev_id: str) -> DeviceZoneData:
         """Helper-function for _update_gw_devices() and async_update().
 
         Provide device-data, based on appliance_id ()= dev_id).
@@ -199,7 +198,7 @@ def _get_device_data(self, dev_id: str) -> DeviceData:
         return data
 
     def _check_availability(
-        self, device: DeviceData, dev_class: str, data: DeviceData, message: str
+        self, device: DeviceZoneData, dev_class: str, data: DeviceZoneData, message: str
     ) -> None:
         """Helper-function for _get_device_data().
 
@@ -213,7 +212,7 @@ def _check_availability(
                     if message in msg:
                         data["available"] = False
 
-    def _device_data_adam(self, device: DeviceData, data: DeviceData) -> None:
+    def _device_data_adam(self, device: DeviceZoneData, data: DeviceZoneData) -> None:
         """Helper-function for _get_device_data().
 
         Determine Adam heating-status for on-off heating via valves,
@@ -241,8 +240,8 @@ def _device_data_adam(self, device: DeviceData, data: DeviceData) -> None:
     def _device_data_climate(
         self,
         location_id: str,
-        device: DeviceData | ZoneData,
-        data: DeviceData | ZoneData
+        device: DeviceZoneData,
+        data: DeviceZoneData
     ) -> None:
         """Helper-function for _get_device_data().
 
@@ -291,7 +290,7 @@ def check_reg_mode(self, mode: str) -> bool:
         )
 
     def _get_schedule_states_with_off(
-        self, location: str, schedules: list[str], selected: str, data: DeviceData | ZoneData
+        self, location: str, schedules: list[str], selected: str, data: DeviceZoneData
     ) -> None:
         """Collect schedules with states for each thermostat.
 

plugwise/helper.py

@@ -36,12 +36,11 @@
     ActuatorData,
     ActuatorDataType,
     ActuatorType,
-    DeviceData,
+    DeviceZoneData,
     GatewayData,
     SensorType,
     ThermoLoc,
     ToggleNameType,
-    ZoneData,
 )
 from plugwise.exceptions import (
     ConnectionFailedError,
@@ -251,7 +250,7 @@ def __init__(self) -> None:
 
         self.gateway_id: str
         self.gw_data: GatewayData = {}
-        self.gw_devices: dict[str, DeviceData] = {}
+        self.gw_devices: dict[str, DeviceZoneData] = {}
         self.loc_data: dict[str, ThermoLoc]
         self.smile_fw_version: Version | None
         self.smile_hw_version: str | None
@@ -262,7 +261,7 @@ def __init__(self) -> None:
         self.smile_type: str
         self.smile_zigbee_mac_address: str | None
         self.therms_with_offset_func: list[str] = []
-        self.zone_data: dict[str, ZoneData] = {}
+        self.zone_data: dict[str, DeviceZoneData] = {}
         SmileCommon.__init__(self)
 
     def _all_appliances(self) -> None:
@@ -483,12 +482,12 @@ def _get_appliances_with_offset_functionality(self) -> list[str]:
 
         return therm_list
 
-    def _get_zone_data(self, loc_id: str) -> ZoneData:
+    def _get_zone_data(self, loc_id: str) -> DeviceZoneData:
         """Helper-function for smile.py: _get_device_data().
 
         Collect the location-data based on location id.
         """
-        data: ZoneData = {"sensors": {}}
+        data: DeviceZoneData = {"sensors": {}}
         zone = self.zone_data[loc_id]
         measurements = ZONE_MEASUREMENTS
         if (
@@ -499,12 +498,12 @@ def _get_zone_data(self, loc_id: str) -> ZoneData:
 
         return data
 
-    def _get_measurement_data(self, dev_id: str) -> DeviceData:
+    def _get_measurement_data(self, dev_id: str) -> DeviceZoneData:
         """Helper-function for smile.py: _get_device_data().
 
         Collect the appliance-data based on device id.
         """
-        data: DeviceData = {"binary_sensors": {}, "sensors": {}, "switches": {}}
+        data: DeviceZoneData = {"binary_sensors": {}, "sensors": {}, "switches": {}}
         # Get P1 smartmeter data from LOCATIONS
         device = self.gw_devices[dev_id]
         # !! DON'T CHANGE below two if-lines, will break stuff !!
@@ -588,12 +587,12 @@ def _get_measurement_data(self, dev_id: str) -> DeviceData:
 
         return data
 
-    def _power_data_from_location(self, loc_id: str) -> DeviceData:
+    def _power_data_from_location(self, loc_id: str) -> DeviceZoneData:
         """Helper-function for smile.py: _get_device_data().
 
         Collect the power-data based on Location ID, from LOCATIONS.
         """
-        direct_data: DeviceData = {"sensors": {}}
+        direct_data: DeviceZoneData = {"sensors": {}}
         loc = Munch()
         log_list: list[str] = ["point_log", "cumulative_log", "interval_log"]
         t_string = "tariff"
@@ -610,7 +609,7 @@ def _power_data_from_location(self, loc_id: str) -> DeviceData:
     def _appliance_measurements(
         self,
         appliance: etree,
-        data: DeviceData,
+        data: DeviceZoneData,
         measurements: dict[str, DATA | UOM],
     ) -> None:
         """Helper-function for _get_measurement_data() - collect appliance measurement data."""
@@ -648,7 +647,7 @@ def _appliance_measurements(
         self._count += len(data) - 3
 
     def _get_toggle_state(
-        self, xml: etree, toggle: str, name: ToggleNameType, data: DeviceData
+        self, xml: etree, toggle: str, name: ToggleNameType, data: DeviceZoneData
     ) -> None:
         """Helper-function for _get_measurement_data().
 
@@ -677,7 +676,7 @@ def _get_plugwise_notifications(self) -> None:
                 )
 
     def _get_actuator_functionalities(
-        self, xml: etree, device: DeviceData, data: DeviceData
+        self, xml: etree, device: DeviceZoneData, data: DeviceZoneData
     ) -> None:
         """Helper-function for _get_measurement_data()."""
         for item in ACTIVE_ACTUATORS:
@@ -732,7 +731,7 @@ def _get_actuator_functionalities(
                 act_item = cast(ActuatorType, item)
                 data[act_item] = temp_dict
 
-    def _get_regulation_mode(self, appliance: etree, data: DeviceData) -> None:
+    def _get_regulation_mode(self, appliance: etree, data: DeviceZoneData) -> None:
         """Helper-function for _get_measurement_data().
 
         Collect the gateway regulation_mode.
@@ -743,7 +742,7 @@ def _get_regulation_mode(self, appliance: etree, data: DeviceData) -> None:
             self._count += 1
             self._cooling_enabled = data["select_regulation_mode"] == "cooling"
 
-    def _get_gateway_mode(self, appliance: etree, data: DeviceData) -> None:
+    def _get_gateway_mode(self, appliance: etree, data: DeviceZoneData) -> None:
         """Helper-function for _get_measurement_data().
 
         Collect the gateway mode.
@@ -766,7 +765,7 @@ def _object_value(self, obj_id: str, measurement: str) -> float | int | None:
 
         return val
 
-    def _process_c_heating_state(self, data: DeviceData) -> None:
+    def _process_c_heating_state(self, data: DeviceZoneData) -> None:
         """Helper-function for _get_measurement_data().
 
         Process the central_heating_state value.
@@ -794,7 +793,7 @@ def _process_c_heating_state(self, data: DeviceData) -> None:
         if self._elga:
             data["binary_sensors"]["heating_state"] = data["c_heating_state"]
 
-    def _cleanup_data(self, data: DeviceData) -> None:
+    def _cleanup_data(self, data: DeviceZoneData) -> None:
         """Helper-function for _get_measurement_data().
 
         Clean up the data dict.
@@ -842,7 +841,7 @@ def _scan_thermostats(self) -> None:
                         loc_id: {
                             "dev_class": "climate",
                             "name": loc_data["name"],
-                            "members": {"primary": loc_data["primary"], "secondary": loc_data["secondary"]}
+                            "thermostats": {"primary": loc_data["primary"], "secondary": loc_data["secondary"]}
                         }
                     }
                 )
@@ -869,7 +868,7 @@ def _rank_thermostat(
         thermo_matching: dict[str, int],
         loc_id: str,
         appliance_id: str,
-        appliance_details: DeviceData,
+        appliance_details: DeviceZoneData,
     ) -> None:
         """Helper-function for _scan_thermostats().
 

plugwise/legacy/data.py

@@ -6,7 +6,7 @@
 
 # Dict as class
 # Version detection
-from plugwise.constants import NONE, OFF, DeviceData
+from plugwise.constants import NONE, OFF, DeviceZoneData
 from plugwise.legacy.helper import SmileLegacyHelper
 from plugwise.util import remove_empty_platform_dicts
 
@@ -46,7 +46,7 @@ def _update_gw_devices(self) -> None:
             device.update(data)
             remove_empty_platform_dicts(device)
 
-    def _get_device_data(self, dev_id: str) -> DeviceData:
+    def _get_device_data(self, dev_id: str) -> DeviceZoneData:
         """Helper-function for _all_device_data() and async_update().
 
         Provide device-data, based on Location ID (= dev_id), from APPLIANCES.
@@ -66,7 +66,7 @@ def _get_device_data(self, dev_id: str) -> DeviceData:
 
         return data
 
-    def _device_data_climate(self, device: DeviceData, data: DeviceData) -> None:
+    def _device_data_climate(self, device: DeviceZoneData, data: DeviceZoneData) -> None:
         """Helper-function for _get_device_data().
 
         Determine climate-control device data.