aioWiserHeatAPI 1.7.7__tar.gz → 1.7.8__tar.gz

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioWiserHeatAPI
-Version: 1.7.7
+Version: 1.7.8
 Summary: An AsyncIO API for controlling the Drayton Wiser Heating system
 Home-page: https://github.com/msp1974/aioWiserHeatAPI
 Author: Mark Parker
@@ -28,7 +28,7 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-# Drayton Wiser Hub API Async v1.7.7
+# Drayton Wiser Hub API Async v1.7.8
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -86,6 +86,17 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.7.8
+
+- Added: Standalone equipment collection through `devices.equipments`, including equipment lookup, available control states, overview schedule IDs, and equipment/EVSE rated power values
+- Added: Create, update, enable, disable, and delete native equipment under-power and over-power notifications
+- Added: Enable or disable native smoke alarm notifications and configure window/door sensor notification modes
+- Added: Hub automation collection through `automations`, with cached automation details (triggers, actions, and time constraints), enable/disable controls, notification controls, and deletion
+- Fix: Retry requests over HTTPS when the hub redirects HTTP traffic or explicitly reports that HTTPS is required, while preserving the configured host and port mapping
+- Fix: Send JSON command payloads containing `false`, `0`, or empty values instead of omitting them
+- Fix: Accept successful EVSE commands with empty responses and preserve existing equipment telemetry when responses contain only changed fields
+- Fix: Correct over-power notification data and preserve zero values, disabled states, and missing settings in partial notification records
+
 ### v1.7.7
 
 - Fix: Avoid eager `aiofiles.os` imports during startup to prevent mixed-version import failures in Home Assistant (issue #763)

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.7.7
+# Drayton Wiser Hub API Async v1.7.8
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -56,6 +56,17 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.7.8
+
+- Added: Standalone equipment collection through `devices.equipments`, including equipment lookup, available control states, overview schedule IDs, and equipment/EVSE rated power values
+- Added: Create, update, enable, disable, and delete native equipment under-power and over-power notifications
+- Added: Enable or disable native smoke alarm notifications and configure window/door sensor notification modes
+- Added: Hub automation collection through `automations`, with cached automation details (triggers, actions, and time constraints), enable/disable controls, notification controls, and deletion
+- Fix: Retry requests over HTTPS when the hub redirects HTTP traffic or explicitly reports that HTTPS is required, while preserving the configured host and port mapping
+- Fix: Send JSON command payloads containing `false`, `0`, or empty values instead of omitting them
+- Fix: Accept successful EVSE commands with empty responses and preserve existing equipment telemetry when responses contain only changed fields
+- Fix: Correct over-power notification data and preserve zero values, disabled states, and missing settings in partial notification records
+
 ### v1.7.7
 
 - Fix: Avoid eager `aiofiles.os` imports during startup to prevent mixed-version import failures in Home Assistant (issue #763)

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/__init__.py

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

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/automation.py

@@ -1,8 +1,13 @@
 import inspect
 
 from . import _LOGGER
-from .const import TEXT_UNKNOWN, WISERSYSTEM
-from .rest_controller import _WiserRestController
+from .const import (
+    TEXT_UNKNOWN,
+    WISERAUTOMATION,
+    WISERHUBAUTOMATION,
+    WISERSYSTEM,
+)
+from .rest_controller import WiserRestActionEnum, _WiserRestController
 
 
 class _WiserAutomation:
@@ -11,6 +16,8 @@ class _WiserAutomation:
     ):
         self._wiser_rest_controller = wiser_rest_controller
         self._automation_data = automation_data
+        self._details = {}
+        self._details_loaded = False
 
     async def _send_command(self, cmd: dict) -> bool:
         """
@@ -46,10 +53,48 @@ class _WiserAutomation:
     def notification_enabled(self) -> bool:
         return self._automation_data.get("EnableNotification", False)
 
+    async def get_details(self, refresh: bool = False) -> dict:
+        """Return the automation triggers, actions and time constraints."""
+        if refresh or not self._details_loaded:
+            details = await self._wiser_rest_controller.get_hub_data(
+                f"{WISERHUBAUTOMATION}{self.id}",
+                False,
+            )
+            self._details = details if isinstance(details, dict) else {}
+            self._details_loaded = True
+        return self._details.copy()
+
     async def enable_notification(self):
         """Activate automation"""
         return await self._send_command({"EnableNotification": self.id})
 
+    async def set_notification_enabled(self, enabled: bool) -> bool:
+        """Enable or disable notifications for this automation."""
+        await self._wiser_rest_controller._send_command(
+            f"{WISERAUTOMATION.format(self.id)}/EnableNotification",
+            enabled,
+        )
+        self._automation_data["EnableNotification"] = enabled
+        return True
+
+    async def set_enabled(self, enabled: bool) -> bool:
+        """Enable or disable this automation."""
+        await self._wiser_rest_controller._send_command(
+            f"{WISERAUTOMATION.format(self.id)}/Enabled",
+            enabled,
+        )
+        self._automation_data["Enabled"] = enabled
+        return True
+
+    async def delete(self) -> bool:
+        """Delete this automation from the hub."""
+        await self._wiser_rest_controller._send_command(
+            WISERAUTOMATION.format(self.id),
+            None,
+            WiserRestActionEnum.DELETE,
+        )
+        return True
+
 
 class _WiserAutomationCollection(object):
     def __init__(

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/binary_sensor.py

@@ -6,6 +6,7 @@ import inspect
 
 from aioWiserHeatAPI import _LOGGER
 
+from .const import WiserWindowDoorEnableNotificationEnum
 from .helpers.battery import _WiserBattery
 from .helpers.device import _WiserDevice
 from .helpers.threshold import _WiserThresholdSensor
@@ -60,10 +61,54 @@ class _WiserBinarySensor(_WiserDevice):
         return self._device_type_data.get("Type")
 
     @property
-    def enable_notification(self) -> str:
-        """Get if notifications is enable"""
+    def enable_notification(self) -> str | None:
+        """Return the native notification mode, when supported."""
         return self._device_type_data.get("EnableNotification")
 
+    @property
+    def available_enable_notification(self) -> list[str]:
+        """Return the native notification modes accepted by the hub."""
+        return [mode.value for mode in WiserWindowDoorEnableNotificationEnum]
+
+    @property
+    def notification_enabled(self) -> bool | None:
+        """Return whether any native notification mode is enabled."""
+        mode = self.enable_notification
+        if mode is None:
+            return None
+        if isinstance(mode, bool):
+            return mode
+        return mode != WiserWindowDoorEnableNotificationEnum.none.value
+
+    async def set_enable_notification(
+        self,
+        enable_notification: WiserWindowDoorEnableNotificationEnum | str,
+    ) -> bool:
+        """Set the native notification mode for this sensor."""
+        if isinstance(
+            enable_notification, WiserWindowDoorEnableNotificationEnum
+        ):
+            enable_notification = enable_notification.value
+        if enable_notification not in self.available_enable_notification:
+            raise ValueError(
+                f"{enable_notification} is not a valid notification mode. "
+                f"Valid modes are {self.available_enable_notification}"
+            )
+        await self._wiser_rest_controller._send_command(
+            self._endpoint.format(self.device_type_id),
+            {"EnableNotification": enable_notification},
+        )
+        self._device_type_data["EnableNotification"] = enable_notification
+        return True
+
+    async def set_notification_enabled(self, enabled: bool) -> bool:
+        """Enable or disable native notifications for this sensor."""
+        return await self.set_enable_notification(
+            WiserWindowDoorEnableNotificationEnum.oneither
+            if enabled
+            else WiserWindowDoorEnableNotificationEnum.none
+        )
+
     @property
     def battery(self) -> _WiserBattery:
         """Get the battery information for the smokealarm"""

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/const.py

@@ -93,6 +93,7 @@ WISERHUBSCHEDULES = WISERHUBURL + "schedules/"
 WISERHUBOPENTHERM = WISERHUBURL + "opentherm/"
 WISERHUBOPENTHERMV2 = WISERHUBURL + "openTherm/"
 WISERHUBSTATUS = WISERHUBURL + "status/"
+WISERHUBAUTOMATION = "{}:{}/Automation/"
 WISERSYSTEM = "System"
 WISERDEVICE = "Device/{}"
 WISERHOTWATER = "HotWater/{}"
@@ -113,6 +114,7 @@ WISERBUTTONPANEL = "ButtonPanel/{}"
 WISEREQUIPMENT = "Equipment/{}"
 WISERTHRESHOLDSENSOR = "ThresholdSensor/{}"
 WISERUICONFIGURATION = "UIConfiguration/{}"
+WISERAUTOMATION = "Automation/{}"
 
 
 # Enums
@@ -131,6 +133,15 @@ class WiserTempLimitsEnum(enum.Enum):
     floorHeatingOffset = {"min": -9, "max": 9, "type": "range"}
 
 
+class WiserWindowDoorEnableNotificationEnum(enum.Enum):
+    """Native notification modes supported by window and door sensors."""
+
+    oneither = "OnEither"
+    none = "None"
+    ontrue = "OnTrue"
+    onfalse = "OnFalse"
+
+
 class WiserAwayActionEnum(enum.Enum):
     off = TEXT_OFF
     nochange = TEXT_NO_CHANGE

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/devices.py

@@ -29,6 +29,7 @@ from .const import (
     WISERUICONFIGURATION,
 )
 from .evse import _WiserEVSE, _WiserEVSECollection
+from .equipments import _WiserEquipmentsCollection
 from .heating_actuator import _WiserHeatingActuator, _WiserHeatingActuatorCollection
 from .helpers.device import _WiserDevice
 from .helpers.threshold import (
@@ -182,7 +183,13 @@ class _WiserDeviceCollection:
         self._wiser_rest_controller = wiser_rest_controller
         self._device_data = domain_data.get("Device", {})
         self._domain_data = domain_data
-        self._equipment_data = domain_data.get("Equipment", {})  # Supported by v2 hub
+        equipment_data = domain_data.get("Equipment")
+        self._equipment_data = (
+            equipment_data if isinstance(equipment_data, list) else []
+        )
+        self._equipments = _WiserEquipmentsCollection(
+            wiser_rest_controller, self._equipment_data
+        )
         self._schedules = schedules
         self._device_collection = {}
 
@@ -358,6 +365,11 @@ class _WiserDeviceCollection:
         except KeyError:
             return None
 
+    @property
+    def equipments(self) -> _WiserEquipmentsCollection:
+        """Return all equipment records reported by the hub."""
+        return self._equipments
+
     @property
     def lights(self) -> _WiserLightCollection:
         """Return all lights"""

aiowiserheatapi-1.7.8/aioWiserHeatAPI/equipments.py

@@ -0,0 +1,159 @@
+"""Represent and manage equipment records returned by a Wiser hub."""
+
+from typing import Literal
+
+from .const import WISEREQUIPMENT
+from .helpers.equipment import _WiserEquipment
+from .rest_controller import WiserRestActionEnum, _WiserRestController
+
+PowerNotificationName = Literal[
+    "UnderPowerNotification", "OverPowerNotification"
+]
+
+
+class _WiserEquipments(_WiserEquipment):
+    """A single equipment record, including its writable settings."""
+
+    def __init__(
+        self, wiser_rest_controller: _WiserRestController, data: dict
+    ) -> None:
+        super().__init__(data)
+        self._wiser_rest_controller = wiser_rest_controller
+
+    async def _set_power_notification(
+        self,
+        notification_name: PowerNotificationName,
+        period_mins: int,
+        limit: int,
+        enabled: bool,
+    ) -> bool:
+        """Create or replace a native power notification on the hub."""
+        notification = {
+            "PeriodMins": period_mins,
+            "Limit": limit,
+            "Enabled": enabled,
+        }
+        await self._wiser_rest_controller._send_command(
+            WISEREQUIPMENT.format(self.id),
+            {notification_name: notification},
+        )
+        self._data[notification_name] = notification
+        return True
+
+    async def set_under_power_notification(
+        self, period_mins: int, limit: int, enabled: bool = True
+    ) -> bool:
+        """Create or replace the native under-power notification."""
+        return await self._set_power_notification(
+            "UnderPowerNotification", period_mins, limit, enabled
+        )
+
+    async def set_over_power_notification(
+        self, period_mins: int, limit: int, enabled: bool = True
+    ) -> bool:
+        """Create or replace the native over-power notification."""
+        return await self._set_power_notification(
+            "OverPowerNotification", period_mins, limit, enabled
+        )
+
+    async def _set_power_notification_enabled(
+        self, notification_name: PowerNotificationName, enabled: bool
+    ) -> bool:
+        """Update an existing notification without losing its settings."""
+        notification = self._data.get(notification_name)
+        if not isinstance(notification, dict):
+            return False
+
+        updated_notification = {
+            key: notification[key]
+            for key in ("PeriodMins", "Limit")
+            if key in notification
+        }
+        updated_notification["Enabled"] = enabled
+        await self._wiser_rest_controller._send_command(
+            WISEREQUIPMENT.format(self.id),
+            {notification_name: updated_notification},
+        )
+        notification["Enabled"] = enabled
+        return True
+
+    async def set_under_power_notification_enabled(self, enabled: bool) -> bool:
+        """Enable or disable the under-power notification."""
+        return await self._set_power_notification_enabled(
+            "UnderPowerNotification", enabled
+        )
+
+    async def set_over_power_notification_enabled(self, enabled: bool) -> bool:
+        """Enable or disable the over-power notification."""
+        return await self._set_power_notification_enabled(
+            "OverPowerNotification", enabled
+        )
+
+    async def _delete_power_notification(
+        self, notification_name: PowerNotificationName
+    ) -> bool:
+        """Delete a native power notification from the hub."""
+        if notification_name not in self._data:
+            return False
+
+        await self._wiser_rest_controller._send_command(
+            f"{WISEREQUIPMENT.format(self.id)}/{notification_name}/",
+            None,
+            WiserRestActionEnum.DELETE,
+        )
+        self._data.pop(notification_name, None)
+        return True
+
+    async def delete_under_power_notification(self) -> bool:
+        """Delete the native under-power notification."""
+        return await self._delete_power_notification("UnderPowerNotification")
+
+    async def delete_over_power_notification(self) -> bool:
+        """Delete the native over-power notification."""
+        return await self._delete_power_notification("OverPowerNotification")
+
+
+class _WiserEquipmentsCollection:
+    """Collection of equipment records reported by the hub."""
+
+    def __init__(
+        self,
+        wiser_rest_controller: _WiserRestController,
+        equipments_data: list[dict] | None = None,
+    ) -> None:
+        records = equipments_data if isinstance(equipments_data, list) else []
+        self._items = [
+            _WiserEquipments(wiser_rest_controller, record)
+            for record in records
+            if isinstance(record, dict)
+        ]
+        self._items_by_id = {
+            item.id: item
+            for item in self._items
+            if isinstance(item._data.get("id"), int)
+        }
+
+    @property
+    def all(self) -> list[_WiserEquipments]:
+        """Return all equipment records."""
+        return list(self._items)
+
+    @property
+    def count(self) -> int:
+        """Return the number of equipment records."""
+        return len(self._items)
+
+    def get_by_id(self, equipment_id: int) -> _WiserEquipments | None:
+        """Return an equipment record by its id."""
+        return self._items_by_id.get(equipment_id)
+
+    def get_by_equipment_id(self, equipment_id: int) -> _WiserEquipments | None:
+        """Return an equipment record by its equipment id."""
+        return self.get_by_id(equipment_id)
+
+    def get_by_device_id(self, device_id: int) -> _WiserEquipments | None:
+        """Return the equipment record linked to a device instance."""
+        return next(
+            (item for item in self._items if item.device_id == device_id),
+            None,
+        )

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/evse.py

@@ -36,7 +36,7 @@ class _WiserEVSE(_WiserDevice):
     @property
     def available_control_states(self) -> list[str]:
         """Return control states accepted by the hub for this equipment."""
-        return self._device_type_data.get("AvailableControlState") or []
+        return self.equipment.available_control_states
 
     @property
     def control_state(self) -> str:
@@ -69,12 +69,15 @@ class _WiserEVSE(_WiserDevice):
         result = await self._wiser_rest_controller._send_command(
             WISEREQUIPMENT.format(self.equipment_id), {"ControlState": state}
         )
-        if result:
-            # Some hub versions return only the changed field. Preserve the
-            # equipment telemetry and advertised states until the next poll.
-            self._device_type_data = {**self._device_type_data, **result}
-            return True
-        return False
+        # Successful hub commands can return an empty object or only the
+        # changed field. Preserve existing telemetry and reflect the requested
+        # state until the next poll supplies a complete equipment record.
+        self._device_type_data = {
+            **self._device_type_data,
+            **result,
+            "ControlState": result.get("ControlState", state),
+        }
+        return True
 
     async def turn_on(self) -> bool:
         """Return the EVSE to its normal self-managed state."""

{aiowiserheatapi-1.7.7 → aiowiserheatapi-1.7.8}/aioWiserHeatAPI/helpers/equipment.py

@@ -47,14 +47,14 @@ class _WiserEquipmentUnderPowerNotificationInfo(object):
         self._data = data
 
     @property
-    def period_mins(self) -> int:
-        """Get delivered power"""
-        return self._data.get("PeriodMins", 0)
+    def period_mins(self) -> int | None:
+        """Get notification period in minutes."""
+        return self._data.get("PeriodMins")
 
     @property
-    def limit(self) -> int:
+    def limit(self) -> int | None:
         """Get limit"""
-        return self._data.get("Limit", 0)
+        return self._data.get("Limit")
 
     @property
     def enabled(self) -> bool:
@@ -68,19 +68,19 @@ class _WiserEquipmentOverPowerNotificationInfo:
         self._equipment_instance = equipment_instance
 
     @property
-    def period_mins(self) -> int:
+    def period_mins(self) -> int | None:
         """Get period in minutes"""
-        return self._data.get("PeriodMins") if self._data.get("PeriodMins") else None
+        return self._data.get("PeriodMins")
 
     @property
-    def limit(self) -> int:
+    def limit(self) -> int | None:
         """Get limit"""
-        return self._data.get("Limit", 100000) if self._data.get("Limit") else None
+        return self._data.get("Limit")
 
     @property
     def enabled(self) -> bool:
         """Get status enable"""
-        return self._data.get("Enabled", False) if self._data.get("Enabled") else None
+        return self._data.get("Enabled", False)
 
 
 class _WiserEquipment:
@@ -189,6 +189,27 @@ class _WiserEquipment:
         """Get current control mode"""
         return self._data.get("CurrentControlMode", TEXT_UNKNOWN)
 
+    @property
+    def available_control_states(self) -> list[str]:
+        """Get the control states available for this equipment"""
+        states = self._data.get("AvailableControlState")
+        return list(states) if isinstance(states, list) else []
+
+    @property
+    def overview_schedule_id(self) -> int | None:
+        """Get the overview schedule ID for this equipment"""
+        return self._data.get("OverviewScheduleId")
+
+    @property
+    def stated_power(self) -> int | None:
+        """Get the stated power value available for this equipment"""
+        return self._data.get("StatedPower")
+
+    @property
+    def cable_stated_power(self) -> int | None:
+        """Get the cabled stated power value available for this EVSE equipment"""
+        return self._data.get("CableStatedPower")
+
     @property
     def load_state_status(self) -> str:
         """Get load state status"""
@@ -252,7 +273,9 @@ class _WiserEquipment:
     #  Add for a notification feature Notification if the   Power is under or over a threshold
     #  for  a time (periodmins)...
     @property
-    def under_power_notification(self) -> _WiserEquipmentUnderPowerNotificationInfo:
+    def under_power_notification(
+        self,
+    ) -> _WiserEquipmentUnderPowerNotificationInfo | None:
         """Get notification info"""
         return (
             _WiserEquipmentUnderPowerNotificationInfo(
@@ -263,10 +286,13 @@ class _WiserEquipment:
         )
 
     @property
-    def over_power_notification(self) -> _WiserEquipmentOverPowerNotificationInfo:
+    def over_power_notification(
+        self,
+    ) -> _WiserEquipmentOverPowerNotificationInfo | None:
         """Get notification info"""
         return (
-            _WiserEquipmentUnderPowerNotificationInfo(
+            _WiserEquipmentOverPowerNotificationInfo(
+                self,
                 self._data.get("OverPowerNotification")
             )
             if self._data.get("OverPowerNotification")