Move _get_module_data() to common.py

bouwew · bouwew · commit 7112b867d93c · 2024-02-09T13:44:32.000+01:00
diff --git a/plugwise/common.py b/plugwise/common.py
@@ -4,6 +4,7 @@
 """
 from __future__ import annotations
 
+from plugwise.constants import ModelData
 from plugwise.util import check_heater_central, check_model
 
 from defusedxml import ElementTree as etree
@@ -16,6 +17,7 @@ class SmileCommon:
     def __init__(self) -> None:
         """Init."""
         self._appliances: etree
+        self._cooling_present: bool
         self._heater_id: str
         self._on_off_device: bool
         self._opentherm_device: bool
@@ -25,12 +27,11 @@ def smile(self, name: str) -> bool:
         """Helper-function checking the smile-name."""
         return self.smile_name == name
 
-    def _appl_thermostat_info(self, xml: etree, appl: Munch) -> Munch:
+    def _appl_thermostat_info(self, xml_1: etree, xml_2: etree, appl: Munch) -> Munch:
         """Helper-function for _appliance_info_finder()."""
-        # Collect thermostat device info
         locator = "./logs/point_log[type='thermostat']/thermostat"
         mod_type = "thermostat"
-        module_data = self._get_module_data(xml, locator, mod_type)
+        module_data = self._get_module_data(xml_1, xml_2, locator, mod_type)
         appl.vendor_name = module_data["vendor_name"]
         appl.model = check_model(module_data["vendor_model"], appl.vendor_name)
         appl.hardware = module_data["hardware_version"]
@@ -39,13 +40,20 @@ def _appl_thermostat_info(self, xml: etree, appl: Munch) -> Munch:
 
         return appl
 
-    def _appl_heater_central_info(self, xml_1: etree, xml_2: etree, appl: Munch) -> Munch:
+    def _appl_heater_central_info(
+        self,
+        xml_1: etree,
+        xml_2: etree,
+        xml_3: etree,
+        appl: Munch
+    ) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         # Remove heater_central when no active device present
         if not self._opentherm_device and not self._on_off_device:
             return None
 
         # Find the valid heater_central
+        # xml_1 = self._appliances for legacy, self._domain_objects for actual
         self._heater_id = check_heater_central(xml_1)
 
         #  Info for On-Off device
@@ -57,16 +65,70 @@ def _appl_heater_central_info(self, xml_1: etree, xml_2: etree, appl: Munch) ->
 
         # Info for OpenTherm device
         appl.name = "OpenTherm"
-        locator1 = "./logs/point_log[type='flame_state']/boiler_state"
-        locator2 = "./services/boiler_state"
+        locator_1 = "./logs/point_log[type='flame_state']/boiler_state"
+        locator_2 = "./services/boiler_state"
         mod_type = "boiler_state"
-        module_data = self._get_module_data(xml_2, locator1, mod_type)
+        # xml_2 = appliance
+        # xml_3 = self._modules for legacy, self._domain_objects for actual
+        module_data = self._get_module_data(xml_2, xml_3, locator_1, mod_type)
         if not module_data["contents"]:
-            module_data = self._get_module_data(xml_2, locator2, mod_type)
+            module_data = self._get_module_data(xml_2, xml_3, locator_2, mod_type)
         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"
+            appl.model = (
+                "Generic heater/cooler"
+                if self._cooling_present
+                else "Generic heater"
+            )
 
         return appl
+
+    def _get_module_data(
+        self, xml_1: etree, xml_2: etree, locator: str, mod_type: str, legacy=False,
+    ) -> ModelData:
+        """Helper-function for _energy_device_info_finder() and _appliance_info_finder().
+
+        Collect requested info from MODULES.
+        """
+        model_data: ModelData = {
+            "contents": False,
+            "firmware_version": None,
+            "hardware_version": None,
+            "reachable": None,
+            "vendor_name": None,
+            "vendor_model": None,
+            "zigbee_mac_address": None,
+        }
+        # xml_1 = appliance
+        if (appl_search := xml_1.find(locator)) is not None:
+            link_id = appl_search.attrib["id"]
+            loc = f".//services/{mod_type}[@id='{link_id}']...."
+            if legacy:
+                loc = f".//{mod_type}[@id='{link_id}']...."
+            # Not possible to walrus for some reason...
+            # xml_2 = self._modules for legacy, self._domain_objects for actual
+            module = xml_2.find(loc)
+            if module is not None:  # pylint: disable=consider-using-assignment-expr
+                model_data["contents"] = True
+                if (vendor_name := module.find("vendor_name").text) is not None:
+                    model_data["vendor_name"] = vendor_name
+                    if "Plugwise" in vendor_name:
+                        model_data["vendor_name"] = vendor_name.split(" ", 1)[0]
+                model_data["vendor_model"] = module.find("vendor_model").text
+                model_data["hardware_version"] = module.find("hardware_version").text
+                model_data["firmware_version"] = module.find("firmware_version").text
+                if legacy:
+                    # Stretches
+                    if (router := module.find("./protocols/network_router")) is not None:
+                        model_data["zigbee_mac_address"] = router.find("mac_address").text
+                    # Also look for the Circle+/Stealth M+
+                    if (coord := module.find("./protocols/network_coordinator")) is not None:
+                        model_data["zigbee_mac_address"] = coord.find("mac_address").text
+                # Adam
+                elif (zb_node := module.find("./protocols/zig_bee_node")) is not None:
+                        model_data["zigbee_mac_address"] = zb_node.find("mac_address").text
+                        model_data["reachable"] = zb_node.find("reachable").text == "true"
+
+        return model_data
diff --git a/plugwise/helper.py b/plugwise/helper.py
@@ -46,7 +46,6 @@
     BinarySensorType,
     DeviceData,
     GatewayData,
-    ModelData,
     SensorType,
     SpecialType,
     SwitchType,
@@ -261,43 +260,6 @@ def _all_locations(self) -> None:
 
             self.loc_data[loc.loc_id] = {"name": loc.name}
 
-    def _get_module_data(
-        self, appliance: etree, locator: str, mod_type: str
-    ) -> ModelData:
-        """Helper-function for _energy_device_info_finder() and _appliance_info_finder().
-
-        Collect requested info from MODULES.
-        """
-        model_data: ModelData = {
-            "contents": False,
-            "firmware_version": None,
-            "hardware_version": None,
-            "reachable": None,
-            "vendor_name": None,
-            "vendor_model": None,
-            "zigbee_mac_address": None,
-        }
-        if (appl_search := appliance.find(locator)) is not None:
-            link_id = appl_search.attrib["id"]
-            loc = f".//services/{mod_type}[@id='{link_id}']...."
-            # Not possible to walrus for some reason...
-            module = self._domain_objects.find(loc)
-            if module is not None:  # pylint: disable=consider-using-assignment-expr
-                model_data["contents"] = True
-                if (vendor_name := module.find("vendor_name").text) is not None:
-                    model_data["vendor_name"] = vendor_name
-                    if "Plugwise" in vendor_name:
-                        model_data["vendor_name"] = vendor_name.split(" ", 1)[0]
-                model_data["vendor_model"] = module.find("vendor_model").text
-                model_data["hardware_version"] = module.find("hardware_version").text
-                model_data["firmware_version"] = module.find("firmware_version").text
-                # Adam
-                if (zb_node := module.find("./protocols/zig_bee_node")) is not None:
-                    model_data["zigbee_mac_address"] = zb_node.find("mac_address").text
-                    model_data["reachable"] = zb_node.find("reachable").text == "true"
-
-        return model_data
-
     def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         """Helper-function for _appliance_info_finder().
 
@@ -306,7 +268,7 @@ def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         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)
+            module_data = self._get_module_data(appliance, self._domain_objects, locator, mod_type)
             appl.hardware = module_data["hardware_version"]
             appl.model = module_data["vendor_model"]
             appl.vendor_name = module_data["vendor_name"]
@@ -317,7 +279,7 @@ def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         if self.smile(ADAM):
             locator = "./logs/interval_log/electricity_interval_meter"
             mod_type = "electricity_interval_meter"
-            module_data = self._get_module_data(appliance, locator, mod_type)
+            module_data = self._get_module_data(appliance, self._domain_objects, locator, mod_type)
             # Filter appliance without zigbee_mac, it's an orphaned device
             appl.zigbee_mac = module_data["zigbee_mac_address"]
             if appl.zigbee_mac is None:
@@ -372,11 +334,11 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
 
         # Collect thermostat device info
         if appl.pwclass in THERMOSTAT_CLASSES:
-            return self._appl_thermostat_info(appliance, appl)
+            return self._appl_thermostat_info(appliance, self._domain_objects, appl)
 
         # Collect extra heater_central device info
         if appl.pwclass == "heater_central":
-            appl = self._appl_heater_central_info(self._domain_objects, appliance, appl)
+            appl = self._appl_heater_central_info(self._domain_objects, appliance, self._domain_objects, appl)
             # Anna + Loria: collect dhw control operation modes
             dhw_mode_list: list[str] = []
             locator = "./actuator_functionalities/domestic_hot_water_mode_control_functionality"
@@ -672,12 +634,12 @@ def _wireless_availability(self, appliance: etree, data: DeviceData) -> None:
             # Collect for Plugs
             locator = "./logs/interval_log/electricity_interval_meter"
             mod_type = "electricity_interval_meter"
-            module_data = self._get_module_data(appliance, locator, mod_type)
+            module_data = self._get_module_data(appliance, self._domain_objects, locator, mod_type)
             if module_data["reachable"] is None:
                 # Collect for wireless thermostats
                 locator = "./logs/point_log[type='thermostat']/thermostat"
                 mod_type = "thermostat"
-                module_data = self._get_module_data(appliance, locator, mod_type)
+                module_data = self._get_module_data(appliance, self._domain_objects, locator, mod_type)
 
             if module_data["reachable"] is not None:
                 data["available"] = module_data["reachable"]
diff --git a/plugwise/legacy/helper.py b/plugwise/legacy/helper.py
@@ -41,7 +41,6 @@
     BinarySensorType,
     DeviceData,
     GatewayData,
-    ModelData,
     SensorType,
     SpecialType,
     SwitchType,
@@ -128,45 +127,6 @@ def _all_locations(self) -> None:
 
             self.loc_data[loc.loc_id] = {"name": loc.name}
 
-    def _get_module_data(
-        self, appliance: etree, locator: str, mod_type: str
-    ) -> ModelData:
-        """Helper-function for _energy_device_info_finder() and _appliance_info_finder().
-
-        Collect requested info from MODULES.
-        """
-        model_data: ModelData = {
-            "contents": False,
-            "firmware_version": None,
-            "hardware_version": None,
-            "reachable": None,
-            "vendor_name": None,
-            "vendor_model": None,
-            "zigbee_mac_address": None,
-        }
-        if (appl_search := appliance.find(locator)) is not None:
-            link_id = appl_search.attrib["id"]
-            loc = f".//{mod_type}[@id='{link_id}']...."
-            # Not possible to walrus for some reason...
-            module = self._modules.find(loc)
-            if module is not None:  # pylint: disable=consider-using-assignment-expr
-                model_data["contents"] = True
-                if (vendor_name := module.find("vendor_name").text) is not None:
-                    model_data["vendor_name"] = vendor_name
-                    if "Plugwise" in vendor_name:
-                        model_data["vendor_name"] = vendor_name.split(" ", 1)[0]
-                model_data["vendor_model"] = module.find("vendor_model").text
-                model_data["hardware_version"] = module.find("hardware_version").text
-                model_data["firmware_version"] = module.find("firmware_version").text
-                # Stretches
-                if (router := module.find("./protocols/network_router")) is not None:
-                    model_data["zigbee_mac_address"] = router.find("mac_address").text
-                # Also look for the Circle+/Stealth M+
-                if (coord := module.find("./protocols/network_coordinator")) is not None:
-                    model_data["zigbee_mac_address"] = coord.find("mac_address").text
-
-        return model_data
-
     def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         """Helper-function for _appliance_info_finder().
 
@@ -176,7 +136,7 @@ def _energy_device_info_finder(self, appliance: etree, appl: Munch) -> Munch:
             locator = "./services/electricity_point_meter"
             mod_type = "electricity_point_meter"
 
-            module_data = self._get_module_data(appliance, locator, mod_type)
+            module_data = self._get_module_data(appliance, self._modules, locator, mod_type, legacy=True)
             appl.zigbee_mac = module_data["zigbee_mac_address"]
             # Filter appliance without zigbee_mac, it's an orphaned device
             if appl.zigbee_mac is None and self.smile_type != "power":
@@ -198,11 +158,11 @@ def _appliance_info_finder(self, appliance: etree, appl: Munch) -> Munch:
         """Collect device info (Smile/Stretch, Thermostats, OpenTherm/On-Off): firmware, model and vendor name."""
         # Collect thermostat device info
         if appl.pwclass in THERMOSTAT_CLASSES:
-            return self._appl_thermostat_info(appliance, appl)
+            return self._appl_thermostat_info(appliance, self._modules, appl)
 
         # Collect heater_central device info
         if appl.pwclass == "heater_central":
-            return self._appl_heater_central_info(self._appliances, appliance, appl)
+            return self._appl_heater_central_info(self._appliances, appliance, self._modules, appl)
 
         # Collect info from Stretches
         appl = self._energy_device_info_finder(appliance, appl)
diff --git a/plugwise/legacy/smile.py b/plugwise/legacy/smile.py
@@ -69,6 +69,7 @@ def __init__(
         )
         SmileLegacyData.__init__(self)
 
+        self._cooling_present = False
         self._is_thermostat = _is_thermostat
         self._on_off_device = _on_off_device
         self._opentherm_device = _opentherm_device

Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@ def __init__(`
`69`	`69`	`)`
`70`	`70`	`SmileLegacyData.__init__(self)`
`71`	`71`
	`72`	`+ self._cooling_present = False`
`72`	`73`	`self._is_thermostat = _is_thermostat`
`73`	`74`	`self._on_off_device = _on_off_device`
`74`	`75`	`self._opentherm_device = _opentherm_device`