Store module_id for future use

Author: bouwew

plugwise/common.py

@@ -116,6 +116,7 @@ def _appl_heater_central_info(
         appl.model = (
             "Generic heater/cooler" if self._cooling_present else "Generic heater"
         )
+        appl.module_id = module_data["module_id"]
 
         return appl
 
@@ -140,6 +141,7 @@ def _appl_thermostat_info(
         appl.available = module_data["reachable"]
         appl.hardware = module_data["hardware_version"]
         appl.firmware = module_data["firmware_version"]
+        appl.module_id = module_data["module_id"]
         appl.zigbee_mac = module_data["zigbee_mac_address"]
 
         return appl
@@ -156,6 +158,7 @@ def _create_gw_entities(self, appl: Munch) -> None:
             "mac_address": appl.mac,
             "model": appl.model,
             "model_id": appl.model_id,
+            "module_id": appl.module_id,
             "name": appl.name,
             "vendor": appl.vendor_name,
             "zigbee_mac_address": appl.zigbee_mac,
@@ -255,6 +258,7 @@ def _get_module_data(
             "contents": False,
             "firmware_version": None,
             "hardware_version": None,
+            "module_id": None,
             "reachable": None,
             "vendor_name": None,
             "vendor_model": None,
@@ -278,6 +282,7 @@ def _get_module_data(
                 module_data["vendor_model"] = module.find("vendor_model").text
                 module_data["hardware_version"] = module.find("hardware_version").text
                 module_data["firmware_version"] = module.find("firmware_version").text
+                module_data["module_id"] = module.attrib["id"]
                 get_zigbee_data(module, module_data, legacy)
 
             break

plugwise/constants.py

@@ -286,6 +286,7 @@
     "members",
     "model",
     "model_id",
+    "module_id",
     "name",
     "vendor",
     "zigbee_mac_address",
@@ -417,6 +418,7 @@ class ModuleData(TypedDict):
     contents: bool
     firmware_version: str | None
     hardware_version: str | None
+    module_id: str | None
     reachable: bool | None
     vendor_model: str | None
     vendor_name: str | None
@@ -539,6 +541,7 @@ class GwEntityData(TypedDict, total=False):
     members: list[str]
     model: str
     model_id: str | None
+    module_id: str | None
     name: str
     vendor: str
     zigbee_mac_address: str

plugwise/helper.py

@@ -112,6 +112,7 @@ def _all_appliances(self) -> bool:
             appl.name = appliance.find("name").text
             appl.model = None
             appl.model_id = None
+            appl.module_id = None
             appl.firmware = None
             appl.hardware = None
             appl.mac = None
@@ -200,6 +201,7 @@ def _add_p1_smartmeter_info(self) -> None:
         appl.mac = None
         appl.model = module_data["vendor_model"]
         appl.model_id = None  # don't use model_id for SmartMeter
+        appl.module_id = module_data["module_id"]
         appl.name = "P1"
         appl.pwclass = "smartmeter"
         appl.vendor_name = module_data["vendor_name"]
@@ -260,6 +262,7 @@ def _appliance_info_finder(self, appl: Munch, appliance: etree.Element) -> Munch
                 appl.firmware = module_data["firmware_version"]
                 appl.hardware = module_data["hardware_version"]
                 appl.model_id = module_data["vendor_model"]
+                appl.module_id = module_data["module_id"]
                 appl.vendor_name = module_data["vendor_name"]
                 appl.model = check_model(appl.model_id, appl.vendor_name)
                 appl.zigbee_mac = module_data["zigbee_mac_address"]