plugwise 1.1.0a0__tar.gz → 1.3.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.1.0a0
+Version: 1.3.0
 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.1.0a0 → plugwise-1.3.0}/plugwise/common.py

@@ -52,6 +52,7 @@ class SmileCommon:
         self,
         appl: Munch,
         xml_1: etree,
+        legacy: bool,
         xml_2: etree = None,
         xml_3: etree = None,
     ) -> Munch:
@@ -68,8 +69,8 @@ class SmileCommon:
         #  Info for On-Off device
         if self._on_off_device:
             appl.name = "OnOff"  # pragma: no cover
-            appl.vendor_name = None  # pragma: no cover
             appl.model = "Unknown"  # pragma: no cover
+            appl.vendor_name = None  # pragma: no cover
             return appl  # pragma: no cover
 
         # Info for OpenTherm device
@@ -85,13 +86,12 @@ class SmileCommon:
             module_data = self._get_module_data(xml_1, locator_2, mod_type, xml_3)
         appl.vendor_name = module_data["vendor_name"]
         appl.hardware = module_data["hardware_version"]
-        appl.model = module_data["vendor_model"]
-        if appl.model is None:
-            appl.model = (
-                "Generic heater/cooler"
-                if self._cooling_present
-                else "Generic heater"
-            )
+        appl.model_id = module_data["vendor_model"] if not legacy else None
+        appl.model = (
+            "Generic heater/cooler"
+            if self._cooling_present
+            else "Generic heater"
+        )
 
         return appl
 
@@ -102,7 +102,11 @@ class SmileCommon:
         xml_2 = return_valid(xml_2, self._domain_objects)
         module_data = self._get_module_data(xml_1, locator, mod_type, xml_2)
         appl.vendor_name = module_data["vendor_name"]
-        appl.model = check_model(module_data["vendor_model"], appl.vendor_name)
+        appl.model = module_data["vendor_model"]
+        if appl.model != "ThermoTouch":  # model_id for Anna not present as stand-alone device
+            appl.model_id = appl.model
+            appl.model = check_model(appl.model, appl.vendor_name)
+
         appl.hardware = module_data["hardware_version"]
         appl.firmware = module_data["firmware_version"]
         appl.zigbee_mac = module_data["zigbee_mac_address"]
@@ -197,6 +201,7 @@ class SmileCommon:
             "location": appl.location,
             "mac_address": appl.mac,
             "model": appl.model,
+            "model_id": appl.model_id,
             "name": appl.name,
             "zigbee_mac_address": appl.zigbee_mac,
             "vendor": appl.vendor_name,

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

@@ -258,13 +258,13 @@ ApplianceType = Literal[
 ]
 
 BinarySensorType = Literal[
-    "battery_state",
     "compressor_state",
     "cooling_enabled",
     "cooling_state",
     "dhw_state",
     "flame_state",
     "heating_state",
+    "low_battery",
     "plugwise_notification",
     "secondary_boiler_state",
 ]
@@ -410,13 +410,13 @@ class ModelData(TypedDict):
 class SmileBinarySensors(TypedDict, total=False):
     """Smile Binary Sensors class."""
 
-    battery_state: bool
     compressor_state: bool
     cooling_enabled: bool
     cooling_state: bool
     dhw_state: bool
     flame_state: bool
     heating_state: bool
+    low_battery: bool
     plugwise_notification: bool
     secondary_boiler_state: bool
 

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

@@ -62,25 +62,21 @@ class SmileData(SmileHelper):
                 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 "low_battery" 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)
-                )
+                and device["dev_class"] in ("thermo_sensor", "thermostatic_radiator_valve", "zone_thermometer", "zone_thermostat")
             )
             if is_battery_low:
-                device["binary_sensors"]["battery_state"] = True
+                device["binary_sensors"]["low_battery"] = 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."""
+        """Helper-function updating the low-battery 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"]
@@ -88,12 +84,15 @@ class SmileData(SmileHelper):
             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)):
+                warning: str | None = notification.get("warning")
+                notify = message or warning
+                if notify is not None and all(x in notify for x in matches) and (mac_addresses := mac_pattern.findall(notify)):
                     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)
+                    if message is not None:  # only block message-type notifications
+                        self._notifications.pop(msg_id)
 
         return mac_address_list
 

{plugwise-1.1.0a0 → plugwise-1.3.0}/plugwise/helper.py

@@ -285,7 +285,8 @@ class SmileHelper(SmileCommon):
 
             appl.dev_id = appliance.attrib["id"]
             appl.name = appliance.find("name").text
-            appl.model = appl.pwclass.replace("_", " ").title()
+            appl.model = None
+            appl.model_id = None
             appl.firmware = None
             appl.hardware = None
             appl.mac = None
@@ -350,7 +351,8 @@ class SmileHelper(SmileCommon):
         appl.dev_id = self.gateway_id
         appl.location = loc_id
         appl.mac = None
-        appl.model = self.smile_model
+        appl.model = self._domain_objects.find("./gateway/vendor_model").text
+        appl.model_id = None
         appl.name = "P1"
         appl.pwclass = "smartmeter"
         appl.zigbee_mac = None
@@ -370,7 +372,7 @@ class SmileHelper(SmileCommon):
                 return self._appl_thermostat_info(appl, appliance)
             case "heater_central":
                 # Collect heater_central device info
-                self._appl_heater_central_info(appl, appliance)
+                self._appl_heater_central_info(appl, appliance, False)  # False means non-legacy device
                 self._appl_dhw_mode_info(appl, appliance)
                 return appl
             case _:
@@ -380,14 +382,14 @@ class SmileHelper(SmileCommon):
     def _energy_device_info_finder(self, appl: Munch, appliance: etree) -> Munch:
         """Helper-function for _appliance_info_finder().
 
-        Collect energy device info (Smartmeter, Plug): firmware, model and vendor name.
+        Collect energy device info (Smartmeter): firmware, model and vendor name.
         """
         if self.smile_type == "power":
             locator = "./logs/point_log/electricity_point_meter"
             mod_type = "electricity_point_meter"
             module_data = self._get_module_data(appliance, locator, mod_type)
             appl.hardware = module_data["hardware_version"]
-            appl.model = module_data["vendor_model"]
+            appl.model = module_data["vendor_model"]  # don't use model_id for Smartmeter
             appl.vendor_name = module_data["vendor_name"]
             appl.firmware = module_data["firmware_version"]
 
@@ -403,7 +405,8 @@ class SmileHelper(SmileCommon):
                 return None
 
             appl.vendor_name = module_data["vendor_name"]
-            appl.model = check_model(module_data["vendor_model"], appl.vendor_name)
+            appl.model_id = module_data["vendor_model"]
+            appl.model = check_model(appl.model_id, appl.vendor_name)
             appl.hardware = module_data["hardware_version"]
             appl.firmware = module_data["firmware_version"]
 
@@ -418,6 +421,7 @@ class SmileHelper(SmileCommon):
         appl.hardware = self.smile_hw_version
         appl.mac = self.smile_mac_address
         appl.model = self.smile_model
+        appl.model_id = self._domain_objects.find("./gateway/vendor_model").text
         appl.name = self.smile_name
         appl.vendor_name = "Plugwise"
 

{plugwise-1.1.0a0 → plugwise-1.3.0}/plugwise/legacy/helper.py

@@ -117,6 +117,7 @@ class SmileLegacyHelper(SmileCommon):
             appl.dev_id = appliance.attrib["id"]
             appl.name = appliance.find("name").text
             appl.model = appl.pwclass.replace("_", " ").title()
+            appl.model_id = None
             appl.firmware = None
             appl.hardware = None
             appl.mac = None
@@ -207,7 +208,9 @@ class SmileLegacyHelper(SmileCommon):
                 return self._appl_thermostat_info(appl, appliance, self._modules)
         # Collect heater_central device info
             case "heater_central":
-                return self._appl_heater_central_info(appl, appliance, self._appliances, self._modules)
+                return self._appl_heater_central_info(
+                    appl, appliance, True, self._appliances, self._modules
+                )  # True means legacy device
         # Collect info from Stretches
             case _:
                 return self._energy_device_info_finder(appliance, appl)
@@ -246,6 +249,7 @@ class SmileLegacyHelper(SmileCommon):
         appl.location = loc_id
         appl.mac = None
         appl.model = self.smile_model
+        appl.model_id = None
         appl.name = "P1"
         appl.pwclass = "smartmeter"
         appl.zigbee_mac = None

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

@@ -110,6 +110,9 @@ def check_model(name: str | None, vendor_name: str | None) -> str | None:
     if vendor_name == "Plugwise" and ((model := version_to_model(name)) != "Unknown"):
         return model
 
+    if name is not None and "lumi.plug" in name:
+        return "Aqara Smart Plug"
+
     return name
 
 
@@ -139,7 +142,7 @@ def common_match_cases(
             data[sp_key] = value
 
     if "battery" in data["sensors"]:
-        data["binary_sensors"]["battery_state"] = False
+        data["binary_sensors"]["low_battery"] = False
 
 
 def escape_illegal_xml_characters(xmldata: str) -> str:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.1.0a0
+Version: 1.3.0
 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.1.0a0 → plugwise-1.3.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools~=72.1", "wheel~=0.44.0"]
+requires = ["setuptools~=74.0", "wheel~=0.44.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.1.0a0"
+version         = "1.3.0"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"

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

@@ -36,7 +36,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         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_items == 157
         assert self.device_list == [
             "da224107914542988a88561b4452b0f6",
             "056ee145a816487eaa69243c3280f8bf",
@@ -186,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 == 323
+        assert self.device_items == 340
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
         await smile.delete_notification()
@@ -264,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 == 323
+        assert self.device_items == 340
 
         assert "af82e4ccf9c548528166d38e560662a4" in self.notifications
 
@@ -302,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 == 417
+        assert self.device_items == 439
 
         await smile.close_connection()
         await self.disconnect(server, client)
@@ -323,7 +323,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         )
 
         await self.device_test(smile, "2022-01-02 00:00:01", testdata)
-        assert self.device_items == 56
+        assert self.device_items == 58
         assert self.cooling_present
         # assert self._cooling_enabled - no cooling_enabled indication present
 
@@ -348,7 +348,7 @@ class TestPlugwiseAdam(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(smile, "2020-03-22 00:00:01", testdata)
         assert smile.gateway_id == "b128b4bbbd1f47e9bf4d756e8fb5ee94"
         assert smile._last_active["009490cc2f674ce6b576863fbb64f867"] == "Weekschema"
-        assert self.device_items == 70
+        assert self.device_items == 73
         assert "6fb89e35caeb4b1cb275184895202d84" in self.notifications
 
         result = await self.tinker_thermostat(
@@ -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 == 217
+        assert self.device_items == 228
 
         # Negative test
         result = await self.tinker_thermostat(

{plugwise-1.1.0a0 → plugwise-1.3.0}/tests/test_anna.py

@@ -30,7 +30,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(smile, "2020-04-05 00:00:01", testdata)
         assert smile.gateway_id == "0466eae8520144c78afb29628384edeb"
         assert smile._last_active["eb5309212bf5407bb143e5bfa3b18aee"] == "Standaard"
-        assert self.device_items == 56
+        assert self.device_items == 58
         assert not self.notifications
 
         assert not self.cooling_present
@@ -105,7 +105,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
         await self.device_test(smile, "2020-04-05 00:00:01", testdata)
         assert smile._last_active["eb5309212bf5407bb143e5bfa3b18aee"] == "Standaard"
-        assert self.device_items == 56
+        assert self.device_items == 58
         assert not self.notifications
 
         result = await self.tinker_thermostat(
@@ -138,7 +138,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         )
 
         await self.device_test(smile, "2020-04-05 00:00:01", testdata)
-        assert self.device_items == 56
+        assert self.device_items == 58
 
         result = await self.tinker_thermostat(
             smile,
@@ -167,7 +167,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile._last_active["c34c6864216446528e95d88985e714cc"] == "Normaal"
-        assert self.device_items == 38
+        assert self.device_items == 39
         assert not self.notifications
 
         result = await self.tinker_thermostat(
@@ -196,7 +196,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(smile, "2020-04-12 00:00:01", testdata)
         assert smile.gateway_id == "015ae9ea3f964e668e490fa39da3870b"
         assert smile._last_active["c784ee9fdab44e1395b8dee7d7a497d5"] == "standaard"
-        assert self.device_items == 66
+        assert self.device_items == 67
         assert not self.notifications
         assert self.cooling_present
         assert not self._cooling_enabled
@@ -225,7 +225,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(
             smile, "2020-04-13 00:00:01", testdata_updated, initialize=False
         )
-        assert self.device_items == 63
+        assert self.device_items == 64
         await smile.close_connection()
         await self.disconnect(server, client)
 
@@ -251,7 +251,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
         await self.device_test(smile, "2020-04-19 00:00:01", testdata)
         assert smile._last_active["c784ee9fdab44e1395b8dee7d7a497d5"] == "standaard"
-        assert self.device_items == 63
+        assert self.device_items == 64
         assert self.cooling_present
         assert not self.notifications
 
@@ -296,7 +296,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         )
 
         await self.device_test(smile, "2020-04-19 00:00:01", testdata)
-        assert self.device_items == 63
+        assert self.device_items == 64
         assert self.cooling_present
         assert self._cooling_enabled
         assert self._cooling_active
@@ -323,7 +323,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         await self.device_test(smile, "2020-04-12 00:00:01", testdata)
         assert smile.gateway_id == "015ae9ea3f964e668e490fa39da3870b"
         assert smile._last_active["c784ee9fdab44e1395b8dee7d7a497d5"] == "standaard"
-        assert self.device_items == 62
+        assert self.device_items == 63
         assert not self.notifications
         assert not self.cooling_present
 
@@ -350,7 +350,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
             smile._last_active["d3ce834534114348be628b61b26d9220"]
             == THERMOSTAT_SCHEDULE
         )
-        assert self.device_items == 62
+        assert self.device_items == 63
         assert smile.gateway_id == "fb49af122f6e4b0f91267e1cf7666d6f"
         assert self.cooling_present
         assert not self._cooling_enabled
@@ -375,7 +375,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         )
         assert self.cooling_present
         assert not self._cooling_enabled
-        assert self.device_items == 62
+        assert self.device_items == 63
 
         await smile.close_connection()
         await self.disconnect(server, client)
@@ -404,7 +404,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
             smile._last_active["d3ce834534114348be628b61b26d9220"]
             == THERMOSTAT_SCHEDULE
         )
-        assert self.device_items == 62
+        assert self.device_items == 63
         assert not self.notifications
 
         assert self.cooling_present
@@ -431,7 +431,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile._last_active["15da035090b847e7a21f93e08c015ebc"] == "Winter"
-        assert self.device_items == 64
+        assert self.device_items == 66
         assert self.cooling_present
         assert not self._cooling_enabled
 
@@ -497,7 +497,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile._last_active["15da035090b847e7a21f93e08c015ebc"] == "Winter"
-        assert self.device_items == 64
+        assert self.device_items == 66
         assert self.cooling_present
         assert self._cooling_enabled
 
@@ -520,7 +520,7 @@ class TestPlugwiseAnna(TestPlugwise):  # pylint: disable=attribute-defined-outsi
         )
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
-        assert self.device_items == 64
+        assert self.device_items == 66
         assert self.cooling_present
         assert not self._cooling_enabled
 

{plugwise-1.1.0a0 → plugwise-1.3.0}/tests/test_p1.py

@@ -28,7 +28,7 @@ class TestPlugwiseP1(TestPlugwise):  # pylint: disable=attribute-defined-outside
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile.gateway_id == "a455b61e52394b2db5081ce025a430f3"
-        assert self.device_items == 29
+        assert self.device_items == 30
         assert "97a04c0c263049b29350a660b4cdd01e" in self.notifications
 
         await smile.close_connection()
@@ -52,7 +52,7 @@ class TestPlugwiseP1(TestPlugwise):  # pylint: disable=attribute-defined-outside
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile.gateway_id == "a455b61e52394b2db5081ce025a430f3"
-        assert self.device_items == 31
+        assert self.device_items == 32
         assert not self.notifications
 
         # Now change some data and change directory reading xml from
@@ -86,7 +86,7 @@ class TestPlugwiseP1(TestPlugwise):  # pylint: disable=attribute-defined-outside
 
         await self.device_test(smile, "2022-05-16 00:00:01", testdata)
         assert smile.gateway_id == "03e65b16e4b247a29ae0d75a78cb492e"
-        assert self.device_items == 40
+        assert self.device_items == 41
         assert self.notifications
 
         await smile.close_connection()