Reworking

Author: bouwew

plugwise/__init__.py

@@ -308,7 +308,7 @@ def get_all_devices(self) -> None:
 
     async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
-        data = PlugwiseData({}, {})
+        data = PlugwiseData({}, {}, {})
         try:
             data = await self._smile_api.async_update()
             self.gateway_id = data.gateway["gateway_id"]

plugwise/constants.py

@@ -144,6 +144,12 @@
     "relay": UOM(NONE),
 }
 
+# Climate related measurements
+CLIMATE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
+    "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
+    "thermostat": DATA("setpoint", TEMP_CELSIUS),  # HA Core thermostat setpoint
+}
+
 # Heater Central related measurements
 HEATER_CENTRAL_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
     "boiler_state": DATA(
@@ -492,7 +498,7 @@ class ThermoLoc(TypedDict, total=False):
     """Thermo Location class."""
 
     name: str
-    primary: str | None
+    primary: set[str]
     primary_prio: int
     secondary: set[str]
 
@@ -508,6 +514,25 @@ class ActuatorData(TypedDict, total=False):
     upper_bound: float
 
 
+class ClimateData(TypedDict, total=False):
+    """The Climate Data class, covering the collected and ordered output-data per location."""
+
+    dev_class: str
+    name: str
+    members: dict[str, str]  # TODO complete
+    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
+
+    thermostat: ActuatorData
+
+
 class DeviceData(TypedDict, total=False):
     """The Device Data class, covering the collected and ordered output-data per device."""
 
@@ -544,32 +569,19 @@ class DeviceData(TypedDict, total=False):
     select_gateway_mode: str
     select_regulation_mode: str
 
-    # Master Thermostats
-    # Presets:
-    active_preset: str | None
-    preset_modes: list[str] | None
-    # Schedules:
-    available_schedules: list[str]
-    last_used: str | None
-    select_schedule: str
-
-    climate_mode: str
-    # Extra for Adam Master Thermostats
-    control_state: str | bool
-
     # Dict-types
     binary_sensors: SmileBinarySensors
     max_dhw_temperature: ActuatorData
     maximum_boiler_temperature: ActuatorData
     sensors: SmileSensors
     switches: SmileSwitches
     temperature_offset: ActuatorData
-    thermostat: ActuatorData
 
 
 @dataclass
 class PlugwiseData:
     """Plugwise data provided as output."""
 
     gateway: GatewayData
+    climates: dict[str, ClimateData]
     devices: dict[str, DeviceData]

plugwise/data.py

@@ -35,6 +35,7 @@ def _all_device_data(self) -> None:
         Collect data for each device and add to self.gw_data and self.gw_devices.
         """
         self._update_gw_devices()
+        self._update_climates()
         self.gw_data.update(
             {
                 "gateway_id": self.gateway_id,
@@ -49,6 +50,15 @@ def _all_device_data(self) -> None:
                 {"heater_id": self._heater_id, "cooling_present": self._cooling_present}
             )
 
+    def _update_climates(self) -> None:
+        """Helper-function for _all_device_data() and async_update().
+
+        Collect data for each climate-location and add to self.climate_data.
+        """
+        for location_id, climate in self.climate_data.items():
+            data = self._get_location_data(location_id)
+            climate.update(data)
+
     def _update_gw_devices(self) -> None:
         """Helper-function for _all_device_data() and async_update().
 
@@ -140,10 +150,24 @@ def _update_for_cooling(self, device: DeviceData) -> None:
             sensors["setpoint_high"] = temp_dict["setpoint_high"]
             self._count += 2
 
-    def _get_device_data(self, dev_id: str) -> DeviceData:
+    def _get_location_data(self, loc_id: str) -> DeviceData:
         """Helper-function for _all_device_data() and async_update().
 
-        Provide device-data, based on Location ID (= dev_id), from APPLIANCES.
+        Provide device-data, based on Location ID (= loc_id).
+        """
+        climate = self.climate_data[loc_id]
+        data = self._get_climate_data(loc_id)
+        if ctrl_state := self._control_state(loc_id):
+            data["control_state"] = ctrl_state
+            self._count += 1
+
+        # Thermostat data (presets, temperatures etc)
+        self._device_data_climate(loc_id, climate, data)
+
+    def _get_device_data(self, dev_id: str) -> DeviceData:
+        """Helper-function for _update_gw_devices() and async_update().
+
+        Provide device-data, based on appliance_id ()= dev_id).
         """
         device = self.gw_devices[dev_id]
         data = self._get_measurement_data(dev_id)
@@ -162,13 +186,7 @@ def _get_device_data(self, dev_id: str) -> DeviceData:
         # Switching groups data
         self._device_data_switching_group(device, 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
-
-        # Thermostat data (presets, temperatures etc)
-        self._device_data_climate(device, data)
+        self._device_data_adam(dev_id, device, data)
 
         return data
 
@@ -187,7 +205,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, loc_id: str, device: DeviceData, data: DeviceData) -> None:
         """Helper-function for _get_device_data().
 
         Determine Adam heating-status for on-off heating via valves,
@@ -211,20 +229,12 @@ def _device_data_adam(self, device: DeviceData, data: DeviceData) -> None:
                     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:
+    def _device_data_climate(self, loc_id: str, device: DeviceData, data: DeviceData) -> None:
         """Helper-function for _get_device_data().
 
         Determine climate-control device data.
         """
-        loc_id = device["location"]
-
         # Presets
         data["preset_modes"] = None
         data["active_preset"] = None

plugwise/helper.py

@@ -15,6 +15,7 @@
     ADAM,
     ANNA,
     ATTR_NAME,
+    CLIMATE_MEASUREMENTS,
     DATA,
     DEVICE_MEASUREMENTS,
     DHW_SETPOINT,
@@ -35,6 +36,7 @@
     ActuatorData,
     ActuatorDataType,
     ActuatorType,
+    ClimateData,
     DeviceData,
     GatewayData,
     SensorType,
@@ -248,6 +250,7 @@ def __init__(self) -> None:
         self._cooling_enabled = False
 
         self.gateway_id: str
+        self.climate_data: ClimateData = {}
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
         self.loc_data: dict[str, ThermoLoc]
@@ -480,6 +483,20 @@ def _get_appliances_with_offset_functionality(self) -> list[str]:
 
         return therm_list
 
+    def _get_climate_data(self, loc_id: str) -> ClimateData:
+        """Helper-function for smile.py: _get_device_data().
+
+        Collect the location-data based on location id.
+        """
+        data: ClimateData = {"sensors": {}}
+        measurements = CLIMATE_MEASUREMENTS        
+        if (
+            location := self._domain_objects.find(f'./location[@id="{loc_id}"]')
+        ) is not None:
+            self._appliance_measurements(location, data, measurements)
+            if location.find("type").text in ACTUATOR_CLASSES:
+                self._get_actuator_functionalities(location, device, data)
+
     def _get_measurement_data(self, dev_id: str) -> DeviceData:
         """Helper-function for smile.py: _get_device_data().
 
@@ -619,11 +636,14 @@ def _appliance_measurements(
                     appl_i_loc.text, ENERGY_WATT_HOUR
                 )
 
-        self._count += len(data["binary_sensors"])
-        self._count += len(data["sensors"])
-        self._count += len(data["switches"])
+        if data.get("binary_sensors"):
+            self._count += len(data["binary_sensors"]) - 1
+        if data.get("sensors"):
+            self._count += len(data["sensors"]) -1
+        if data.get("switches"):
+            self._count += len(data["switches"]) -1
         # Don't count the above top-level dicts, only the remaining single items
-        self._count += len(data) - 3
+        #self._count += len(data) - 3
 
     def _get_toggle_state(
         self, xml: etree, toggle: str, name: ToggleNameType, data: DeviceData
@@ -660,9 +680,9 @@ def _get_actuator_functionalities(
         """Helper-function for _get_measurement_data()."""
         for item in ACTIVE_ACTUATORS:
             # Skip max_dhw_temperature, not initially valid,
-            # skip thermostat for thermo_sensors
+            # skip thermostat for all but climates
             if item == "max_dhw_temperature" or (
-                item == "thermostat" and device["dev_class"] == "thermo_sensor"
+                item == "thermostat" and device["dev_class"] != "climate"
             ):
                 continue
 
@@ -813,12 +833,12 @@ def _scan_thermostats(self) -> None:
 
         for loc_id, loc_data in list(self._thermo_locs.items()):
             if loc_data["primary_prio"] != 0:
-                self.gw_devices.update(
+                self.climate_data.update(
                     {
                         loc_id: {
                             "dev_class": "climate",
                             "name": loc_data["name"],
-                            "devices": loc_data["primary"]
+                            "members": {"primary": loc_data["primary"], "secondary": loc_data["secondary"]}
                         }
                     }
                 )
@@ -864,7 +884,7 @@ def _rank_thermostat(
             if thermo_matching[appl_class] > self._thermo_locs[loc_id]["primary_prio"]:
                 # Demote former primary
                 if (tl_primary:= self._thermo_locs[loc_id]["primary"]):
-                    self._thermo_locs[loc_id]["secondary"].update(tl_primary)
+                    self._thermo_locs[loc_id]["secondary"].add(tl_primary)
 
                 # Crown primary
                 self._thermo_locs[loc_id]["primary_prio"] = thermo_matching[appl_class]

plugwise/smile.py

@@ -23,6 +23,7 @@
     NOTIFICATIONS,
     OFF,
     RULES,
+    ClimateData,
     DeviceData,
     GatewayData,
     PlugwiseData,
@@ -126,6 +127,7 @@ def get_all_devices(self) -> None:
 
     async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
+        self.climate_data: ClimateData = {}
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
         try:
@@ -141,7 +143,11 @@ async def async_update(self) -> PlugwiseData:
         except KeyError as err:
             raise DataMissingError("No Plugwise data received") from err
 
-        return PlugwiseData(self.gw_data, self.gw_devices)
+        return PlugwiseData(
+            gateway=self.gw_data,
+            climates=self.climate_data,
+            devices=self.gw_devices,
+        )
 
 ########################################################################################################
 ###  API Set and HA Service-related Functions                                                        ###

tests/test_init.py

@@ -596,6 +596,7 @@ async def device_test(
         _LOGGER.info("Gateway id = %s", data.gateway["gateway_id"])
         _LOGGER.info("Hostname = %s", smile.smile_hostname)
         _LOGGER.info("Gateway data = %s", data.gateway)
+        _LOGGER.info("Climate data = %s", data.climates)
         _LOGGER.info("Device list = %s", data.devices)
         self.show_setup(location_list, data.devices)