aioWiserHeatAPI 1.5.17__tar.gz → 1.5.19__tar.gz

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.17
+Version: 1.5.19
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
@@ -10,7 +10,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: zeroconf>=0.131.0
@@ -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.17
+# Drayton Wiser Hub API Async v1.5.19
 
 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.19
+* Fixed error when BoilerInterface does not provide DeviceId field
+* Fixed not supporting non ascii characters in schedule names
+* Added ButtonPanel device support
+
+### 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

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.17
+# Drayton Wiser Hub API Async v1.5.19
 
 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.19
+* Fixed error when BoilerInterface does not provide DeviceId field
+* Fixed not supporting non ascii characters in schedule names
+* Added ButtonPanel device support
+
+### 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

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/aioWiserHeatAPI/__init__.py

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

aiowiserheatapi-1.5.19/aioWiserHeatAPI/button_panel.py

@@ -0,0 +1,43 @@
+from typing import Any
+
+from .helpers.device import _WiserDevice
+
+
+class _WiserButtonPanel(_WiserDevice):
+    """Class representing a Wiser Button Panel"""
+
+    @property
+    def number_of_gangs(self) -> list[int]:
+        """Number of gangs."""
+        return self._device_type_data.get("NumberOfGangs")
+
+    @property
+    def events(self) -> list[dict[str, Any]]:
+        """Events info."""
+        return self._device_type_data.get("Events")
+
+
+class _WiserButtonPanelCollection:
+    """Class holding all Wiser Button Panels"""
+
+    def __init__(self):
+        self._items = []
+
+    @property
+    def all(self) -> list[_WiserButtonPanel]:
+        return list(self._items)
+
+    @property
+    def count(self) -> int:
+        return len(self.all)
+
+    def get_by_id(self, id: int) -> _WiserButtonPanel:
+        """
+        Gets a button panel object from the sensor id
+        param id: id of button panel
+        return: _WiserButtonPanel object
+        """
+        try:
+            return [buttonpanel for buttonpanel in self.all if buttonpanel.id == id][0]
+        except IndexError:
+            return None

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/aioWiserHeatAPI/const.py

@@ -105,6 +105,7 @@ WISERPOWERTAGENERGY = "PTE/{}"
 WISERSMOKEALARM = "SmokeAlarmDevice/{}"
 WISERBINARYSENSOR = "BinarySensor/{}"
 WISERBOILERINTERFACE = "BoilerInterface/{}"
+WISERBUTTONPANEL = "ButtonPanel/{}"
 
 
 # Enums

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/aioWiserHeatAPI/devices.py

@@ -4,15 +4,14 @@ Module to manage all devices
 
 import enum
 
-from .binary_sensor import (
-    _WiserBinarySensorCollection,
-    _WiserWindowDoorSensor,
-)
+from .binary_sensor import _WiserBinarySensorCollection, _WiserWindowDoorSensor
 from .boiler_interface import _WiserBoilerInterface, _WiserBoilerInterfaceCollection
+from .button_panel import _WiserButtonPanel, _WiserButtonPanelCollection
 from .const import (
     TEXT_UNKNOWN,
     WISERBINARYSENSOR,
     WISERBOILERINTERFACE,
+    WISERBUTTONPANEL,
     WISERHEATINGACTUATOR,
     WISERLIGHT,
     WISERPOWERTAGENERGY,
@@ -23,10 +22,7 @@ from .const import (
     WISERSMOKEALARM,
     WISERUFHCONTROLLER,
 )
-from .heating_actuator import (
-    _WiserHeatingActuator,
-    _WiserHeatingActuatorCollection,
-)
+from .heating_actuator import _WiserHeatingActuator, _WiserHeatingActuatorCollection
 from .helpers.device import _WiserDevice
 from .light import _WiserDimmableLight, _WiserLight, _WiserLightCollection
 from .pte import _WiserPowerTagEnergy, _WiserPowerTagEnergyCollection
@@ -54,6 +50,7 @@ class _WiserDeviceTypeEnum(enum.Enum):
     WindowDoorSensor = "BinarySensor"
     BoilerInterface = "BoilerInterface"
     CFMT = "HeatingActuator"
+    ButtonPanel = "ButtonPanel"
 
 
 PRODUCT_TYPE_CONFIG = {
@@ -93,47 +90,40 @@ PRODUCT_TYPE_CONFIG = {
         "class": _WiserShutter,
         "collection": _WiserShutterCollection,
         "endpoint": WISERSHUTTER,
-        "device_id_field": "DeviceId",
         "schedule_type": WiserScheduleTypeEnum.level,
     },
     "OnOffLight": {
         "class": _WiserLight,
         "collection": _WiserLightCollection,
         "endpoint": WISERLIGHT,
-        "device_id_field": "DeviceId",
         "schedule_type": WiserScheduleTypeEnum.level,
     },
     "DimmableLight": {
         "class": _WiserDimmableLight,
         "collection": _WiserLightCollection,
         "endpoint": WISERLIGHT,
-        "device_id_field": "DeviceId",
         "schedule_type": WiserScheduleTypeEnum.level,
     },
     "PowerTagE": {
         "class": _WiserPowerTagEnergy,
         "collection": _WiserPowerTagEnergyCollection,
         "endpoint": WISERPOWERTAGENERGY,
-        "device_id_field": "DeviceId",
         "has_v2_equipment": True,
     },
     "SmokeAlarmDevice": {
         "class": _WiserSmokeAlarm,
         "collection": _WiserSmokeAlarmCollection,
         "endpoint": WISERSMOKEALARM,
-        "device_id_field": "DeviceId",
     },
     "WindowDoorSensor": {
         "class": _WiserWindowDoorSensor,
         "collection": _WiserBinarySensorCollection,
         "endpoint": WISERBINARYSENSOR,
-        "device_id_field": "DeviceId",
     },
     "BoilerInterface": {
         "class": _WiserBoilerInterface,
         "collection": _WiserBoilerInterfaceCollection,
         "endpoint": WISERBOILERINTERFACE,
-        "device_id_field": "DeviceId",
     },
     "CFMT": {
         "class": _WiserHeatingActuator,
@@ -142,6 +132,11 @@ PRODUCT_TYPE_CONFIG = {
         "heating": True,
         "has_v2_equipment": True,
     },
+    "ButtonPanel": {
+        "class": _WiserButtonPanel,
+        "collection": _WiserButtonPanelCollection,
+        "endpoint": WISERBUTTONPANEL,
+    },
 }
 
 
@@ -196,10 +191,14 @@ class _WiserDeviceCollection:
                         for device_info in self._domain_data.get(
                             _WiserDeviceTypeEnum[device_type].value
                         )
-                        if device_info.get(device_config.get("device_id_field", "id"))
+                        if device_info.get("DeviceId", device_info.get("id"))
                         == device.get("id")
                     ]
 
+                    # Safety net to prevent error if device info not found
+                    if not device_info:
+                        continue
+
                     # Get class to create and collection to append for device
                     device_class = PRODUCT_TYPE_CONFIG[device_type].get("class")
 

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/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
@@ -168,10 +175,10 @@ class _WiserRestController(object):
 
         # if data is not None:
         if data:
-            kwargs["json"] = data
+            kwargs["data"] = json.dumps(data, ensure_ascii=False).encode("utf8")
             kwargs["headers"].update(
                 {
-                    "Content-Type": "application/json;charset=UTF-8",
+                    "Content-Type": "application/json",
                 }
             )
         if self._timeout is not None:
@@ -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}"
@@ -237,19 +247,21 @@ class _WiserRestController(object):
         data: dict,
         raise_for_endpoint_error: bool = True,
     ):
-        if response.status == 400:
+        status = response.status
+
+        if status == 400:
             _LOGGER.debug("400 error")
-        if response.status == 401:
+        if status == 401:
             raise WiserHubAuthenticationError(
                 f"Error authenticating to Wiser Hub "
                 f"{self._wiser_connection_info.host}. Check your secret key"
             )
-        elif response.status == 404 and raise_for_endpoint_error:
+        elif status == 404 and raise_for_endpoint_error:
             raise WiserHubRESTError(
                 f"Rest endpoint not found on Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url}"
             )
-        elif response.status == 408:
+        elif status == 408:
             raise WiserHubConnectionError(
                 f"Connection timed out trying to communicate with Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url}"
@@ -258,7 +270,7 @@ class _WiserRestController(object):
             raise WiserHubRESTError(
                 f"Unknown error communicating with Wiser Hub "
                 f"{self._wiser_connection_info.host} for url {url} with data {data}. "
-                f"Error code is: {response.status}"
+                f"Error code is: {status}"
             )
 
     async def get_hub_data(self, url: str, raise_for_endpoint_error: bool = True):
@@ -363,4 +375,6 @@ class _WiserRestController(object):
                 f"{schedule_type}/{schedule_id}",
                 schedule_data,
             )
+        else:
+            result = None
         return result

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/aioWiserHeatAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.17
+Version: 1.5.19
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
@@ -10,7 +10,7 @@ Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3.11
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.11
+Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: zeroconf>=0.131.0
@@ -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.17
+# Drayton Wiser Hub API Async v1.5.19
 
 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.19
+* Fixed error when BoilerInterface does not provide DeviceId field
+* Fixed not supporting non ascii characters in schedule names
+* Added ButtonPanel device support
+
+### 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

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/aioWiserHeatAPI.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ aioWiserHeatAPI/__init__.py
 aioWiserHeatAPI/automation.py
 aioWiserHeatAPI/binary_sensor.py
 aioWiserHeatAPI/boiler_interface.py
+aioWiserHeatAPI/button_panel.py
 aioWiserHeatAPI/cli.py
 aioWiserHeatAPI/const.py
 aioWiserHeatAPI/devices.py

{aiowiserheatapi-1.5.17 → aiowiserheatapi-1.5.19}/setup.py

@@ -45,7 +45,7 @@ setuptools.setup(
         "aiofiles>=23.2.1",
         "pyyaml>=6.0.1",
     ],
-    python_requires=">=3.11",
+    python_requires=">=3.12",
     entry_points={
         "console_scripts": ["wiser = aioWiserHeatAPI.cli:main"],
     },