Rename to zone

Author: bouwew

plugwise/constants.py

@@ -144,11 +144,6 @@
     "relay": UOM(NONE),
 }
 
-# Climate related measurements
-CLIMATE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
-    "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
-}
-
 # Heater Central related measurements
 HEATER_CENTRAL_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
     "boiler_state": DATA(
@@ -195,6 +190,14 @@
     "outdoor_temperature",
 )
 
+# Zone/climate related measurements
+ZONE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
+    "electricity_consumed": UOM(POWER_WATT),
+    "electricity_produced": UOM(POWER_WATT),
+    "relay": UOM(NONE),
+    "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
+}
+
 # Literals
 SMILE_P1 = "Smile P1"
 POWER = "power"
@@ -513,7 +516,7 @@ class ActuatorData(TypedDict, total=False):
     upper_bound: float
 
 
-class ClimateData(TypedDict, total=False):
+class ZoneData(TypedDict, total=False):
     """The Climate Data class, covering the collected and ordered output-data per location."""
 
     dev_class: str
@@ -529,6 +532,7 @@ class ClimateData(TypedDict, total=False):
     available_schedules: list[str]
     select_schedule: str
 
+    sensors: SmileSensors
     thermostat: ActuatorData
 
 
@@ -582,5 +586,5 @@ class PlugwiseData:
     """Plugwise data provided as output."""
 
     gateway: GatewayData
-    climates: dict[str, ClimateData]
     devices: dict[str, DeviceData]
+    zones: dict[str, ZoneData]

plugwise/data.py

@@ -36,7 +36,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._update_zones()
         self.gw_data.update(
             {
                 "gateway_id": self.gateway_id,
@@ -51,14 +51,14 @@ def _all_device_data(self) -> None:
                 {"heater_id": self._heater_id, "cooling_present": self._cooling_present}
             )
 
-    def _update_climates(self) -> None:
+    def _update_zones(self) -> None:
         """Helper-function for _all_device_data() and async_update().
 
-        Collect data for each climate-location and add to self.climate_data.
+        Collect data for each zone/location and add to self.zone_data.
         """
-        for location_id, climate in self.climate_data.items():
+        for location_id, zone in self.zone_data.items():
             data = self._get_location_data(location_id)
-            climate.update(data)
+            zone.update(data)
 
     def _update_gw_devices(self) -> None:
         """Helper-function for _all_device_data() and async_update().
@@ -157,14 +157,14 @@ def _get_location_data(self, loc_id: str) -> DeviceData:
 
         Provide device-data, based on Location ID (= loc_id).
         """
-        climate = self.climate_data[loc_id]
-        data = self._get_climate_data(loc_id)
+        zone = self.zone_data[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
 
         # Thermostat data (presets, temperatures etc)
-        self._device_data_climate(loc_id, climate, data)
+        self._device_data_climate(loc_id, zone, data)
 
         return data
 

plugwise/helper.py

@@ -15,7 +15,6 @@
     ADAM,
     ANNA,
     ATTR_NAME,
-    CLIMATE_MEASUREMENTS,
     DATA,
     DEVICE_MEASUREMENTS,
     DHW_SETPOINT,
@@ -33,15 +32,16 @@
     THERMOSTAT_CLASSES,
     TOGGLES,
     UOM,
+    ZONE_MEASUREMENTS,
     ActuatorData,
     ActuatorDataType,
     ActuatorType,
-    ClimateData,
     DeviceData,
     GatewayData,
     SensorType,
     ThermoLoc,
     ToggleNameType,
+    ZoneData,
 )
 from plugwise.exceptions import (
     ConnectionFailedError,
@@ -250,7 +250,6 @@ 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]
@@ -263,6 +262,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: ZoneData = {}
         SmileCommon.__init__(self)
 
     def _all_appliances(self) -> None:
@@ -483,19 +483,19 @@ def _get_appliances_with_offset_functionality(self) -> list[str]:
 
         return therm_list
 
-    def _get_climate_data(self, loc_id: str) -> ClimateData:
+    def _get_zone_data(self, loc_id: str) -> ZoneData:
         """Helper-function for smile.py: _get_device_data().
 
         Collect the location-data based on location id.
         """
-        data: ClimateData = {"sensors": {}}
-        climate = self.climate_data[loc_id]
-        measurements = CLIMATE_MEASUREMENTS        
+        data: ZoneData = {"sensors": {}}
+        zone = self.zone_data[loc_id]
+        measurements = ZONE_MEASUREMENTS        
         if (
             location := self._domain_objects.find(f'./location[@id="{loc_id}"]')
         ) is not None:
             self._appliance_measurements(location, data, measurements)
-            self._get_actuator_functionalities(location, climate, data)
+            self._get_actuator_functionalities(location, zone, data)
 
         return data
 
@@ -682,7 +682,7 @@ 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 all but climates
+            # skip thermostat for all but zones with thermostats
             if item == "max_dhw_temperature" or (
                 item == "thermostat" and device["dev_class"] != "climate"
             ):
@@ -835,7 +835,7 @@ def _scan_thermostats(self) -> None:
 
         for loc_id, loc_data in list(self._thermo_locs.items()):
             if loc_data["primary_prio"] != 0:
-                self.climate_data.update(
+                self.zone_data.update(
                     {
                         loc_id: {
                             "dev_class": "climate",
@@ -845,11 +845,6 @@ def _scan_thermostats(self) -> None:
                     }
                 )
 
-        # All thermostat appliances can keep their device_class but must not become climate-entities in HA.
-        # For each _thermo_loc a special climate-device must be created, with setpoint and temperature taken from the thermostat appliance with the lowest reported temperature.
-        # Also the corresponding device_id must be available, and updated, as an attribute.
-        # And the other attributes must be taken from the _thermo_loc.
-
     def _match_locations(self) -> dict[str, ThermoLoc]:
         """Helper-function for _scan_thermostats().
 

plugwise/smile.py

@@ -23,11 +23,11 @@
     NOTIFICATIONS,
     OFF,
     RULES,
-    ClimateData,
     DeviceData,
     GatewayData,
     PlugwiseData,
     ThermoLoc,
+    ZoneData,
 )
 from plugwise.data import SmileData
 from plugwise.exceptions import ConnectionFailedError, DataMissingError, PlugwiseError
@@ -126,9 +126,9 @@ 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] = {}
+        self.zone_data: ZoneData = {}
         try:
             await self.full_update_device()
             self.get_all_devices()
@@ -144,8 +144,8 @@ async def async_update(self) -> PlugwiseData:
 
         return PlugwiseData(
             gateway=self.gw_data,
-            climates=self.climate_data,
             devices=self.gw_devices,
+            zones=self.zone_data,
         )
 
 ########################################################################################################

tests/test_init.py

@@ -584,7 +584,7 @@ async def device_test(
                 if "cooling_state" in heat_cooler["binary_sensors"]:
                     self._cooling_active = heat_cooler["binary_sensors"]["cooling_state"]
 
-        self._write_json("all_data", {"gateway": data.gateway, "devices": data.devices})
+        self._write_json("all_data", {"gateway": data.gateway, "devices": data.devices, "zones": data.zones})
 
         if "FIXTURES" in os.environ:
             _LOGGER.info("Skipping tests: Requested fixtures only")  # pragma: no cover
@@ -596,7 +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("Zone data = %s", data.zones)
         _LOGGER.info("Device list = %s", data.devices)
         self.show_setup(location_list, data.devices)