aioWiserHeatAPI 1.5.5__tar.gz → 1.5.7__tar.gz

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.5
+Version: 1.5.7
 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.1
 Requires-Dist: aiofiles>=23.2.1
 Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.5
+# Drayton Wiser Hub API Async v1.5.7
 
 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.7
+
+* Fixed issue whereby lower target temp for passive mode was not being set correctly
+* Added support for smoke alarm
+
+### v1.5.6
+
+* Added improved error handling for json decode errors
+
 ### v1.5.5
 
 * Added addtional v2 hub attributes and switches

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/README.md

@@ -1,4 +1,4 @@
-# Drayton Wiser Hub API Async v1.5.5
+# Drayton Wiser Hub API Async v1.5.7
 
 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.7
+
+* Fixed issue whereby lower target temp for passive mode was not being set correctly
+* Added support for smoke alarm
+
+### v1.5.6
+
+* Added improved error handling for json decode errors
+
 ### v1.5.5
 
 * Added addtional v2 hub attributes and switches

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/__init__.py

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

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/const.py

@@ -85,6 +85,7 @@ WISERUFHCONTROLLER = "UnderFloorHeating/{}"
 WISERSHUTTER = "Shutter/{}"
 WISERLIGHT = "Light/{}"
 WISERPOWERTAGENERGY = "PTE/{}"
+WISERSMOKEALARM = "SmokeAlarmDevice/{}"
 
 
 # Enums

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/devices.py

@@ -13,9 +13,13 @@ from .const import (
     WISERSHUTTER,
     WISERSMARTPLUG,
     WISERSMARTVALVE,
+    WISERSMOKEALARM,
     WISERUFHCONTROLLER,
 )
-from .heating_actuator import _WiserHeatingActuator, _WiserHeatingActuatorCollection
+from .heating_actuator import (
+    _WiserHeatingActuator,
+    _WiserHeatingActuatorCollection,
+)
 from .light import _WiserDimmableLight, _WiserLight, _WiserLightCollection
 from .pte import _WiserPowerTagEnergy, _WiserPowerTagEnergyCollection
 from .rest_controller import _WiserRestController
@@ -24,6 +28,7 @@ from .schedule import WiserScheduleTypeEnum, _WiserScheduleCollection
 from .shutter import _WiserShutter, _WiserShutterCollection
 from .smartplug import _WiserSmartPlug, _WiserSmartPlugCollection
 from .smartvalve import _WiserSmartValve, _WiserSmartValveCollection
+from .smokealarm import _WiserSmokeAlarm, _WiserSmokeAlarmCollection
 from .ufh import _WiserUFHController, _WiserUFHControllerCollection
 
 
@@ -37,6 +42,7 @@ class _WiserDeviceTypeEnum(enum.Enum):
     OnOffLight = "Light"
     DimmableLight = "Light"
     PowerTagE = "PTE"
+    SmokeAlarmDevice = "SmokeAlarmDevice"
 
 
 PRODUCT_TYPE_CONFIG = {
@@ -100,6 +106,12 @@ PRODUCT_TYPE_CONFIG = {
         "device_id_field": "DeviceId",
         "has_v2_equipment": True,
     },
+    "SmokeAlarmDevice": {
+        "class": _WiserSmokeAlarm,
+        "collection": _WiserSmokeAlarmCollection,
+        "endpoint": WISERSMOKEALARM,
+        "device_id_field": "DeviceId",
+    },
 }
 
 
@@ -115,7 +127,9 @@ 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 = {}
 
@@ -139,9 +153,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:
@@ -154,16 +168,22 @@ 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")
                         )
 
@@ -181,7 +201,9 @@ 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")
                         )
 
@@ -198,7 +220,9 @@ 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 = []
@@ -258,6 +282,11 @@ class _WiserDeviceCollection:
         """Return all smart valves (iTRVs)"""
         return self._device_collection["SmartValve"]
 
+    @property
+    def smokealarms(self):
+        """Return all smoke alarms"""
+        return self._device_collection["SmokeAlarmDevice"]
+
     @property
     def ufh_controllers(self):
         """Return all UFH controllers"""
@@ -292,7 +321,9 @@ class _WiserDeviceCollection:
         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
 
@@ -304,7 +335,9 @@ 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
@@ -316,6 +349,10 @@ class _WiserDeviceCollection:
         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.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/heating.py

@@ -39,7 +39,7 @@ class _WiserHeatingChannel(object):
         return self._data.get("PercentageDemand", 0)
 
     @property
-    def room_ids(self) -> list:
+    def room_ids(self) -> list | None:
         """Get a list of the room ids attached to this heating channel"""
         return self._data.get("RoomIds", None)
 
@@ -47,7 +47,9 @@ class _WiserHeatingChannel(object):
 class _WiserHeatingChannelCollection(object):
     """Class holding all wiser heating channel objects"""
 
-    def __init__(self, heating_channel_data: dict, rooms: _WiserRoomCollection):
+    def __init__(
+        self, heating_channel_data: dict, rooms: _WiserRoomCollection
+    ):
         self._heating_channels = []
         self._heating_channel_data = heating_channel_data
         self._rooms = rooms

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/helpers/automations.py

@@ -1,8 +1,8 @@
 import logging
 
-from ..rest_controller import _WiserRestController
 from ..const import WiserHeatingModeEnum
 from ..heating import _WiserHeatingChannelCollection
+from ..rest_controller import _WiserRestController
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -22,7 +22,9 @@ class _WiserHeatingChannelAutomations:
 
     async def passive_mode_control(self) -> bool:
         hub_updated: bool = False
-
+        passive_mode_increment = (
+            self._wiser_rest_controller._api_parameters.passive_mode_increment
+        )
         # iterate each heating channel
         for heating_channel in self._heating_channels:
             passive_rooms = [
@@ -55,12 +57,13 @@ class _WiserHeatingChannelAutomations:
                 for room in passive_rooms:
                     # If room is boosted do not override
                     if not room.is_boosted:
-                        # Set target temp to heat passive room in increments of passive_temperature_increment (default 0.5)
+                        # Set target temp to heat passive room in
+                        # increments of passive_temperature_increment (default 0.5)
                         target_temp = min(
                             round(
                                 (
                                     room.current_temperature
-                                    + self._wiser_rest_controller._api_parameters.passive_mode_increment
+                                    + passive_mode_increment
                                 )
                                 * 2
                             )
@@ -72,6 +75,10 @@ class _WiserHeatingChannelAutomations:
                                 else room.passive_mode_upper_temp
                             ),
                         )
+
+                        if target_temp < room.passive_mode_lower_temp:
+                            target_temp = room.passive_mode_lower_temp
+
                         if target_temp != room.current_target_temperature:
                             _LOGGER.debug(
                                 f"Setting {room.name} to {target_temp}C caused by active rooms on heating channel {heating_channel.id}"
@@ -82,12 +89,15 @@ class _WiserHeatingChannelAutomations:
                 # Stop any passive rooms heating by setting to min temp
                 for room in passive_rooms:
                     if (
-                        room.current_target_temperature > room.passive_mode_lower_temp
+                        room.current_target_temperature
+                        != room.passive_mode_lower_temp
                     ) and not room.is_boosted:
                         _LOGGER.debug(
                             f"Setting {room.name} to {room.passive_mode_lower_temp}C caused by no active rooms on heating channel {heating_channel.id}"
                         )
-                        await room.set_target_temperature(room.passive_mode_lower_temp)
+                        await room.set_target_temperature(
+                            room.passive_mode_lower_temp
+                        )
                         hub_updated = True
 
         return hub_updated

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/helpers/device.py

@@ -270,6 +270,8 @@ class _WiserElectricalDevice(_WiserDevice):
 
     @property
     def name(self) -> str:
+        if self._data.get("Name"):
+            return self._data.get("Name")
         return self._device_type_data.get("Name", TEXT_UNKNOWN)
 
     async def set_name(self, name: str) -> bool:

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/rest_controller.py

@@ -1,4 +1,5 @@
 """Module to manage rest commands of Wiser hub"""
+
 import asyncio
 import enum
 import json
@@ -95,14 +96,12 @@ class _WiserRestController(object):
         )
 
         kwargs = {}
-
         kwargs["headers"] = {
             "SECRET": self._wiser_connection_info.secret,
             "Content-Type": "application/json;charset=UTF-8",
         }
 
         if data is not None:
-            # print(data)
             kwargs["json"] = data
         if self._timeout is not None:
             kwargs["timeout"] = self._timeout
@@ -123,9 +122,15 @@ class _WiserRestController(object):
                         content = await response.read()
                         if len(content) > 0:
                             response = content.decode("utf-8", "ignore")
-                            return json.loads(
-                                self.remove_control_characters(response),
-                            )
+                            try:
+                                return json.loads(
+                                    self.remove_control_characters(response),
+                                )
+                            except json.decoder.JSONDecodeError as ex:
+                                raise WiserHubRESTError(
+                                    f"""JSON decoding error from {url}. Error is - {ex}.
+                                    Data is - {content}""",
+                                ) from ex
                         else:
                             return {}
                     return {}

aioWiserHeatAPI-1.5.7/aioWiserHeatAPI/smokealarm.py

@@ -0,0 +1,137 @@
+from .helpers.battery import _WiserBattery
+from .helpers.device import _WiserElectricalDevice
+from .helpers.temp import _WiserTemperatureFunctions as tf
+
+
+class _WiserSmokeAlarm(_WiserElectricalDevice):
+    """Class representing a Wiser Smoke Alarm device"""
+
+    @property
+    def alarm_sound_level(self) -> int:
+        """Get the alarm sound level"""
+        return self._device_type_data.get("AlarmSoundLevel")
+
+    @property
+    def alarm_sound_mode(self) -> int:
+        """Get the alarm sound mode"""
+        return self._device_type_data.get("AlarmSoundMode")
+
+    @property
+    def battery(self):
+        """Get battery information for smoke alarm"""
+        return _WiserBattery(self._data)
+
+    @property
+    def current_temperature(self) -> float:
+        """Get the current temperature measured by the smoke alarm"""
+        return tf._from_wiser_temp(
+            self._device_type_data.get("MeasuredTemperature"), "current"
+        )
+
+    @property
+    def led_brightness(self) -> int:
+        """Get the led brightness"""
+        return self._device_type_data.get("LEDBrightness")
+
+    @property
+    def life_time(self) -> int:
+        """Get the life time"""
+        return self._device_type_data.get("LifeTime")
+
+    @property
+    def hush_duration(self) -> int:
+        """Get the hush duration"""
+        return self._device_type_data.get("HushDuration")
+
+    @property
+    def smoke_alarm(self) -> bool:
+        """Get if smoke alarm active"""
+        return self._device_type_data.get("SmokeAlarm", False)
+
+    @property
+    def heat_alarm(self) -> bool:
+        """Get if heat alarm active"""
+        return self._device_type_data.get("HeatAlarm", False)
+
+    @property
+    def tamper_alarm(self) -> bool:
+        """Get if tamper alarm active"""
+        return self._device_type_data.get("Tamper", False)
+
+    @property
+    def fault_warning(self) -> bool:
+        """Get if fault warning active"""
+        return self._device_type_data.get("FaultWarning", False)
+
+    @property
+    def ac_mains(self) -> bool:
+        """Get if on ac mains power"""
+        return self._device_type_data.get("ACMains", False)
+
+    @property
+    def test_mode(self) -> bool:
+        """Get if in test mode"""
+        return self._device_type_data.get("TestMode", False)
+
+    @property
+    def battery_defect(self) -> bool:
+        """Get if battery defect detected"""
+        return self._device_type_data.get("BatteryDefect", False)
+
+    @property
+    def remote_alarm(self) -> bool:
+        """Get if remote alarm active"""
+        return self._device_type_data.get("RemoteAlarm", False)
+
+    @property
+    def hush_mode(self) -> bool:
+        """Get if in hush mode"""
+        return self._device_type_data.get("HushMode", False)
+
+    @property
+    def report_count(self) -> int:
+        """Get the report count"""
+        return self._device_type_data.get("ReportCount")
+
+    @property
+    def notificaitions(self) -> bool:
+        """Get if notifications active"""
+        return self._device_type_data.get("EnableNotification", False)
+
+    @property
+    def supervision_notify(self) -> bool:
+        """Get if supervision notify active"""
+        return self._device_type_data.get("SupervisionNotify", False)
+
+    @property
+    def restore_notify(self) -> bool:
+        """Get if restore notify active"""
+        return self._device_type_data.get("RestoreNotify", False)
+
+
+class _WiserSmokeAlarmCollection(object):
+    """Class holding all wiser smoke alarms"""
+
+    def __init__(self):
+        self._items = []
+
+    @property
+    def all(self) -> dict:
+        return list(self._items)
+
+    @property
+    def count(self) -> int:
+        return len(self.all)
+
+    def get_by_id(self, id: int) -> _WiserSmokeAlarm:
+        """
+        Gets a smoke alarm object from the smoke alarms id
+        param id: id of smoke alarm
+        return: _WiserSmokeAlarm object
+        """
+        try:
+            return [
+                smokealarm for smokealarm in self.all if smokealarm.id == id
+            ][0]
+        except IndexError:
+            return None

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI/wiserhub.py

@@ -249,42 +249,42 @@ class WiserAPI(object):
         return self._wiser_rest_controller._api_parameters
 
     @property
-    def devices(self):
+    def devices(self) -> _WiserDeviceCollection:
         """List of device entities attached to the Wiser Hub"""
         return self._devices
 
     @property
-    def heating_channels(self):
+    def heating_channels(self) -> _WiserHeatingChannelCollection:
         """List of heating channel entities on the Wiser Hub"""
         return self._heating_channels
 
     @property
-    def hotwater(self):
+    def hotwater(self) -> _WiserHotwater:
         """List of hot water entities on the Wiser Hub"""
         return self._hotwater
 
     @property
-    def moments(self):
+    def moments(self) -> _WiserMomentCollection:
         """List of moment entities on the Wiser Hub"""
         return self._moments
 
     @property
-    def rooms(self):
+    def rooms(self) -> _WiserRoomCollection:
         """List of room entities configured on the Wiser Hub"""
         return self._rooms
 
     @property
-    def schedules(self):
+    def schedules(self) -> _WiserScheduleCollection:
         """List of schedules"""
         return self._schedules
 
     @property
-    def status(self):
+    def status(self) -> WiserStatus:
         """Hub status info"""
         return WiserStatus(self._status_data)
 
     @property
-    def system(self):
+    def system(self) -> _WiserSystem:
         """Entity of the Wiser Hub"""
         return self._system
 
@@ -299,15 +299,18 @@ class WiserAPI(object):
 
     @property
     def version(self):
+        """Return api version."""
         return __VERSION__
 
     @property
-    def _raw_hub_data(self):
+    def raw_hub_data(self):
+        """Return raw hub data."""
         return {
             "Domain": self._domain_data,
             "Network": self._network_data,
             "Schedule": self._schedule_data,
             "OpenTherm": self._opentherm_data,
+            "Status": self._status_data,
         }
 
     def output_raw_hub_data(

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aioWiserHeatAPI
-Version: 1.5.5
+Version: 1.5.7
 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.1
 Requires-Dist: aiofiles>=23.2.1
 Requires-Dist: pyyaml>=6.0.1
 
-# Drayton Wiser Hub API Async v1.5.5
+# Drayton Wiser Hub API Async v1.5.7
 
 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.7
+
+* Fixed issue whereby lower target temp for passive mode was not being set correctly
+* Added support for smoke alarm
+
+### v1.5.6
+
+* Added improved error handling for json decode errors
+
 ### v1.5.5
 
 * Added addtional v2 hub attributes and switches

{aioWiserHeatAPI-1.5.5 → aioWiserHeatAPI-1.5.7}/aioWiserHeatAPI.egg-info/SOURCES.txt

@@ -21,6 +21,7 @@ aioWiserHeatAPI/schedule.py
 aioWiserHeatAPI/shutter.py
 aioWiserHeatAPI/smartplug.py
 aioWiserHeatAPI/smartvalve.py
+aioWiserHeatAPI/smokealarm.py
 aioWiserHeatAPI/system.py
 aioWiserHeatAPI/ufh.py
 aioWiserHeatAPI/wiserhub.py