Merge pull request #305 from plugwise/typing_again

Retry fixing #231

Author: bouwew

.gitignore

@@ -15,3 +15,4 @@ fixtures/*
 !fixtures/.keep
 *.sedbck
 tmp
+.mypy_cache

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+## v0.31.2: Introduce strict-typing (py.typed)
+
 ## v0.31.1: Legacy Anna - read and process system-xml data
 
 - Add support for reading the system-xml data from the legacy Smile T

plugwise/__init__.py

@@ -35,7 +35,7 @@
     ActuatorData,
     ApplianceData,
     DeviceData,
-    GatewayData,
+    PlugwiseData,
     SmileBinarySensors,
     SmileSensors,
     SmileSwitches,
@@ -52,12 +52,8 @@
 class SmileData(SmileHelper):
     """The Plugwise Smile main class."""
 
-    def update_for_cooling(self, device: DeviceData) -> None:
+    def update_for_cooling(self, device: DeviceData) -> DeviceData:
         """Helper-function for adding/updating various cooling-related values."""
-        # Add setpoint_low and setpoint_high when cooling is enabled
-        if device["dev_class"] not in ZONE_THERMOSTATS:
-            return
-
         # For heating + cooling, replace setpoint with setpoint_high/_low
         if self._cooling_present:
             thermostat = device["thermostat"]
@@ -85,6 +81,8 @@ def update_for_cooling(self, device: DeviceData) -> None:
             sensors["setpoint_low"] = temp_dict["setpoint_low"]
             sensors["setpoint_high"] = temp_dict["setpoint_high"]
 
+        return device
+
     def _all_device_data(self) -> None:
         """Helper-function for get_all_devices().
 
@@ -100,7 +98,8 @@ def _all_device_data(self) -> None:
             )
 
             # Update for cooling
-            self.update_for_cooling(self.gw_devices[device_id])
+            if self.gw_devices[device_id]["dev_class"] in ZONE_THERMOSTATS:
+                self.update_for_cooling(self.gw_devices[device_id])
 
         self.gw_data.update(
             {"smile_name": self.smile_name, "gateway_id": self.gateway_id}
@@ -237,7 +236,7 @@ def _device_data_climate(
 
     def _check_availability(
         self, details: ApplianceData, device_data: DeviceData
-    ) -> None:
+    ) -> DeviceData:
         """Helper-function for _get_device_data().
 
         Provide availability status for the wired-commected devices.
@@ -258,6 +257,8 @@ def _check_availability(
                     if "P1 does not seem to be connected to a smart meter" in msg:
                         device_data["available"] = False
 
+        return device_data
+
     def _get_device_data(self, dev_id: str) -> DeviceData:
         """Helper-function for _all_device_data() and async_update().
 
@@ -452,7 +453,7 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
             )
             raise UnsupportedDeviceError
 
-        ver = semver.VersionInfo.parse(self.smile_fw_version)
+        ver = semver.version.Version.parse(self.smile_fw_version)
         target_smile = f"{model}_v{ver.major}"
         LOGGER.debug("Plugwise identified as %s", target_smile)
         if target_smile not in SMILES:
@@ -509,7 +510,7 @@ async def _update_domain_objects(self) -> None:
                     f"{self._endpoint}{DOMAIN_OBJECTS}",
                 )
 
-    async def async_update(self) -> tuple[GatewayData, dict[str, DeviceData]]:
+    async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
         if self.smile_type != "power":
             await self._update_domain_objects()
@@ -547,9 +548,10 @@ async def async_update(self) -> tuple[GatewayData, dict[str, DeviceData]]:
                         )
 
             # Update for cooling
-            self.update_for_cooling(dev_dict)
+            if dev_dict["dev_class"] in ZONE_THERMOSTATS:
+                self.update_for_cooling(dev_dict)
 
-        return (self.gw_data, self.gw_devices)
+        return PlugwiseData(self.gw_data, self.gw_devices)
 
     async def _set_schedule_state_legacy(
         self, loc_id: str, name: str, status: str

plugwise/constants.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 from collections import namedtuple
+from dataclasses import dataclass
 import datetime as dt
 import logging
 from typing import Final, TypedDict
@@ -359,7 +360,7 @@ class ModelData(TypedDict):
     hardware_version: str | None
     firmware_version: str | None
     zigbee_mac_address: str | None
-    available: bool | None
+    reachable: bool | None
 
 
 class SmileBinarySensors(TypedDict, total=False):
@@ -460,10 +461,15 @@ class ActuatorData(TypedDict, total=False):
     upper_bound: float
 
 
-class DeviceDataPoints(
-    SmileBinarySensors, SmileSensors, SmileSwitches, TypedDict, total=False
+class DeviceData(
+    ApplianceData,
+    SmileBinarySensors,
+    SmileSensors,
+    SmileSwitches,
+    TypedDict,
+    total=False,
 ):
-    """The class covering all possible collected data points."""
+    """The Device Data class, covering the collected and ordered output-data per device."""
 
     # Loria
     dhw_mode: str
@@ -487,19 +493,23 @@ class DeviceDataPoints(
     control_state: str | bool
 
     # For temporary use
-    c_heating_state: str
+    c_heating_state: bool
     modified: str
 
     # Device availability
     available: bool | None
 
-
-class DeviceData(ApplianceData, DeviceDataPoints, TypedDict, total=False):
-    """The Device Data class, covering the collected and ordere output-data per device."""
-
     binary_sensors: SmileBinarySensors
     domestic_hot_water_setpoint: ActuatorData | float
     maximum_boiler_temperature: ActuatorData | float
     sensors: SmileSensors
     switches: SmileSwitches
     thermostat: ActuatorData
+
+
+@dataclass
+class PlugwiseData:
+    """Plugwise data provided as output."""
+
+    gateway: GatewayData
+    devices: dict[str, DeviceData]