Merge pull request #304 from plugwise/legacy_anna_system

Add system-xml data for legacy Anna and adapt

Author: bouwew

CHANGELOG.md

@@ -1,16 +1,13 @@
 # Changelog
 
-## Ongoing
+## v0.31.1: Legacy Anna - read and process system-xml data
 
-- CI/CD Improvements
+- Add support for reading the system-xml data from the legacy Smile T
+- Repo-generic: CI/CD Improvements
 
-## v0.31 refactoring (alpha only, effectively not to be released): Logic separation between USB and non-USB
+## v0.31.0: Split off the USB-related code: the Plugwise Stick related code has been moved into [#plugwise_usb](https://github.com/plugwise/python-plugwise-usb)
 
-- Smile component (suggested `python-plugwise-usb` for USB (or stick-standalone) route)
-
-## v0.30 refactoring (alpha only, effectively unreleased)
-
-- More formal Split between Networked and USB code
+--- Split between Smile/Stretch and USB-Stick related code ---
 
 ## v0.27.10: Anna + Elga: final fix for [#320](https://github.com/plugwise/plugwise-beta/issues/320)
 

plugwise/__init__.py

@@ -380,7 +380,9 @@ async def connect(self) -> bool:
 
         return True
 
-    async def _smile_detect_legacy(self, result: etree, dsmrmain: etree) -> str:
+    async def _smile_detect_legacy(
+        self, result: etree, dsmrmain: etree, model: str
+    ) -> str:
         """Helper-function for _smile_detect()."""
         # Stretch: find the MAC of the zigbee master_controller (= Stick)
         if network := result.find("./module/protocols/master_controller"):
@@ -392,33 +394,30 @@ async def _smile_detect_legacy(self, result: etree, dsmrmain: etree) -> str:
                     network = zb_network.find("./master_controller")
                     self.smile_zigbee_mac_address = network.find("mac_address").text
 
-        # Assume legacy
         self._smile_legacy = True
-        # Try if it is a legacy Anna, assuming appliance thermostat,
-        # fake insert version assuming Anna, couldn't find another way to identify as legacy Anna
-        self.smile_fw_version = "1.8.0"
-        model = "smile_thermo"
-        if result.find('./appliance[type="thermostat"]') is None:
-            # It's a P1 legacy:
+        # Legacy Anna or Stretch:
+        if (
+            result.find('./appliance[type="thermostat"]') is not None
+            or network is not None
+        ):
+            self._system = await self._request(SYSTEM)
+            self.smile_fw_version = self._system.find("./gateway/firmware").text
+            model = self._system.find("./gateway/product").text
+            self.smile_hostname = self._system.find("./gateway/hostname").text
+            # If wlan0 contains data it's active, so eth0 should be checked last
+            for network in ("wlan0", "eth0"):
+                locator = f"./{network}/mac"
+                if (net_locator := self._system.find(locator)) is not None:
+                    self.smile_mac_address = net_locator.text
+        else:
+            # P1 legacy:
             if dsmrmain is not None:
                 self._status = await self._request(STATUS)
                 self.smile_fw_version = self._status.find("./system/version").text
                 model = self._status.find("./system/product").text
                 self.smile_hostname = self._status.find("./network/hostname").text
                 self.smile_mac_address = self._status.find("./network/mac_address").text
 
-            # Or a legacy Stretch:
-            elif network is not None:
-                self._system = await self._request(SYSTEM)
-                self.smile_fw_version = self._system.find("./gateway/firmware").text
-                model = self._system.find("./gateway/product").text
-                self.smile_hostname = self._system.find("./gateway/hostname").text
-                # If wlan0 contains data it's active, so eth0 should be checked last
-                for network in ("wlan0", "eth0"):
-                    locator = f"./{network}/mac"
-                    if (net_locator := self._system.find(locator)) is not None:
-                        self.smile_mac_address = net_locator.text
-
             else:  # pragma: no cover
                 # No cornercase, just end of the line
                 LOGGER.error(
@@ -434,17 +433,18 @@ async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
 
         Detect which type of Smile is connected.
         """
-        model: str | None = None
+        model: str = "Unknown"
         if (gateway := result.find("./gateway")) is not None:
-            model = gateway.find("vendor_model").text
+            if (v_model := gateway.find("vendor_model")) is not None:
+                model = v_model.text
             self.smile_fw_version = gateway.find("firmware_version").text
             self.smile_hw_version = gateway.find("hardware_version").text
             self.smile_hostname = gateway.find("hostname").text
             self.smile_mac_address = gateway.find("mac_address").text
         else:
-            model = await self._smile_detect_legacy(result, dsmrmain)
+            model = await self._smile_detect_legacy(result, dsmrmain, model)
 
-        if model is None or self.smile_fw_version is None:  # pragma: no cover
+        if model == "Unknown" or self.smile_fw_version is None:  # pragma: no cover
             # Corner case check
             LOGGER.error(
                 "Unable to find model or version information, please create \

pyproject.toml

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

tests/test_smile.py

@@ -655,8 +655,9 @@ async def test_connect_legacy_anna(self):
         testdata = {
             "0000aaaa0000aaaa0000aaaa0000aa00": {
                 "dev_class": "gateway",
-                "firmware": "1.8.0",
+                "firmware": "1.8.22",
                 "location": "0000aaaa0000aaaa0000aaaa0000aa00",
+                "mac_address": "01:23:45:67:89:AB",
                 "model": "Gateway",
                 "name": "Smile Anna",
                 "vendor": "Plugwise",
@@ -709,19 +710,19 @@ async def test_connect_legacy_anna(self):
 
         self.smile_setup = "legacy_anna"
         server, smile, client = await self.connect_wrapper()
-        assert smile.smile_hostname is None
+        assert smile.smile_hostname == "smile000000"
 
         _LOGGER.info("Basics:")
         _LOGGER.info(" # Assert type = thermostat")
         assert smile.smile_type == "thermostat"
         _LOGGER.info(" # Assert version")
-        assert smile.smile_version[0] == "1.8.0"
+        assert smile.smile_version[0] == "1.8.22"
         _LOGGER.info(" # Assert legacy")
         assert smile._smile_legacy
 
         await self.device_test(smile, testdata)
         assert smile.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
-        assert self.device_items == 44
+        assert self.device_items == 45
         assert not self.notifications
 
         result = await self.tinker_thermostat(
@@ -755,8 +756,9 @@ async def test_connect_legacy_anna_2(self):
         testdata = {
             "be81e3f8275b4129852c4d8d550ae2eb": {
                 "dev_class": "gateway",
-                "firmware": "1.8.0",
+                "firmware": "1.8.22",
                 "location": "be81e3f8275b4129852c4d8d550ae2eb",
+                "mac_address": "01:23:45:67:89:AB",
                 "model": "Gateway",
                 "name": "Smile Anna",
                 "vendor": "Plugwise",
@@ -809,20 +811,20 @@ async def test_connect_legacy_anna_2(self):
 
         self.smile_setup = "legacy_anna_2"
         server, smile, client = await self.connect_wrapper()
-        assert smile.smile_hostname is None
+        assert smile.smile_hostname == "smile000000"
 
         _LOGGER.info("Basics:")
         _LOGGER.info(" # Assert type = thermostat")
         assert smile.smile_type == "thermostat"
         _LOGGER.info(" # Assert version")
-        assert smile.smile_version[0] == "1.8.0"
+        assert smile.smile_version[0] == "1.8.22"
         _LOGGER.info(" # Assert legacy")
         assert smile._smile_legacy
 
         await self.device_test(smile, testdata)
 
         assert smile.gateway_id == "be81e3f8275b4129852c4d8d550ae2eb"
-        assert self.device_items == 44
+        assert self.device_items == 45
         assert not self.notifications
 
         result = await self.tinker_thermostat(

userdata/legacy_anna/system.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<system>
+	<gateway>
+		<product>smile_thermo</product>
+		<hostname>smile000000</hostname>
+		<firmware>1.8.22</firmware>
+		<upgrade/>
+	</gateway>
+	<wlan0>
+		<mac>01:23:45:67:89:AB</mac>
+		<ip>127.0.0.1</ip>
+		<bcast>127.0.0.1</bcast>
+		<mask>127.0.0.1</mask>
+		<encryption><![CDATA[psk2]]></encryption>
+		<proto>static</proto>
+		<gateway>127.0.0.1</gateway>
+		<dns>127.0.0.1</dns>
+		<ieee>802.11bgn</ieee>
+		<ssid><![CDATA[accespoint name]]></ssid>
+		<mode>Client</mode>
+		<frequency unit="GHz">2.437</frequency>
+		<access_point_mac>01:23:45:67:89:AB</access_point_mac>
+		<link_quality>47/70</link_quality>
+		<signal_strength unit="dBm">-63</signal_strength>
+	</wlan0>
+	<eth0/>
+	<time>2022-10-17T14:50:00.511+02:00</time>
+	<timezone><![CDATA[Europe/Amsterdam]]></timezone>
+<remote_control origin='any'>not initialized</remote_control></system>

userdata/legacy_anna/system_status_xml.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<system>
+	<gateway>
+		<product>smile_thermo</product>
+		<hostname>smile000000</hostname>
+		<firmware>1.8.22</firmware>
+		<upgrade/>
+	</gateway>
+	<wlan0>
+		<mac>01:23:45:67:89:AB</mac>
+		<ip>127.0.0.1</ip>
+		<bcast>127.0.0.1</bcast>
+		<mask>127.0.0.1</mask>
+		<encryption><![CDATA[psk2]]></encryption>
+		<proto>static</proto>
+		<gateway>127.0.0.1</gateway>
+		<dns>127.0.0.1</dns>
+		<ieee>802.11bgn</ieee>
+		<ssid><![CDATA[accespoint name]]></ssid>
+		<mode>Client</mode>
+		<frequency unit="GHz">2.437</frequency>
+		<access_point_mac>01:23:45:67:89:AB</access_point_mac>
+		<link_quality>47/70</link_quality>
+		<signal_strength unit="dBm">-63</signal_strength>
+	</wlan0>
+	<eth0/>
+	<time>2022-10-17T14:50:00.511+02:00</time>
+	<timezone><![CDATA[Europe/Amsterdam]]></timezone>
+<remote_control origin='any'>not initialized</remote_control></system>