aioWiserHeatAPI 1.5.9__tar.gz → 1.5.11__tar.gz

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.9
+Version: 1.5.11
 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.8
+# Drayton Wiser Hub API Async v1.5.11
 
 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.11
+
+* Improve error management
+* Add additional debug logging
+
+### v1.5.10
+
+* Add retry routine to prevent hub response errors
+
 ### v1.5.9
 
 * Force schedules endpoint to use http/1.0

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.8
+# Drayton Wiser Hub API Async v1.5.11
 
 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.11
+
+* Improve error management
+* Add additional debug logging
+
+### v1.5.10
+
+* Add retry routine to prevent hub response errors
+
 ### v1.5.9
 
 * Force schedules endpoint to use http/1.0

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI/__init__.py

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

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI/const.py

@@ -30,6 +30,7 @@ TRV_BATTERY_LEVEL_MAPPING = {
 
 
 # Other Constants
+REST_RETRY_BACKOFF = [0.5, 1, 2, 3, 5]
 REST_BACKOFF_FACTOR = 1
 REST_RETRIES = 3
 REST_TIMEOUT = 10

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI/exceptions.py

@@ -3,6 +3,10 @@ class WiserHubConnectionError(Exception):
     pass
 
 
+class WiserHubResponseError(Exception):
+    """Response error mainly for bad request"""
+
+
 class WiserHubAuthenticationError(Exception):
     pass
 

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI/rest_controller.py

@@ -5,12 +5,14 @@ import enum
 import json
 import re
 from dataclasses import dataclass
+from datetime import datetime
 from typing import Optional
 
 import aiohttp
 
 from . import _LOGGER
 from .const import (
+    REST_RETRY_BACKOFF,
     REST_TIMEOUT,
     WISERHUBDOMAIN,
     WISERHUBSCHEDULES,
@@ -20,6 +22,7 @@ from .exceptions import (
     WiserExtraConfigError,
     WiserHubAuthenticationError,
     WiserHubConnectionError,
+    WiserHubResponseError,
     WiserHubRESTError,
 )
 from .helpers.extra_config import _WiserExtraConfig
@@ -81,17 +84,50 @@ class _WiserRestController(object):
         url: str,
         data: dict = None,
         raise_for_endpoint_error: bool = True,
+    ):
+        """Function to retry on response errors due to inconsistant isues reading from the hub."""
+        http_version = aiohttp.HttpVersion11
+        for i in range(0, 5):
+            if i > 2:
+                http_version = aiohttp.HttpVersion10
+            try:
+                response = await self._execute_request(
+                    action,
+                    url,
+                    data,
+                    raise_for_endpoint_error,
+                    http_version,
+                    i + 1,
+                )
+                return response
+            except WiserHubResponseError as ex:
+                # Last 2 attempts try http 1.0
+                _LOGGER.debug(
+                    "%s. Retrying in %.1fs", ex, REST_RETRY_BACKOFF[i]
+                )
+                # Backing off pause
+                await asyncio.sleep(REST_RETRY_BACKOFF[i])
+
+        raise WiserHubConnectionError(
+            f"Unable to get a valid response from the Wiser hub. "
+            f"{self._wiser_connection_info.host} for url {url}"
+        )
+
+    async def _execute_request(  # noqa
+        self,
+        action: WiserRestActionEnum,
+        url: str,
+        data: dict = None,
+        raise_for_endpoint_error: bool = True,
+        http_version=aiohttp.HttpVersion11,
+        attempt: int = 1,
     ):
         """
-        Send patch update 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
         """
-        if url in [WISERHUBDOMAIN]:
-            http_version = aiohttp.HttpVersion11
-        else:
-            http_version = aiohttp.HttpVersion10
 
         url = url.format(
             self._wiser_connection_info.host,
@@ -101,22 +137,30 @@ class _WiserRestController(object):
         kwargs = {}
         kwargs["headers"] = {
             "SECRET": self._wiser_connection_info.secret,
-            "Content-Type": "application/json;charset=UTF-8",
         }
 
-        if data is not None:
+        # if data is not None:
+        if data:
             kwargs["json"] = data
+            kwargs["headers"].update(
+                {
+                    "Content-Type": "application/json;charset=UTF-8",
+                }
+            )
         if self._timeout is not None:
             kwargs["timeout"] = self._timeout
 
         try:
+            _LOGGER.debug(
+                "URL: %s, Attempt: %i, Http: %s", url, attempt, http_version
+            )
             async with aiohttp.ClientSession(
                 version=http_version,
             ) as session:
-                async with getattr(session, action.value)(
-                    url,
-                    **kwargs,
+                async with session.request(
+                    action.value, url, **kwargs
                 ) as response:
+                    # await asyncio.sleep(1)
                     if not response.ok:
                         self._process_nok_response(
                             response, url, data, raise_for_endpoint_error
@@ -149,7 +193,7 @@ class _WiserRestController(object):
                 f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
             ) from ex
         except aiohttp.ClientResponseError as ex:
-            raise WiserHubConnectionError(
+            raise WiserHubResponseError(
                 f"Response error trying to communicate with Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url}.  Error is {ex}"
             ) from ex
@@ -166,6 +210,8 @@ class _WiserRestController(object):
         data: dict,
         raise_for_endpoint_error: bool = True,
     ):
+        if response.status == 400:
+            _LOGGER.debug("400 error")
         if response.status == 401:
             raise WiserHubAuthenticationError(
                 f"Error authenticating to Wiser Hub "
@@ -188,7 +234,7 @@ class _WiserRestController(object):
                 f"Error code is: {response.status}"
             )
 
-    async def _get_hub_data(
+    async def get_hub_data(
         self, url: str, raise_for_endpoint_error: bool = True
     ):
         """Get data from hub"""
@@ -198,7 +244,7 @@ class _WiserRestController(object):
             raise_for_endpoint_error=raise_for_endpoint_error,
         )
 
-    async def _get_extra_config_data(self):
+    async def get_extra_config_data(self):
         # Load extra config file
 
         if self._extra_config_file:

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI/wiserhub.py

@@ -12,13 +12,10 @@ https://github.com/asantaga/wiserheatingapi
 This API allows you to get information from and control your wiserhub.
 """
 
-# TODO: Keep objects and update instead of recreating on hub update
-# TODO: Update entity values after commend issued to get current values
 import pathlib
+from datetime import datetime
 from typing import Optional
 
-import aiohttp
-
 from . import __VERSION__, _LOGGER
 from .cli import log_response_to_file
 from .const import (
@@ -56,7 +53,7 @@ from .schedule import WiserScheduleTypeEnum, _WiserScheduleCollection
 from .system import _WiserSystem
 
 
-class WiserAPI(object):
+class WiserAPI:
     """
     Main api class to access all entities and attributes of wiser system
     """
@@ -67,12 +64,10 @@ class WiserAPI(object):
         secret: str,
         port: Optional[int] = 80,
         units: Optional[WiserUnitsEnum] = WiserUnitsEnum.metric,
-        session: Optional[aiohttp.ClientSession] = None,
         extra_config_file: Optional[str] = None,
         enable_automations: Optional[bool] = True,
     ):
         # Connection variables
-        self._session = session
         self._wiser_api_connection = _WiserConnectionInfo()
         self._wiser_rest_controller = None
 
@@ -123,6 +118,7 @@ class WiserAPI(object):
             )
 
     async def read_hub_data(self):
+        """Update data objects form the hub."""
         await self._build_objects()
 
         # Run automations
@@ -133,119 +129,150 @@ class WiserAPI(object):
             if await automations.run_automations():
                 await self._build_objects()
 
-    async def _build_objects(self):
-        """Read all data from hub and populate objects"""
-
-        # Read data from hub
-        self._domain_data = await self._wiser_rest_controller._get_hub_data(
-            WISERHUBDOMAIN
-        )
-        self._network_data = await self._wiser_rest_controller._get_hub_data(
-            WISERHUBNETWORK
-        )
-        self._schedule_data = await self._wiser_rest_controller._get_hub_data(
-            WISERHUBSCHEDULES
-        )
+    async def _get_hub_data(self) -> bool:
         try:
-            self._status_data = (
-                await self._wiser_rest_controller._get_hub_data(WISERHUBSTATUS)
+            start_time = datetime.now()
+            self._domain_data = await self._wiser_rest_controller.get_hub_data(
+                WISERHUBDOMAIN
             )
-        except WiserHubRESTError:
-            self._status_data = {}
-
-        # Set hub name on rest controller
-        self._wiser_rest_controller._hub_name = (
-            self._network_data.get("Station", {})
-            .get("NetworkInterface", {})
-            .get("HostName", "")
-        )
-
-        # load extra data
-        self._wiser_rest_controller._extra_config_file = (
-            self._extra_config_file
-        )
-        await self._wiser_rest_controller._get_extra_config_data()
+            self._network_data = (
+                await self._wiser_rest_controller.get_hub_data(WISERHUBNETWORK)
+            )
+            self._schedule_data = (
+                await self._wiser_rest_controller.get_hub_data(
+                    WISERHUBSCHEDULES
+                )
+            )
+            try:
+                self._status_data = (
+                    await self._wiser_rest_controller.get_hub_data(
+                        WISERHUBSTATUS
+                    )
+                )
+            except WiserHubRESTError:
+                self._status_data = {}
 
-        # Only get opentherm data if connected
-        if (
-            self._domain_data.get("System", {}).get(
+            # Only get opentherm data if connected
+            opentherm = self._domain_data.get("System", {}).get(
                 "OpenThermConnectionStatus", ""
             )
-            == "Connected"
-        ):
-            self._opentherm_data = (
-                await self._wiser_rest_controller._get_hub_data(
-                    WISERHUBOPENTHERM, False
+            if opentherm and opentherm == "Connected":
+                self._opentherm_data = (
+                    await self._wiser_rest_controller.get_hub_data(
+                        WISERHUBOPENTHERM, False
+                    )
                 )
+        except (
+            WiserHubConnectionError,
+            WiserHubAuthenticationError,
+            WiserHubRESTError,
+        ) as ex:
+            _LOGGER.debug("Update from Wiser hub failed. %s", ex)
+            raise ex
+        else:
+            # Set hub name on rest controller
+            self._wiser_rest_controller._hub_name = (
+                self._network_data.get("Station", {})
+                .get("NetworkInterface", {})
+                .get("HostName", "")
             )
 
-        if self._domain_data != {} and self._network_data != {}:
-            # System Object
-            _device_data = self._domain_data.get("Device", [])
-            self._system = _WiserSystem(
-                self._wiser_rest_controller,
-                self._domain_data,
-                self._network_data,
-                _device_data,
-                self._opentherm_data,
+            _LOGGER.debug(
+                "Update from %s successful and took %ss",
+                self._wiser_rest_controller._hub_name,
+                (datetime.now() - start_time).total_seconds(),
             )
+            return True
 
-            # Schedules Collection
-            self._schedules = _WiserScheduleCollection(
-                self._wiser_rest_controller,
-                self._schedule_data,
-                self._system.sunrise_times,
-                self._system.sunset_times,
-            )
+    async def _build_objects(self):
+        """Read all data from hub and populate objects"""
 
-            # Devices Collection
-            self._devices = _WiserDeviceCollection(
-                self._wiser_rest_controller, self._domain_data, self._schedules
-            )
+        # Read data from hub
+        try:
+            await self._get_hub_data()
 
-            # Rooms Collection
-            room_data = self._domain_data.get("Room", [])
-            self._rooms = _WiserRoomCollection(
-                self._wiser_rest_controller,
-                room_data,
-                self._schedules.get_by_type(WiserScheduleTypeEnum.heating),
-                self._devices,
-                self._enable_automations,
+            # load extra data
+            self._wiser_rest_controller._extra_config_file = (
+                self._extra_config_file
             )
+            await self._wiser_rest_controller.get_extra_config_data()
 
-            # Hot Water
-            if self._domain_data.get("HotWater"):
-                schedule = self._schedules.get_by_id(
-                    WiserScheduleTypeEnum.onoff,
-                    self._domain_data.get("HotWater")[0].get("ScheduleId", 0),
+            if self._domain_data != {} and self._network_data != {}:
+                # System Object
+                _device_data = self._domain_data.get("Device", [])
+                self._system = _WiserSystem(
+                    self._wiser_rest_controller,
+                    self._domain_data,
+                    self._network_data,
+                    _device_data,
+                    self._opentherm_data,
                 )
-                self._hotwater = _WiserHotwater(
+
+                # Schedules Collection
+                self._schedules = _WiserScheduleCollection(
                     self._wiser_rest_controller,
-                    self._domain_data.get("HotWater", {})[0],
-                    schedule,
+                    self._schedule_data,
+                    self._system.sunrise_times,
+                    self._system.sunset_times,
                 )
 
-            # Heating Channels
-            if self._domain_data.get("HeatingChannel"):
-                self._heating_channels = _WiserHeatingChannelCollection(
-                    self._domain_data.get("HeatingChannel"), self._rooms
+                # Devices Collection
+                self._devices = _WiserDeviceCollection(
+                    self._wiser_rest_controller,
+                    self._domain_data,
+                    self._schedules,
                 )
 
-            # Moments
-            if self._domain_data.get("Moment"):
-                self._moments = _WiserMomentCollection(
+                # Rooms Collection
+                room_data = self._domain_data.get("Room", [])
+                self._rooms = _WiserRoomCollection(
                     self._wiser_rest_controller,
-                    self._domain_data.get("Moment"),
+                    room_data,
+                    self._schedules.get_by_type(WiserScheduleTypeEnum.heating),
+                    self._devices,
+                    self._enable_automations,
                 )
 
-            # If gets here with no exceptions then success and return true
-            return True
+                # Hot Water
+                if self._domain_data.get("HotWater"):
+                    schedule = self._schedules.get_by_id(
+                        WiserScheduleTypeEnum.onoff,
+                        self._domain_data.get("HotWater")[0].get(
+                            "ScheduleId", 0
+                        ),
+                    )
+                    self._hotwater = _WiserHotwater(
+                        self._wiser_rest_controller,
+                        self._domain_data.get("HotWater", {})[0],
+                        schedule,
+                    )
+
+                # Heating Channels
+                if self._domain_data.get("HeatingChannel"):
+                    self._heating_channels = _WiserHeatingChannelCollection(
+                        self._domain_data.get("HeatingChannel"), self._rooms
+                    )
+
+                # Moments
+                if self._domain_data.get("Moment"):
+                    self._moments = _WiserMomentCollection(
+                        self._wiser_rest_controller,
+                        self._domain_data.get("Moment"),
+                    )
 
-        return False
+                # If gets here with no exceptions then success and return true
+                return True
+        except (
+            WiserHubConnectionError,
+            WiserHubAuthenticationError,
+            WiserHubRESTError,
+        ) as ex:
+            raise ex
 
     # API properties
     @property
     def api_parameters(self):
+        """Rest control api parameters."""
         return self._wiser_rest_controller._api_parameters
 
     @property
@@ -329,7 +356,7 @@ class WiserAPI(object):
 
         # Get raw json data
         if endpoint:
-            data = self._wiser_rest_controller._get_hub_data(endpoint)
+            data = self._wiser_rest_controller.get_hub_data(endpoint)
             try:
                 if data:
                     # Write out to file

{aioWiserHeatAPI-1.5.9 → aioWiserHeatAPI-1.5.11}/aioWiserHeatAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.9
+Version: 1.5.11
 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.8
+# Drayton Wiser Hub API Async v1.5.11
 
 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.11
+
+* Improve error management
+* Add additional debug logging
+
+### v1.5.10
+
+* Add retry routine to prevent hub response errors
+
 ### v1.5.9
 
 * Force schedules endpoint to use http/1.0