plugwise 1.0.0__tar.gz → 1.1.0a0__tar.gz

{plugwise-1.0.0 → plugwise-1.1.0a0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.0.0
+Version: 1.1.0a0
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.0.0 → plugwise-1.1.0a0}/plugwise/constants.py

@@ -258,6 +258,7 @@ ApplianceType = Literal[
 ]
 
 BinarySensorType = Literal[
+    "battery_state",
     "compressor_state",
     "cooling_enabled",
     "cooling_state",
@@ -409,6 +410,7 @@ class ModelData(TypedDict):
 class SmileBinarySensors(TypedDict, total=False):
     """Smile Binary Sensors class."""
 
+    battery_state: bool
     compressor_state: bool
     cooling_enabled: bool
     cooling_state: bool

{plugwise-1.0.0 → plugwise-1.1.0a0}/plugwise/data.py

@@ -4,6 +4,8 @@ Plugwise Smile protocol data-collection helpers.
 """
 from __future__ import annotations
 
+import re
+
 from plugwise.constants import (
     ADAM,
     ANNA,
@@ -52,13 +54,49 @@ class SmileData(SmileHelper):
 
         Collect data for each device and add to self.gw_devices.
         """
+        mac_list: list[str] = []
         for device_id, device in self.gw_devices.items():
             data = self._get_device_data(device_id)
-            self._add_or_update_notifications(device_id, device, data)
+            if device_id == self.gateway_id:
+                mac_list = self._detect_low_batteries()
+                self._add_or_update_notifications(device_id, device, data)
+
             device.update(data)
+
+            is_battery_low = (
+                mac_list
+                and "battery_state" in device["binary_sensors"]
+                and device["zigbee_mac_address"] in mac_list
+                and (
+                    (device["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve") and device["sensors"]["battery"] < 30)
+                    or (device["dev_class"] in ("zone_thermometer", "zone_thermostat") and device["sensors"]["battery"] < 15)
+                )
+            )
+            if is_battery_low:
+                device["binary_sensors"]["battery_state"] = True
+
             self._update_for_cooling(device)
+
             remove_empty_platform_dicts(device)
 
+    def _detect_low_batteries(self) -> list[str]:
+        """Helper-function updating the battery_state binary_sensor status from a Battery-is-low message."""
+        mac_address_list: list[str] = []
+        mac_pattern = re.compile(r"(?:[0-9A-F]{2}){8}")
+        matches = ["Battery", "below"]
+        if self._notifications:
+            for msg_id, notification in list(self._notifications.items()):
+                mac_address: str | None = None
+                message: str | None = notification.get("message")
+                if message is not None and all(x in message for x in matches) and (mac_addresses := mac_pattern.findall(message)):
+                    mac_address = mac_addresses[0]  # re.findall() outputs a list
+
+                if mac_address is not None:
+                    self._notifications.pop(msg_id)
+                    mac_address_list.append(mac_address)
+
+        return mac_address_list
+
     def _add_or_update_notifications(
         self, device_id: str, device: DeviceData, data: DeviceData
     ) -> None:

{plugwise-1.0.0 → plugwise-1.1.0a0}/plugwise/smile.py

@@ -129,7 +129,6 @@ class SmileAPI(SmileComm, SmileData):
 
     async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
-        # Perform a full update at day-change
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
         try:

{plugwise-1.0.0 → plugwise-1.1.0a0}/plugwise/util.py

@@ -138,6 +138,9 @@ def common_match_cases(
             sp_key = cast(SpecialType, measurement)
             data[sp_key] = value
 
+    if "battery" in data["sensors"]:
+        data["binary_sensors"]["battery_state"] = False
+
 
 def escape_illegal_xml_characters(xmldata: str) -> str:
     """Replace illegal &-characters."""

{plugwise-1.0.0 → plugwise-1.1.0a0}/plugwise.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.0.0
+Version: 1.1.0a0
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.0.0 → plugwise-1.1.0a0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.0.0"
+version         = "1.1.0a0"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"

{plugwise-1.0.0 → plugwise-1.1.0a0}/tests/test_adam.py

@@ -14,7 +14,155 @@ WERKDAG_SCHEMA = "Werkdag schema"
 
 
 class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outside-init
-    """Tests for Adam standalone, i.e. not combined with Anna or Jip."""
+    """Tests for Adam."""
+
+    @pytest.mark.asyncio
+    async def test_connect_adam_plus_anna_new(self):
+        """Test extended Adam (firmware 3.8) with Anna and a switch-group setup."""
+        self.smile_setup = "adam_plus_anna_new"
+
+        testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
+        server, smile, client = await self.connect_wrapper()
+        assert smile.smile_hostname == "smile000000"
+
+        self.validate_test_basics(
+            _LOGGER,
+            smile,
+            smile_type=None,
+            smile_version="3.7.8",
+        )
+
+        await self.device_test(smile, "2023-12-17 00:00:01", testdata)
+        assert smile.gateway_id == "da224107914542988a88561b4452b0f6"
+        assert smile._last_active["f2bf9048bef64cc5b6d5110154e33c81"] == "Weekschema"
+        assert smile._last_active["f871b8c4d63549319221e294e4f88074"] == "Badkamer"
+        assert self.device_items == 149
+        assert self.device_list == [
+            "da224107914542988a88561b4452b0f6",
+            "056ee145a816487eaa69243c3280f8bf",
+            "67d73d0bd469422db25a618a5fb8eeb0",
+            "e2f4322d57924fa090fbbc48b3a140dc",
+            "29542b2b6a6a4169acecc15c72a599b8",
+            "ad4838d7d35c4d6ea796ee12ae5aedf8",
+            "1772a4ea304041adb83f357b751341ff",
+            "854f8a9b0e7e425db97f1f110e1ce4b3",
+            "2568cc4b9c1e401495d4741a5f89bee1",
+            "e8ef2a01ed3b4139a53bf749204fe6b4",
+        ]
+
+        result = await self.tinker_thermostat(
+            smile,
+            "f2bf9048bef64cc5b6d5110154e33c81",
+            good_schedules=["Weekschema", "Badkamer", "Test"],
+        )
+        assert result
+
+        # Special test-case for turning a schedule off based on only the location id.
+        await smile.set_schedule_state("f2bf9048bef64cc5b6d5110154e33c81", "off")
+
+        # Special test-case for turning a schedule off for a location via the option "off".
+        await smile.set_schedule_state("f2bf9048bef64cc5b6d5110154e33c81", "on", "off")
+
+        # bad schedule-state test
+        result = await self.tinker_thermostat_schedule(
+            smile,
+            "f2bf9048bef64cc5b6d5110154e33c81",
+            "bad",
+            good_schedules=["Badkamer"],
+            single=True,
+        )
+        assert result
+
+        smile._schedule_old_states["f2bf9048bef64cc5b6d5110154e33c81"][
+            "Badkamer"
+        ] = "off"
+        result_1 = await self.tinker_thermostat_schedule(
+            smile,
+            "f2bf9048bef64cc5b6d5110154e33c81",
+            "on",
+            good_schedules=["Badkamer"],
+            single=True,
+        )
+        result_2 = await self.tinker_thermostat_schedule(
+            smile,
+            "f2bf9048bef64cc5b6d5110154e33c81",
+            "on",
+            good_schedules=["Badkamer"],
+            single=True,
+        )
+        assert result_1 and result_2
+
+        switch_change = await self.tinker_switch(
+            smile,
+            "e8ef2a01ed3b4139a53bf749204fe6b4",
+            ["2568cc4b9c1e401495d4741a5f89bee1", "29542b2b6a6a4169acecc15c72a599b8"],
+        )
+        assert switch_change
+        switch_change = await self.tinker_switch(
+            smile, "056ee145a816487eaa69243c3280f8bf", model="dhw_cm_switch"
+        )
+        assert switch_change
+        switch_change = await self.tinker_switch(
+            smile, "854f8a9b0e7e425db97f1f110e1ce4b3", model="lock"
+        )
+        assert switch_change
+        switch_change = await self.tinker_switch(
+            smile, "2568cc4b9c1e401495d4741a5f89bee1"
+        )
+        assert not switch_change
+
+        tinkered = await self.tinker_gateway_mode(smile)
+        assert not tinkered
+
+        tinkered = await self.tinker_regulation_mode(smile)
+        assert not tinkered
+
+        tinkered = await self.tinker_max_boiler_temp(smile)
+        assert not tinkered
+
+        # Now change some data and change directory reading xml from
+        # emulating reading newer dataset after an update_interval
+        testdata_updated = self.load_testdata(
+            SMILE_TYPE, f"{self.smile_setup}_UPDATED_DATA"
+        )
+        self.smile_setup = "updated/adam_plus_anna_new"
+        await self.device_test(
+            smile, "2022-01-16 00:00:01", testdata_updated, initialize=False
+        )
+
+        # Simulate receiving no xml-data after a requesting a reboot of the gateway
+        self.smile_setup = "reboot/adam_plus_anna_new"
+        try:
+            await self.device_test(smile, initialize=False)
+        except pw_exceptions.PlugwiseError:
+            _LOGGER.debug("Receiving no data after a reboot is properly handled")
+
+        # Simulate receiving xml-data with <error>
+        self.smile_setup = "error/adam_plus_anna_new"
+        try:
+            await self.device_test(smile, initialize=False)
+        except pw_exceptions.ResponseError:
+            _LOGGER.debug("Receiving error-data from the Gateway")
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
+        self.smile_setup = "adam_plus_anna_new"
+        testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
+        server, smile, client = await self.connect_wrapper(raise_timeout=True)
+        await self.device_test(smile, "2023-12-17 00:00:01", testdata, skip_testing=True)
+
+        tinkered = await self.tinker_max_boiler_temp(smile, unhappy=True)
+        assert tinkered
+
+        tinkered = await self.tinker_gateway_mode(smile, unhappy=True)
+        assert tinkered
+
+        tinkered = await self.tinker_regulation_mode(smile, unhappy=True)
+        assert tinkered
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
 
     @pytest.mark.asyncio
     async def test_connect_adam_zone_per_device(self):
@@ -38,7 +186,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["82fa13f017d240daa0d0ea1775420f24"] == CV_JESSIE
         assert smile._last_active["08963fec7c53423ca5680aa4cb502c63"] == BADKAMER_SCHEMA
         assert smile._last_active["446ac08dd04d4eff8ac57489757b7314"] == BADKAMER_SCHEMA
-        assert self.device_items == 315
+        assert self.device_items == 323
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
         await smile.delete_notification()
@@ -116,7 +264,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["82fa13f017d240daa0d0ea1775420f24"] == CV_JESSIE
         assert smile._last_active["08963fec7c53423ca5680aa4cb502c63"] == BADKAMER_SCHEMA
         assert smile._last_active["446ac08dd04d4eff8ac57489757b7314"] == BADKAMER_SCHEMA
-        assert self.device_items == 315
+        assert self.device_items == 323
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
 
@@ -154,7 +302,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["a562019b0b1f47a4bde8ebe3dbe3e8a9"] == WERKDAG_SCHEMA
         assert smile._last_active["8cf650a4c10c44819e426bed406aec34"] == WERKDAG_SCHEMA
         assert smile._last_active["5cc21042f87f4b4c94ccb5537c47a53f"] == WERKDAG_SCHEMA
-        assert self.device_items == 415
+        assert self.device_items == 417
 
         await smile.close_connection()
         await self.disconnect(server, client)
@@ -230,154 +378,6 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await smile.close_connection()
         await self.disconnect(server, client)
 
-    @pytest.mark.asyncio
-    async def test_connect_adam_plus_anna_new(self):
-        """Test extended Adam (firmware 3.8) with Anna and a switch-group setup."""
-        self.smile_setup = "adam_plus_anna_new"
-
-        testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_wrapper()
-        assert smile.smile_hostname == "smile000000"
-
-        self.validate_test_basics(
-            _LOGGER,
-            smile,
-            smile_type=None,
-            smile_version="3.7.8",
-        )
-
-        await self.device_test(smile, "2023-12-17 00:00:01", testdata)
-        assert smile.gateway_id == "da224107914542988a88561b4452b0f6"
-        assert smile._last_active["f2bf9048bef64cc5b6d5110154e33c81"] == "Weekschema"
-        assert smile._last_active["f871b8c4d63549319221e294e4f88074"] == "Badkamer"
-        assert self.device_items == 147
-        assert self.device_list == [
-            "da224107914542988a88561b4452b0f6",
-            "056ee145a816487eaa69243c3280f8bf",
-            "67d73d0bd469422db25a618a5fb8eeb0",
-            "e2f4322d57924fa090fbbc48b3a140dc",
-            "29542b2b6a6a4169acecc15c72a599b8",
-            "ad4838d7d35c4d6ea796ee12ae5aedf8",
-            "1772a4ea304041adb83f357b751341ff",
-            "854f8a9b0e7e425db97f1f110e1ce4b3",
-            "2568cc4b9c1e401495d4741a5f89bee1",
-            "e8ef2a01ed3b4139a53bf749204fe6b4",
-        ]
-
-        result = await self.tinker_thermostat(
-            smile,
-            "f2bf9048bef64cc5b6d5110154e33c81",
-            good_schedules=["Weekschema", "Badkamer", "Test"],
-        )
-        assert result
-
-        # Special test-case for turning a schedule off based on only the location id.
-        await smile.set_schedule_state("f2bf9048bef64cc5b6d5110154e33c81", "off")
-
-        # Special test-case for turning a schedule off for a location via the option "off".
-        await smile.set_schedule_state("f2bf9048bef64cc5b6d5110154e33c81", "on", "off")
-
-        # bad schedule-state test
-        result = await self.tinker_thermostat_schedule(
-            smile,
-            "f2bf9048bef64cc5b6d5110154e33c81",
-            "bad",
-            good_schedules=["Badkamer"],
-            single=True,
-        )
-        assert result
-
-        smile._schedule_old_states["f2bf9048bef64cc5b6d5110154e33c81"][
-            "Badkamer"
-        ] = "off"
-        result_1 = await self.tinker_thermostat_schedule(
-            smile,
-            "f2bf9048bef64cc5b6d5110154e33c81",
-            "on",
-            good_schedules=["Badkamer"],
-            single=True,
-        )
-        result_2 = await self.tinker_thermostat_schedule(
-            smile,
-            "f2bf9048bef64cc5b6d5110154e33c81",
-            "on",
-            good_schedules=["Badkamer"],
-            single=True,
-        )
-        assert result_1 and result_2
-
-        switch_change = await self.tinker_switch(
-            smile,
-            "e8ef2a01ed3b4139a53bf749204fe6b4",
-            ["2568cc4b9c1e401495d4741a5f89bee1", "29542b2b6a6a4169acecc15c72a599b8"],
-        )
-        assert switch_change
-        switch_change = await self.tinker_switch(
-            smile, "056ee145a816487eaa69243c3280f8bf", model="dhw_cm_switch"
-        )
-        assert switch_change
-        switch_change = await self.tinker_switch(
-            smile, "854f8a9b0e7e425db97f1f110e1ce4b3", model="lock"
-        )
-        assert switch_change
-        switch_change = await self.tinker_switch(
-            smile, "2568cc4b9c1e401495d4741a5f89bee1"
-        )
-        assert not switch_change
-
-        tinkered = await self.tinker_gateway_mode(smile)
-        assert not tinkered
-
-        tinkered = await self.tinker_regulation_mode(smile)
-        assert not tinkered
-
-        tinkered = await self.tinker_max_boiler_temp(smile)
-        assert not tinkered
-
-        # Now change some data and change directory reading xml from
-        # emulating reading newer dataset after an update_interval
-        testdata_updated = self.load_testdata(
-            SMILE_TYPE, f"{self.smile_setup}_UPDATED_DATA"
-        )
-        self.smile_setup = "updated/adam_plus_anna_new"
-        await self.device_test(
-            smile, "2022-01-16 00:00:01", testdata_updated, initialize=False
-        )
-
-        # Simulate receiving no xml-data after a requesting a reboot of the gateway
-        self.smile_setup = "reboot/adam_plus_anna_new"
-        try:
-            await self.device_test(smile, initialize=False)
-        except pw_exceptions.PlugwiseError:
-            _LOGGER.debug("Receiving no data after a reboot is properly handled")
-
-        # Simulate receiving xml-data with <error>
-        self.smile_setup = "error/adam_plus_anna_new"
-        try:
-            await self.device_test(smile, initialize=False)
-        except pw_exceptions.ResponseError:
-            _LOGGER.debug("Receiving error-data from the Gateway")
-
-        await smile.close_connection()
-        await self.disconnect(server, client)
-
-        self.smile_setup = "adam_plus_anna_new"
-        testdata = self.load_testdata(SMILE_TYPE, self.smile_setup)
-        server, smile, client = await self.connect_wrapper(raise_timeout=True)
-        await self.device_test(smile, "2023-12-17 00:00:01", testdata, skip_testing=True)
-
-        tinkered = await self.tinker_max_boiler_temp(smile, unhappy=True)
-        assert tinkered
-
-        tinkered = await self.tinker_gateway_mode(smile, unhappy=True)
-        assert tinkered
-
-        tinkered = await self.tinker_regulation_mode(smile, unhappy=True)
-        assert tinkered
-
-        await smile.close_connection()
-        await self.disconnect(server, client)
-
     @pytest.mark.asyncio
     async def test_adam_plus_jip(self):
         """Test Adam with Jip setup."""
@@ -392,7 +392,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         assert smile._last_active["06aecb3d00354375924f50c47af36bd2"] is None
         assert smile._last_active["d27aede973b54be484f6842d1b2802ad"] is None
         assert smile._last_active["13228dab8ce04617af318a2888b3c548"] is None
-        assert self.device_items == 213
+        assert self.device_items == 217
 
         # Negative test
         result = await self.tinker_thermostat(