aioWiserHeatAPI 1.5.16__tar.gz → 1.5.18__tar.gz

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.16
+Version: 1.5.18
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
@@ -18,7 +18,7 @@ Requires-Dist: aiohttp>=3.9.3
 Requires-Dist: aiofiles>=23.2.1
 Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.16
+# Drayton Wiser Hub API Async v1.5.18
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -72,6 +72,15 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.18
+
+* Better handle client response exeption and fit into retry routing
+
+### v1.5.17
+
+* Fixed error setting opentherm endpoint for fw above 4.32.46
+* Added support for CFMT devices
+
 ### v1.5.16
 
 * Added support for v2 opentherm endpoint for fw above 4.32.46

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.16
+# Drayton Wiser Hub API Async v1.5.18
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -52,6 +52,15 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.18
+
+* Better handle client response exeption and fit into retry routing
+
+### v1.5.17
+
+* Fixed error setting opentherm endpoint for fw above 4.32.46
+* Added support for CFMT devices
+
 ### v1.5.16
 
 * Added support for v2 opentherm endpoint for fw above 4.32.46

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/aioWiserHeatAPI/__init__.py

@@ -3,6 +3,6 @@ import logging
 name = "aioWiserHeatAPI"
 __all__ = ["wiserAPI", "wiserDiscovery"]
 
-__VERSION__ = "1.5.16"
+__VERSION__ = "1.5.18"
 
 _LOGGER = logging.getLogger(__name__)

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/aioWiserHeatAPI/devices.py

@@ -53,6 +53,7 @@ class _WiserDeviceTypeEnum(enum.Enum):
     SmokeAlarmDevice = "SmokeAlarmDevice"
     WindowDoorSensor = "BinarySensor"
     BoilerInterface = "BoilerInterface"
+    CFMT = "HeatingActuator"
 
 
 PRODUCT_TYPE_CONFIG = {
@@ -134,6 +135,13 @@ PRODUCT_TYPE_CONFIG = {
         "endpoint": WISERBOILERINTERFACE,
         "device_id_field": "DeviceId",
     },
+    "CFMT": {
+        "class": _WiserHeatingActuator,
+        "collection": _WiserHeatingActuatorCollection,
+        "endpoint": WISERHEATINGACTUATOR,
+        "heating": True,
+        "has_v2_equipment": True,
+    },
 }
 
 
@@ -197,9 +205,10 @@ class _WiserDeviceCollection:
 
                     # If heating device add room id
                     if device_config.get("heating"):
-                        device_info[0]["RoomId"] = self._get_temp_device_room_id(
-                            self._domain_data, device.get("id")
-                        )
+                        if not device.get("RoomId"):
+                            device_info[0]["RoomId"] = self._get_temp_device_room_id(
+                                self._domain_data, device.get("id")
+                            )
 
                     # If schedule device add schedule
                     if device_config.get("schedule_type"):

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/aioWiserHeatAPI/helpers/opentherm.py

@@ -3,7 +3,7 @@ from ..rest_controller import WiserRestActionEnum, _WiserRestController
 from .temp import _WiserTemperatureFunctions as tf
 
 
-class _WiserOpenThermBoilerParameters(object):
+class _WiserOpenThermBoilerParameters:
     """Data structure for Opentherm Boiler Parameters data"""
 
     def __init__(self, data: dict):
@@ -19,9 +19,7 @@ class _WiserOpenThermBoilerParameters(object):
 
     @property
     def ch_setpoint(self) -> bool:
-        return tf._from_wiser_temp(
-            self._data.get("maxChSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("maxChSetpoint", None), "current")
 
     @property
     def ch_setpoint_lower_bound(self) -> bool:
@@ -45,9 +43,7 @@ class _WiserOpenThermBoilerParameters(object):
 
     @property
     def hw_setpoint(self) -> bool:
-        return tf._from_wiser_temp(
-            self._data.get("dhwSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("dhwSetpoint", None), "current")
 
     @property
     def hw_setpoint_lower_bound(self) -> bool:
@@ -66,7 +62,7 @@ class _WiserOpenThermBoilerParameters(object):
         return self._data
 
 
-class _WiserOpenThermOperationalData(object):
+class _WiserOpenThermOperationalData:
     """Data structure for Opentherm Boiler Parameters data"""
 
     def __init__(self, data):
@@ -99,9 +95,7 @@ class _WiserOpenThermOperationalData(object):
     @property
     def hw_temperature(self) -> str:
         """Get Dhw1Temperature"""
-        return tf._from_wiser_temp(
-            self._data.get("Dhw1Temperature", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("Dhw1Temperature", None), "current")
 
     @property
     def relative_modulation_level(self) -> int:
@@ -120,6 +114,58 @@ class _WiserOpenThermOperationalData(object):
         return self._data
 
 
+class _WiserOpenThermExtendedDiagnostics:
+    """Data structure for Opentherm extended diagnostics."""
+
+    def __init__(self, data: dict[str, int | str]):
+        self._data = data
+
+    @property
+    def unsuccessful_burner_starts(self) -> int:
+        """Get unsuccessfulBurnerStarts"""
+        return self._data.get("unsuccessfulBurnerStarts", 0)
+
+    @property
+    def number_flame_signal_too_low(self) -> int:
+        """Get numberFlameSignalTooLow"""
+        return self._data.get("numberFlameSignalTooLow", 0)
+
+    @property
+    def oem_specific_service_code(self) -> int:
+        """Get oemSpecificServiceCode"""
+        return self._data.get("oemSpecificServiceCode", 0)
+
+    @property
+    def successful_burner_starts(self) -> int:
+        """Get successfulBurnerStarts"""
+        return self._data.get("successfulBurnerStarts", 0)
+
+    @property
+    def ch_pump_starts(self) -> int:
+        """Get chPumpStarts"""
+        return self._data.get("chPumpStarts", 0)
+
+    @property
+    def dhw_pump_or_valve_starts(self) -> int:
+        """Get dhwPumpOrValveStarts"""
+        return self._data.get("dhwPumpOrValveStarts", 0)
+
+    @property
+    def burner_starts_during_dhw_mode(self) -> int:
+        """Get burnerStartsDuringDhwMode"""
+        return self._data.get("burnerStartsDuringDhwMode", 0)
+
+    @property
+    def burner_hours(self) -> int:
+        """Get burnerHours"""
+        return self._data.get("burnerHours", 0)
+
+    @property
+    def ch_pump_hours(self) -> int:
+        """Get chPumpHours"""
+        return self._data.get("chPumpHours", 0)
+
+
 class _WiserOpentherm(object):
     """Data structure for Opentherm data"""
 
@@ -160,9 +206,7 @@ class _WiserOpentherm(object):
     @property
     def ch1_flow_setpoint(self) -> float:
         """Get ch1FlowSetpoint"""
-        return tf._from_wiser_temp(
-            self._data.get("ch1FlowSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("ch1FlowSetpoint", None), "current")
 
     @property
     def ch2_flow_enabled(self) -> bool:
@@ -172,9 +216,7 @@ class _WiserOpentherm(object):
     @property
     def ch2_flow_setpoint(self) -> float:
         """Get ch2FlowSetpoint"""
-        return tf._from_wiser_temp(
-            self._data.get("ch2FlowSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("ch2FlowSetpoint", None), "current")
 
     @property
     def connection_status(self) -> str:
@@ -194,9 +236,7 @@ class _WiserOpentherm(object):
     @property
     def hw_flow_setpoint(self) -> float:
         """Get dhwFlowSetpoint"""
-        return tf._from_wiser_temp(
-            self._data.get("dhwFlowSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("dhwFlowSetpoint", None), "current")
 
     @property
     def operating_mode(self) -> str:
@@ -205,9 +245,7 @@ class _WiserOpentherm(object):
 
     @property
     def operational_data(self) -> _WiserOpenThermOperationalData:
-        return _WiserOpenThermOperationalData(
-            self._data.get("operationalData", {})
-        )
+        return _WiserOpenThermOperationalData(self._data.get("operationalData", {}))
 
     @property
     def boiler_parameters(self) -> _WiserOpenThermBoilerParameters:
@@ -215,19 +253,21 @@ class _WiserOpentherm(object):
             self._data.get("preDefinedRemoteBoilerParameters", {})
         )
 
+    @property
+    def extended_diagnostics(self) -> _WiserOpenThermExtendedDiagnostics:
+        return _WiserOpenThermExtendedDiagnostics(
+            self._data.get("extendedDiagnostics", {})
+        )
+
     @property
     def room_setpoint(self) -> float:
         """Get roomTemperature"""
-        return tf._from_wiser_temp(
-            self._data.get("roomSetpoint", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("roomSetpoint", None), "current")
 
     @property
     def room_temperature(self) -> float:
         """Get roomTemperature"""
-        return tf._from_wiser_temp(
-            self._data.get("roomTemperature", None), "current"
-        )
+        return tf._from_wiser_temp(self._data.get("roomTemperature", None), "current")
 
     @property
     def tracked_room_id(self) -> int:
@@ -238,9 +278,7 @@ class _WiserOpentherm(object):
     def json_data(self) -> dict:
         return self._data
 
-    async def set_opentherm_parameter(
-        self, endpoint: str, cmd_data: str
-    ) -> bool:
+    async def set_opentherm_parameter(self, endpoint: str, cmd_data: str) -> bool:
         """Allow settign of opentherm param"""
         return await self._wiser_rest_controller._do_hub_action(
             WiserRestActionEnum.PATCH,

aiowiserheatapi-1.5.18/aioWiserHeatAPI/helpers/version.py

@@ -0,0 +1,48 @@
+"""Version helpers."""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class Version:
+    """Class to handle PEP440 versions."""
+
+    version: str
+
+    def __gt__(self, other):
+        if isinstance(other, Version):
+            return self._version_compare(self.version, other.version) == 1
+
+    def __ge__(self, other):
+        if isinstance(other, Version):
+            return self.__eq__(other) or self.__gt__(other)
+
+    def __lt__(self, other):
+        if isinstance(other, Version):
+            return self._version_compare(self.version, other.version) == -1
+
+    def __le__(self, other):
+        if isinstance(other, Version):
+            return self.__eq__(other) or self.__lt__(other)
+
+    def __eq__(self, other):
+        if isinstance(other, Version):
+            return self._version_compare(self.version, other.version) == 0
+
+    def _version_compare(self, v1: str, v2: str) -> int:
+        version1 = v1.replace("-", ".").split(".")
+        version2 = v2.replace("-", ".").split(".")
+
+        length = max(len(version1), len(version2))
+
+        # Compare each component of the version strings.
+        for i in range(length):
+            v1_itm = int(version1[i]) if version1[i].isdigit() else version1[i]
+            v2_itm = int(version2[i]) if version2[i].isdigit() else version2[i]
+
+            if v1_itm > v2_itm:
+                return 1
+            if v1_itm < v2_itm:
+                return -1
+
+        return 0

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/aioWiserHeatAPI/rest_controller.py

@@ -9,6 +9,7 @@ from datetime import datetime
 from typing import Optional
 
 import aiohttp
+import aiohttp.client_exceptions
 import aiohttp.http_exceptions
 
 from . import _LOGGER
@@ -95,7 +96,7 @@ class _WiserRestController(object):
         http_version = aiohttp.HttpVersion11
         self._last_exception = None
 
-        for i in range(0, 5):
+        for i in range(5):
             if i > 0:
                 await asyncio.sleep(REST_RETRY_BACKOFF[i])
             try:
@@ -120,7 +121,7 @@ class _WiserRestController(object):
                     "Request successful and took %ss",
                     (datetime.now() - start_time).total_seconds(),
                 )
-                return response
+
             except WiserHubRESTError as ex:
                 # if json error try http1.1
                 _LOGGER.debug("%s. Retrying in %.1fs", ex, REST_RETRY_BACKOFF[i])
@@ -135,19 +136,25 @@ class _WiserRestController(object):
                 # Connection timed out or failed.  Try it again
                 _LOGGER.debug("%s. Retrying in %.1fs", ex, REST_RETRY_BACKOFF[i])
                 self._last_exception = ex
+            except Exception as ex:
+                # Unknown error
+                _LOGGER.debug("%s. Retrying in %.1fs", ex, REST_RETRY_BACKOFF[i])
+                self._last_exception = ex
+            else:
+                return response
 
         raise WiserHubConnectionError(self._last_exception)
 
-    async def _execute_request(  # noqa
+    async def _execute_request(
         self,
         action: WiserRestActionEnum,
         url: str,
-        data: dict = None,
+        data: dict | None = None,
         raise_for_endpoint_error: bool = True,
         http_version=aiohttp.HttpVersion11,
     ):
-        """
-        Send request to hub and raise errors if fails
+        """Send request to hub and raise errors if fails.
+
         param url: url of hub rest api endpoint
         param patchData: json object containing command and values to set
         return: boolean
@@ -224,7 +231,10 @@ class _WiserRestController(object):
                 f"Connection error trying to communicate with Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
             ) from ex
-        except aiohttp.http_exceptions.TransferEncodingError as ex:
+        except (
+            aiohttp.client_exceptions.ClientPayloadError,
+            aiohttp.http_exceptions.TransferEncodingError,
+        ) as ex:
             raise WiserHubConnectionError(
                 f"Response payload incomplete error trying to communicate with Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
@@ -363,4 +373,6 @@ class _WiserRestController(object):
                 f"{schedule_type}/{schedule_id}",
                 schedule_data,
             )
+        else:
+            result = None
         return result

{aiowiserheatapi-1.5.16 → aiowiserheatapi-1.5.18}/aioWiserHeatAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.16
+Version: 1.5.18
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
@@ -18,7 +18,7 @@ Requires-Dist: aiohttp>=3.9.3
 Requires-Dist: aiofiles>=23.2.1
 Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.16
+# Drayton Wiser Hub API Async v1.5.18
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -72,6 +72,15 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.18
+
+* Better handle client response exeption and fit into retry routing
+
+### v1.5.17
+
+* Fixed error setting opentherm endpoint for fw above 4.32.46
+* Added support for CFMT devices
+
 ### v1.5.16
 
 * Added support for v2 opentherm endpoint for fw above 4.32.46

aiowiserheatapi-1.5.16/aioWiserHeatAPI/helpers/version.py

@@ -1,67 +0,0 @@
-"""Version helpers."""
-
-from dataclasses import dataclass
-
-
-@dataclass
-class Version:
-    """Class to handle PEP440 versions."""
-
-    version: str
-
-    def __gt__(self, other):
-        if isinstance(other, Version):
-            return (
-                self.major >= other.major
-                and self.minor >= other.minor
-                and self.micro > other.micro
-            )
-
-    def __ge__(self, other):
-        if isinstance(other, Version):
-            return self.__eq__(other) or self.__gt__(other)
-
-    def __lt__(self, other):
-        if isinstance(other, Version):
-            return (
-                self.major <= other.major
-                and self.minor <= other.minor
-                and self.micro < other.micro
-            )
-
-    def __le__(self, other):
-        if isinstance(other, Version):
-            return self.__eq__(other) or self.__lt__(other)
-
-    def __eq__(self, other):
-        if isinstance(other, Version):
-            return (
-                self.major == other.major
-                and self.minor == other.minor
-                and self.micro == other.micro
-            )
-
-    @property
-    def major(self) -> int:
-        """Get major version."""
-        try:
-            return self.version.split(".")[0]
-        except IndexError:
-            return None
-
-    @property
-    def minor(self) -> int:
-        """Get minor version."""
-        try:
-            return self.version.split(".")[1]
-        except IndexError:
-            return None
-
-    @property
-    def micro(self) -> int:
-        """Get micro version."""
-        try:
-            full_micro = self.version.split(".")[2]
-            return full_micro.split("-")[0]
-        except IndexError:
-            return None