Further cleaning

Author: CoMPaTech

plugwise/common.py

@@ -16,18 +16,15 @@
     SWITCH_GROUP_TYPES,
     ApplianceType,
     GwEntityData,
-    ModuleData,
-)
-from plugwise.util import (
-    check_heater_central,
-    check_model,
-    get_vendor_name,
-    return_valid,
+    # ModuleData,
 )
+from plugwise.util import check_heater_central, check_model, return_valid
 
 from defusedxml import ElementTree as etree
 from munch import Munch
 
+from .model import ModuleData
+
 
 def get_zigbee_data(
     module: etree.Element, module_data: ModuleData, legacy: bool
@@ -120,7 +117,7 @@ def _appl_heater_central_info(
         return appl
 
     def _appl_thermostat_info(
-        self, appl: Munch, xml_1: etree.Element, xml_2: etree.Element = None
+        self, appl: Appliance, xml_1: etree.Element, xml_2: etree.Element = None
     ) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         locator = "./logs/point_log[type='thermostat']/thermostat"
@@ -144,21 +141,21 @@ def _appl_thermostat_info(
 
         return appl
 
-    def _create_gw_entities(self, appl: Munch) -> None:
+    def _create_gw_entities(self, appl: Appliance) -> None:
         """Helper-function for creating/updating gw_entities."""
-        self.gw_entities[appl.entity_id] = {"dev_class": appl.pwclass}
+        self.gw_entities[appl.id] = {"dev_class": appl.type}
         self._count += 1
         for key, value in {
             "available": appl.available,
-            "firmware": appl.firmware,
-            "hardware": appl.hardware,
+            "firmware": appl.firmware_version,
+            "hardware": appl.hardware_version,
             "location": appl.location,
-            "mac_address": appl.mac,
+            "mac_address": appl.mac_address,
             "model": appl.model,
             "model_id": appl.model_id,
             "name": appl.name,
             "vendor": appl.vendor_name,
-            "zigbee_mac_address": appl.zigbee_mac,
+            "zigbee_mac_address": appl.zigbee_mac_address,
         }.items():
             if value is not None or key == "location":
                 appl_key = cast(ApplianceType, key)
@@ -247,31 +244,36 @@ def _get_lock_state(
 
     def _get_module_data(
         self,
-        xml_1: etree.Element,
-        locator: str,
         key: str | None = None,
-        xml_2: etree.Element | None = None,
         legacy: bool = False,
     ) -> ModuleData:
         """Helper-function for _energy_device_info_finder() and _appliance_info_finder().
 
         Collect requested info from MODULES.
         """
-        module_data: ModuleData = {
-            "contents": False,
-            "firmware_version": None,
-            "hardware_version": None,
-            "reachable": None,
-            "vendor_name": None,
-            "vendor_model": None,
-            "zigbee_mac_address": None,
-        }
-
-        for appl_search in xml_1.findall(locator):
-            link_tag = appl_search.tag
-            if key is not None and key not in link_tag:
+        module = self.data.get_module(link_id)
+
+        for service_type, services in appliance.services.iter_services():
+            if key and key not in service_type:
+                continue
+        for service in services:
+            module = self.data.get_module(service.id)
+            if not module:
                 continue
 
+            return ModuleData(
+                contents=True,
+                firmware_version=None,
+                hardware_version=None,
+                reachable=None,
+                vendor_name=None,
+                vendor_model=None,
+                zigbee_mac_address=None,
+            )
+        return ModuleData()
+
+        # TODO legacy
+        """
             link_id = appl_search.get("id")
             loc = f".//services/{link_tag}[@id='{link_id}']...."
             # Not possible to walrus for some reason...
@@ -287,5 +289,4 @@ def _get_module_data(
                 get_zigbee_data(module, module_data, legacy)
 
             break
-
-        return module_data
+        """

plugwise/constants.py

@@ -419,6 +419,7 @@
 )
 
 
+# TODO recreate or obsolete
 class ModuleData(TypedDict):
     """The Module data class."""
 

plugwise/helper.py

@@ -105,21 +105,6 @@ def _get_appliances(self) -> None:
         self._get_locations()
 
         for appliance in self.data.appliance:
-            appl = Munch()
-            appl.available = None
-            appl.entity_id = appliance.id
-            appl.firmware = None
-            appl.hardware = None
-            appl.location = None
-            appl.mac = None
-            appl.model = None
-            appl.model_id = None
-            appl.module_id = None
-            appl.name = appliance.name
-            appl.pwclass = appliance.type
-            appl.zigbee_mac = None
-            appl.vendor_name = None
-
             # Don't collect data for the OpenThermGateway appliance, skip thermostat(s)
             # without actuator_functionalities, should be an orphaned device(s) (Core #81712)
             if appliance.type == ApplianceType.OPENTHERMGW or (
@@ -129,7 +114,7 @@ def _get_appliances(self) -> None:
                 continue
 
             if appliance.location is not None:
-                appl.fixed_location = appliance.id
+                appliance.fixed_location = appliance.id
             # Set location to the _home_loc_id when the appliance-location is not found,
             # except for thermostat-devices without a location, they are not active
             elif appliance.type not in THERMOSTAT_CLASSES:
@@ -151,8 +136,6 @@ def _get_appliances(self) -> None:
             # if not (appl := self._appliance_info_finder(appl, appliance)):
             #     continue
 
-            self._create_gw_entities(appl)
-
         # A smartmeter is not present as an appliance, add it specifically
         if self.smile.type == "power" or self.smile.anna_p1:
             self._get_p1_smartmeter_info()
@@ -166,7 +149,6 @@ def _get_p1_smartmeter_info(self) -> None:
         Note: For P1, the entity_id for the gateway and smartmeter are switched to maintain
         backward compatibility. For Anna P1, the smartmeter uses the home location_id directly.
         """
-        appl = Munch()
         locator = MODULE_LOCATOR
         tag = "electricity"
         module_data = self._get_module_data(self._home_location, locator, key=tag)

plugwise/model.py

@@ -318,6 +318,7 @@ class DomainObjects(PWBase):
     # Runtime-only cache
     _appliance_index: dict[str, Appliance] = {}
     _location_index: dict[str, Location] = {}
+    _module_index: dict[str, Module] = {}
 
     def model_post_init(self, __context):
         """Build index for referencing by ID.
@@ -326,15 +327,20 @@ def model_post_init(self, __context):
         """
         self._appliance_index = {a.id: a for a in self.appliance}
         self._location_index = {a.id: a for a in self.location}
+        self._module_index = {a.id: a for a in self.module}
 
     def get_appliance(self, id: str) -> Appliance | None:
         """Get Appliance by ID."""
         return self._appliance_index.get(id)
 
     def get_location(self, id: str) -> Location | None:
-        """Get Location  by ID."""
+        """Get Location by ID."""
         return self._location_index.get(id)
 
+    def get_module(self, id: str) -> Module | None:
+        """Get Module by ID."""
+        return self._module_index.get(id)
+
 
 class PlugwiseData(PWBase):
     """Main XML definition."""
@@ -395,3 +401,15 @@ class GatewayData(BaseModel):
     def model_post_init(self, __context):
         """Init arbitrary types."""
         self.version = Version(self.version)
+
+
+class ModuleData(BaseModel):
+    """Module model."""
+
+    contents: bool = False
+    firmware_version: str | None = None
+    hardware_version: str | None = None
+    reachable: bool | None = None
+    vendor_name: str | None = None
+    vendor_model: str | None = None
+    zigbee_mac_address: str | None = None