aioWiserHeatAPI 1.5.14__tar.gz → 1.5.15__tar.gz

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.14
+Version: 1.5.15
 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.14
+# Drayton Wiser Hub API Async v1.5.15
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -72,6 +72,12 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.15
+
+* Added addiitonal functions for v2 hub lights, equipments etc
+* Added support for WindowDoor sensors
+* Added support for Boiler Interface device
+
 ### v1.5.14
 
 * Fix presets not using defined boost temp

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.14
+# Drayton Wiser Hub API Async v1.5.15
 
 This repository contains a simple API which queries the Drayton Wiser Heating sysystem used in the UK.
 
@@ -52,6 +52,12 @@ Documentation available in [info.md](https://github.com/msp1974/wiserHeatAPIv2/b
 
 ## Changelog
 
+### v1.5.15
+
+* Added addiitonal functions for v2 hub lights, equipments etc
+* Added support for WindowDoor sensors
+* Added support for Boiler Interface device
+
 ### v1.5.14
 
 * Fix presets not using defined boost temp

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/aioWiserHeatAPI/__init__.py

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

aiowiserheatapi-1.5.15/aioWiserHeatAPI/automation.py

@@ -0,0 +1,85 @@
+import inspect
+
+from . import _LOGGER
+from .const import TEXT_UNKNOWN, WISERSYSTEM
+from .rest_controller import _WiserRestController
+
+
+class _WiserAutomation:
+    def __init__(
+        self, wiser_rest_controller: _WiserRestController, automation_data: dict
+    ):
+        self._wiser_rest_controller = wiser_rest_controller
+        self._automation_data = automation_data
+
+    async def _send_command(self, cmd: dict) -> bool:
+        """
+        Send system control command to Wiser Hub
+        param cmd: json command structure
+        return: boolen - true = success, false = failed
+        """
+        result = await self._wiser_rest_controller._send_command(WISERSYSTEM, cmd)
+        if result:
+            _LOGGER.debug(
+                "Wiser hub - %s command successful", format(inspect.stack()[1].function)
+            )
+            return True
+        return False
+
+    @property
+    def id(self) -> int:
+        return self._automation_data.get("id", 0)
+
+    @property
+    def name(self) -> str:
+        return self._automation_data.get("Name", TEXT_UNKNOWN)
+
+    @property
+    def enabled(self) -> bool:
+        return self._automation_data.get("Enabled", False)
+
+    async def trigger(self):
+        """Activate automation"""
+        return await self._send_command({"TriggerAutomation": self.id})
+
+    @property
+    def notification_enabled(self) -> bool:
+        return self._automation_data.get("EnableNotification", False)
+
+    async def enable_notification(self):
+        """Activate automation"""
+        return await self._send_command({"EnableNotification": self.id})
+
+
+class _WiserAutomationCollection(object):
+    def __init__(
+        self, wiser_rest_controller: _WiserRestController, automations_data: dict
+    ):
+        self._automation_data = automations_data
+        self._automations = []
+        self._wiser_rest_controller = wiser_rest_controller
+        self._build()
+
+    def _build(self):
+        for automation in self._automation_data:
+            self._automations.append(
+                _WiserAutomation(self._wiser_rest_controller, automation)
+            )
+
+    @property
+    def all(self) -> list[_WiserAutomation]:
+        """Return list of automations"""
+        return self._automations
+
+    @property
+    def count(self) -> int:
+        """Count of automations"""
+        return len(self._automations)
+
+    def get_by_id(self, automation_id: int) -> _WiserAutomation:
+        try:
+            return [
+                automation for automation in self.all if automation.id == automation_id
+            ][0]
+        except IndexError:
+            return None

aiowiserheatapi-1.5.15/aioWiserHeatAPI/binary_sensor.py

@@ -0,0 +1,67 @@
+"""
+Handles binary_sensor devices
+"""
+
+from .helpers.battery import _WiserBattery
+from .helpers.device import _WiserDevice
+
+
+class _WiserBinarySensor(_WiserDevice):
+    """Class representing a Wiser Binary Sensor"""
+
+    @property
+    def active(self) -> bool:
+        """Get if is active"""
+        return self._device_type_data.get("Active")
+
+    @property
+    def interacts_with_room_climate(self) -> bool:
+        """Get the if interacts with room climate"""
+        return self._device_type_data.get("InteractsWithRoomClimate")
+
+    @property
+    def type(self) -> str:
+        """Get the type of device"""
+        return self._device_type_data.get("Type")
+
+    @property
+    def enable_notification(self) -> str:
+        """Get if notifications is enable"""
+        return self._device_type_data.get("EnableNotification")
+
+    @property
+    def battery(self) -> _WiserBattery:
+        """Get the battery information for the smokealarm"""
+        return _WiserBattery(self._data)
+
+
+class _WiserWindowDoorSensor(_WiserBinarySensor):
+    """Class representing a Wiser WindowDoor Sensor"""
+
+
+class _WiserBinarySensorCollection:
+    """Class holding all Wiser Binary Sensors"""
+
+    def __init__(self):
+        self._items = []
+
+    @property
+    def all(self) -> list[_WiserBinarySensor]:
+        return list(self._items)
+
+    @property
+    def count(self) -> int:
+        return len(self.all)
+
+    def get_by_id(self, id: int) -> _WiserBinarySensor:
+        """
+        Gets a binarysensor object from the binary sensor id
+        param id: id of binary sensor
+        return: _WiserBinarySensor object
+        """
+        try:
+            return [binarysensor for binarysensor in self.all if binarysensor.id == id][
+                0
+            ]
+        except IndexError:
+            return None

aiowiserheatapi-1.5.15/aioWiserHeatAPI/boiler_interface.py

@@ -0,0 +1,40 @@
+from .helpers.device import _WiserDevice
+
+
+class _WiserBoilerInterface(_WiserDevice):
+    """Class representing a Wiser Boiler Interface"""
+
+    @property
+    def heating_channel_ids(self) -> list[int]:
+        """Heating channel ids."""
+        return self._device_type_data.get("HeatingChannelIds")
+
+
+class _WiserBoilerInterfaceCollection:
+    """Class holding all Wiser Boiler Interfaces"""
+
+    def __init__(self):
+        self._items = []
+
+    @property
+    def all(self) -> list[_WiserBoilerInterface]:
+        return list(self._items)
+
+    @property
+    def count(self) -> int:
+        return len(self.all)
+
+    def get_by_id(self, id: int) -> _WiserBoilerInterface:
+        """
+        Gets a boiler interface object from the binary sensor id
+        param id: id of boiler interface
+        return: _WiserBoilerInterface object
+        """
+        try:
+            return [
+                boilerinterface
+                for boilerinterface in self.all
+                if boilerinterface.id == id
+            ][0]
+        except IndexError:
+            return None

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/aioWiserHeatAPI/const.py

@@ -60,6 +60,17 @@ TEXT_WEEKDAYS = "Weekdays"
 TEXT_WEEKENDS = "Weekends"
 TEXT_ALL = "All"
 TEXT_UNABLE = "Unable"
+# added by Lgo44
+
+TEXT_REVERSE = "ReverseWithLoad"
+TEXT_CONSISTENT = "ConsistentWithLoad"
+TEXT_ALWAYSON = "AlwaysOn"
+TEXT_ALWAYSOFF = "AlwaysOff"
+
+TEXT_LASTON = "LastOnBrightness"
+TEXT_LEVELPERCENT = "LevelPercent"
+
+# End added by Lgo44
 
 # Day Value Lists
 WEEKDAYS = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"]
@@ -88,6 +99,8 @@ WISERSHUTTER = "Shutter/{}"
 WISERLIGHT = "Light/{}"
 WISERPOWERTAGENERGY = "PTE/{}"
 WISERSMOKEALARM = "SmokeAlarmDevice/{}"
+WISERBINARYSENSOR = "BinarySensor/{}"
+WISERBOILERINTERFACE = "BoilerInterface/{}"
 
 
 # Enums
@@ -116,11 +129,33 @@ class WiserShutterAwayActionEnum(enum.Enum):
     nochange = TEXT_NO_CHANGE
 
 
+# added by Lgo44
+class WiserLightLedIndicatorEnum(enum.Enum):
+    reverse = TEXT_REVERSE
+    consistent = TEXT_CONSISTENT
+    allwayson = TEXT_ALWAYSON
+    allwaysoff = TEXT_ALWAYSOFF
+
+
+class WiserLightPowerOnBehaviourEnum(enum.Enum):
+    last = TEXT_LASTON
+    levelpercent = TEXT_LEVELPERCENT
+
+
+# End added by Lgo44
+
+
 class WiserDeviceModeEnum(enum.Enum):
     auto = TEXT_AUTO
     manual = TEXT_MANUAL
 
 
+class WiserHotWaterClimateModeEnum(enum.Enum):
+    auto = TEXT_AUTO
+    manual = TEXT_MANUAL
+    off = TEXT_OFF
+
+
 class WiserHeatingModeEnum(enum.Enum):
     off = TEXT_OFF
     auto = TEXT_AUTO

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/aioWiserHeatAPI/devices.py

@@ -4,8 +4,15 @@ Module to manage all devices
 
 import enum
 
+from .binary_sensor import (
+    _WiserBinarySensorCollection,
+    _WiserWindowDoorSensor,
+)
+from .boiler_interface import _WiserBoilerInterface, _WiserBoilerInterfaceCollection
 from .const import (
     TEXT_UNKNOWN,
+    WISERBINARYSENSOR,
+    WISERBOILERINTERFACE,
     WISERHEATINGACTUATOR,
     WISERLIGHT,
     WISERPOWERTAGENERGY,
@@ -20,6 +27,7 @@ from .heating_actuator import (
     _WiserHeatingActuator,
     _WiserHeatingActuatorCollection,
 )
+from .helpers.device import _WiserDevice
 from .light import _WiserDimmableLight, _WiserLight, _WiserLightCollection
 from .pte import _WiserPowerTagEnergy, _WiserPowerTagEnergyCollection
 from .rest_controller import _WiserRestController
@@ -43,6 +51,8 @@ class _WiserDeviceTypeEnum(enum.Enum):
     DimmableLight = "Light"
     PowerTagE = "PTE"
     SmokeAlarmDevice = "SmokeAlarmDevice"
+    WindowDoorSensor = "BinarySensor"
+    BoilerInterface = "BoilerInterface"
 
 
 PRODUCT_TYPE_CONFIG = {
@@ -112,6 +122,18 @@ PRODUCT_TYPE_CONFIG = {
         "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",
+    },
 }
 
 
@@ -127,9 +149,7 @@ 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
+        self._equipment_data = domain_data.get("Equipment", {})  # Supported by v2 hub
         self._schedules = schedules
         self._device_collection = {}
 
@@ -153,9 +173,9 @@ class _WiserDeviceCollection:
                 device_type.value not in self._device_collection
                 and device_type.name in PRODUCT_TYPE_CONFIG
             ):
-                self._device_collection[
-                    device_type.value
-                ] = PRODUCT_TYPE_CONFIG[device_type.name].get("collection")()
+                self._device_collection[device_type.value] = PRODUCT_TYPE_CONFIG[
+                    device_type.name
+                ].get("collection")()
 
         # Iterate device data for all known device types
         if self._device_data:
@@ -168,22 +188,16 @@ 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(device_config.get("device_id_field", "id"))
                         == device.get("id")
                     ]
 
                     # Get class to create and collection to append for device
-                    device_class = PRODUCT_TYPE_CONFIG[device_type].get(
-                        "class"
-                    )
+                    device_class = PRODUCT_TYPE_CONFIG[device_type].get("class")
 
                     # If heating device add room id
                     if device_config.get("heating"):
-                        device_info[0][
-                            "RoomId"
-                        ] = self._get_temp_device_room_id(
+                        device_info[0]["RoomId"] = self._get_temp_device_room_id(
                             self._domain_data, device.get("id")
                         )
 
@@ -201,9 +215,7 @@ class _WiserDeviceCollection:
 
                     # If has equipment entry, add equipment to device info data
                     if device_config.get("has_v2_equipment"):
-                        device_info[0][
-                            "EquipmentData"
-                        ] = self._get_equipment_data(
+                        device_info[0]["EquipmentData"] = self._get_equipment_data(
                             device_info[0].get("EquipmentId")
                         )
 
@@ -220,9 +232,7 @@ class _WiserDeviceCollection:
                         )
                     )
 
-    def _get_temp_device_room_id(
-        self, domain_data: dict, device_id: int
-    ) -> int:
+    def _get_temp_device_room_id(self, domain_data: dict, device_id: int) -> int:
         rooms = domain_data.get("Room")
         for room in rooms:
             room_device_list = []
@@ -235,7 +245,7 @@ class _WiserDeviceCollection:
         return 0
 
     @property
-    def all(self):
+    def all(self) -> list[_WiserDevice]:
         """Return all devices"""
         items = []
         for key in self._device_collection:
@@ -248,51 +258,56 @@ class _WiserDeviceCollection:
         return len(self.all)
 
     @property
-    def heating_actuators(self):
+    def heating_actuators(self) -> _WiserHeatingActuatorCollection:
         """Return all heating actuators"""
         return self._device_collection["HeatingActuator"]
 
     @property
-    def lights(self):
+    def lights(self) -> _WiserLightCollection:
         """Return all lights"""
         return self._device_collection["Light"]
 
     @property
-    def power_tags(self):
+    def power_tags(self) -> _WiserPowerTagEnergyCollection:
         """Return all power tags"""
         return self._device_collection["PTE"]
 
     @property
-    def roomstats(self):
+    def roomstats(self) -> _WiserRoomStatCollection:
         """Return all roomstats"""
         return self._device_collection["RoomStat"]
 
     @property
-    def shutters(self):
+    def shutters(self) -> _WiserShutterCollection:
         """Return all shutters"""
         return self._device_collection["Shutter"]
 
     @property
-    def smartplugs(self):
+    def smartplugs(self) -> _WiserSmartPlugCollection:
         """Return all smart plugs"""
         return self._device_collection["SmartPlug"]
 
     @property
-    def smartvalves(self):
+    def smartvalves(self) -> _WiserSmartValveCollection:
         """Return all smart valves (iTRVs)"""
         return self._device_collection["SmartValve"]
 
     @property
-    def smokealarms(self):
+    def smokealarms(self) -> _WiserSmokeAlarmCollection:
         """Return all smoke alarms"""
         return self._device_collection["SmokeAlarmDevice"]
 
     @property
-    def ufh_controllers(self):
+    def ufh_controllers(self) -> _WiserUFHControllerCollection:
         """Return all UFH controllers"""
         return self._device_collection["UnderFloorHeating"]
 
-    def get_by_id(self, device_id: int):
+    @property
+    def binary_sensor(self):
+        """Return all binary sensors"""
+        return self._device_collection["BinarySensor"]
+
+    def get_by_id(self, device_id: int) -> _WiserDevice:
         """
         Gets a device object from the devices id
         param id: id of device
@@ -303,7 +318,7 @@ class _WiserDeviceCollection:
         except IndexError:
             return None
 
-    def get_by_room_id(self, room_id: int) -> list:
+    def get_by_room_id(self, room_id: int) -> list[_WiserDevice]:
         """
         Gets a list of devices belonging to the room id
         param room_id: the id of the room
@@ -314,20 +329,18 @@ class _WiserDeviceCollection:
         except IndexError:
             return None
 
-    def get_by_node_id(self, node_id: int):
+    def get_by_node_id(self, node_id: int) -> _WiserDevice:
         """
         Gets a device object from the devices zigbee node id
         param node_id: zigbee node id of device
         return: Device type class
         """
         try:
-            return [
-                device for device in self.all if device.node_id == node_id
-            ][0]
+            return [device for device in self.all if device.node_id == node_id][0]
         except IndexError:
             return None
 
-    def get_by_serial_number(self, serial_number: str):
+    def get_by_serial_number(self, serial_number: str) -> _WiserDevice:
         """
         Gets a device object from the devices serial number
         param node_id: serial number of device
@@ -335,24 +348,18 @@ class _WiserDeviceCollection:
         """
         try:
             return [
-                device
-                for device in self.all
-                if device.serial_number == serial_number
+                device for device in self.all if device.serial_number == serial_number
             ][0]
         except IndexError:
             return None
 
-    def get_by_parent_node_id(self, node_id: int) -> list:
+    def get_by_parent_node_id(self, node_id: int) -> list[_WiserDevice]:
         """
         Gets a list of device from the devices zigbee parent node id
         param node_id: zigbee parent node id of device
         return: Device type class
         """
         try:
-            return [
-                device
-                for device in self.all
-                if device.parent_node_id == node_id
-            ]
+            return [device for device in self.all if device.parent_node_id == node_id]
         except IndexError:
             return None

{aiowiserheatapi-1.5.14 → aiowiserheatapi-1.5.15}/aioWiserHeatAPI/heating.py

@@ -60,36 +60,36 @@ class _WiserHeatingChannelCollection(object):
             self._heating_channels.append(_WiserHeatingChannel(heat_channel))
 
     @property
-    def all(self):
+    def all(self) -> list[_WiserHeatingChannel]:
         return list(self._heating_channels)
 
     @property
     def count(self) -> int:
         return len(self.all)
 
-    def get_by_id(self, id: int):
+    def get_by_id(self, channel_id: int) -> _WiserHeatingChannel:
         """
         Gets a Heating Channel object from the Heating Channels id
         param id: id of heating channel
         return: _WiserHeatingChannel object
         """
         for heating_channel in self.all:
-            if id == heating_channel.id:
+            if channel_id == heating_channel.id:
                 return heating_channel
         return None
 
-    def get_by_room_id(self, id: int):
+    def get_by_room_id(self, room_id: int) -> _WiserHeatingChannel:
         """
         Gets a Heating Channel object from a Room ID
         param id: id of the room
         return: _WiserHeatingChannel object
         """
         for heating_channel in self.all:
-            if id in heating_channel.room_ids:
+            if room_id in heating_channel.room_ids:
                 return heating_channel
         return None
 
-    def get_by_room_name(self, room_name: str):
+    def get_by_room_name(self, room_name: str) -> _WiserHeatingChannel:
         """
         Gets a Heating Channel object from a Room Name
         param id: name of the room