Define smile-Munch

Author: bouwew

plugwise/__init__.py

@@ -36,6 +36,7 @@
 
 import aiohttp
 from defusedxml import ElementTree as etree
+from munch import Munch
 from packaging.version import Version, parse
 
 
@@ -72,16 +73,17 @@ def __init__(
         self._smile_api: SmileAPI | SmileLegacyAPI
         self._stretch_v2 = False
         self._target_smile: str = NONE
-        self.smile_hostname: str = NONE
-        self.smile_hw_version: str | None = None
-        self.smile_legacy = False
-        self.smile_mac_address: str | None = None
-        self.smile_model: str = NONE
-        self.smile_model_id: str | None = None
-        self.smile_name: str = NONE
-        self.smile_type: str = NONE
-        self.smile_version: Version = Version("0.0.0")
-        self.smile_zigbee_mac_address: str | None = None
+        self.smile: Munch = Munch()
+        self.smile.hostname: str = NONE
+        self.smile.hw_version: str | None = None
+        self.smile.legacy = False
+        self.smile.mac_address: str | None = None
+        self.smile.model: str = NONE
+        self.smile.model_id: str | None = None
+        self.smile.name: str = NONE
+        self.smile.type: str = NONE
+        self.smile.version: Version = Version("0.0.0")
+        self.smile.zigbee_mac_address: str | None = None
 
     @property
     def cooling_present(self) -> bool:
@@ -109,7 +111,7 @@ def reboot(self) -> bool:
 
         All non-legacy devices support gateway-rebooting.
         """
-        return not self.smile_legacy
+        return not self.smile.legacy
 
     async def connect(self) -> Version:
         """Connect to the Plugwise Gateway and determine its name, type, version, and other data."""
@@ -158,16 +160,9 @@ async def connect(self) -> Version:
                 self._opentherm_device,
                 self._request,
                 self._schedule_old_states,
-                self.smile_hostname,
-                self.smile_hw_version,
-                self.smile_mac_address,
-                self.smile_model,
-                self.smile_model_id,
-                self.smile_name,
-                self.smile_type,
-                self.smile_version,
+                self.smile,
             )
-            if not self.smile_legacy
+            if not self.smile.legacy
             else SmileLegacyAPI(
                 self._is_thermostat,
                 self._loc_data,
@@ -176,21 +171,14 @@ async def connect(self) -> Version:
                 self._request,
                 self._stretch_v2,
                 self._target_smile,
-                self.smile_hostname,
-                self.smile_hw_version,
-                self.smile_mac_address,
-                self.smile_model,
-                self.smile_name,
-                self.smile_type,
-                self.smile_version,
-                self.smile_zigbee_mac_address,
+                self.smile,
             )
         )
 
         # Update all endpoints on first connect
         await self._smile_api.full_xml_update()
 
-        return self.smile_version
+        return self.smile.version
 
     async def _smile_detect(
         self, result: etree.Element, dsmrmain: etree.Element
@@ -203,23 +191,23 @@ async def _smile_detect(
         if (gateway := result.find("./gateway")) is not None:
             if (v_model := gateway.find("vendor_model")) is not None:
                 model = v_model.text
-            self.smile_version = parse(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
-            self.smile_model_id = gateway.find("vendor_model").text
+            self.smile.version = parse(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
+            self.smile._model_id = gateway.find("vendor_model").text
         else:
             model = await self._smile_detect_legacy(result, dsmrmain, model)
 
-        if model == "Unknown" or self.smile_version is None:  # pragma: no cover
+        if model == "Unknown" or self.smile.version is None:  # pragma: no cover
             # Corner case check
             LOGGER.error(
                 "Unable to find model or version information, please create"
                 " an issue on http://github.com/plugwise/python-plugwise"
             )
             raise UnsupportedDeviceError
 
-        version_major = str(self.smile_version.major)
+        version_major = str(self.smile.version.major)
         self._target_smile = f"{model}_v{version_major}"
         LOGGER.debug("Plugwise identified as %s", self._target_smile)
         if self._target_smile not in SMILES:
@@ -230,7 +218,7 @@ async def _smile_detect(
             )
             raise UnsupportedDeviceError
 
-        if not self.smile_legacy:
+        if not self.smile.legacy:
             self._timeout = DEFAULT_TIMEOUT
 
         if self._target_smile in ("smile_open_therm_v2", "smile_thermo_v3"):
@@ -240,14 +228,14 @@ async def _smile_detect(
             )  # pragma: no cover
             raise UnsupportedDeviceError  # pragma: no cover
 
-        self.smile_model = "Gateway"
-        self.smile_name = SMILES[self._target_smile].smile_name
-        self.smile_type = SMILES[self._target_smile].smile_type
+        self.smile.model = "Gateway"
+        self.smile.name = SMILES[self._target_smile].smile_name
+        self.smile.type = SMILES[self._target_smile].smile_type
 
-        if self.smile_type == "stretch":
+        if self.smile.type == "stretch":
             self._stretch_v2 = int(version_major) == 2
 
-        if self.smile_type == "thermostat":
+        if self.smile.type == "thermostat":
             self._is_thermostat = True
             # For Adam, Anna, determine the system capabilities:
             # Find the connected heating/cooling device (heater_central),
@@ -275,36 +263,36 @@ async def _smile_detect_legacy(
         return_model = model
         # Stretch: find the MAC of the zigbee master_controller (= Stick)
         if (network := result.find("./module/protocols/master_controller")) is not None:
-            self.smile_zigbee_mac_address = network.find("mac_address").text
+            self.smile.zigbee_mac_address = network.find("mac_address").text
         # Find the active MAC in case there is an orphaned Stick
         if zb_networks := result.findall("./network"):
             for zb_network in zb_networks:
                 if zb_network.find("./nodes/network_router") is not None:
                     network = zb_network.find("./master_controller")
-                    self.smile_zigbee_mac_address = network.find("mac_address").text
+                    self.smile.zigbee_mac_address = network.find("mac_address").text
 
         # Legacy Anna or Stretch:
         if (
             result.find('./appliance[type="thermostat"]') is not None
             or network is not None
         ):
             system = await self._request(SYSTEM)
-            self.smile_version = parse(system.find("./gateway/firmware").text)
+            self.smile.version = parse(system.find("./gateway/firmware").text)
             return_model = str(system.find("./gateway/product").text)
-            self.smile_hostname = system.find("./gateway/hostname").text
+            self.smile.hostname = system.find("./gateway/hostname").text
             # If wlan0 contains data it's active, eth0 should be checked last as is preferred
             for network in ("wlan0", "eth0"):
                 locator = f"./{network}/mac"
                 if (net_locator := system.find(locator)) is not None:
-                    self.smile_mac_address = net_locator.text
+                    self.smile.mac_address = net_locator.text
 
         # P1 legacy:
         elif dsmrmain is not None:
             status = await self._request(STATUS)
-            self.smile_version = parse(status.find("./system/version").text)
+            self.smile.version = parse(status.find("./system/version").text)
             return_model = str(status.find("./system/product").text)
-            self.smile_hostname = status.find("./network/hostname").text
-            self.smile_mac_address = status.find("./network/mac_address").text
+            self.smile.hostname = status.find("./network/hostname").text
+            self.smile.mac_address = status.find("./network/mac_address").text
         else:  # pragma: no cover
             # No cornercase, just end of the line
             LOGGER.error(
@@ -313,7 +301,7 @@ async def _smile_detect_legacy(
             )
             raise ResponseError
 
-        self.smile_legacy = True
+        self.smile.legacy = True
         return return_model
 
     async def async_update(self) -> dict[str, GwEntityData]:

plugwise/common.py

@@ -55,17 +55,16 @@ def __init__(self) -> None:
         self._heater_id: str = NONE
         self._on_off_device: bool
         self.gw_entities: dict[str, GwEntityData] = {}
-        self.smile_name: str
-        self.smile_type: str
+        self.smile: Munch
 
     @property
     def heater_id(self) -> str:
         """Return the heater-id."""
         return self._heater_id
 
-    def smile(self, name: str) -> bool:
+    def check_name(self, name: str) -> bool:
         """Helper-function checking the smile-name."""
-        return self.smile_name == name
+        return self.smile.name == name
 
     def _appl_heater_central_info(
         self,
@@ -173,7 +172,7 @@ def _get_group_switches(self) -> dict[str, GwEntityData]:
         """
         switch_groups: dict[str, GwEntityData] = {}
         # P1 and Anna don't have switchgroups
-        if self.smile_type == "power" or self.smile(ANNA):
+        if self.smile.type == "power" or self.check_name(ANNA):
             return switch_groups
 
         for group in self._domain_objects.findall("./group"):

plugwise/helper.py

@@ -277,7 +277,7 @@ def _appl_gateway_info(self, appl: Munch, appliance: etree.Element) -> Munch:
         appl.vendor_name = "Plugwise"
 
         # Adam: collect the ZigBee MAC address of the Smile
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             if (
                 found := self._domain_objects.find(".//protocols/zig_bee_coordinator")
             ) is not None:
@@ -383,7 +383,7 @@ def _get_measurement_data(self, entity_id: str) -> GwEntityData:
             data.pop("c_heating_state")
             self._count -= 1
 
-        if self._is_thermostat and self.smile(ANNA):
+        if self._is_thermostat and self.check_name(ANNA):
             self._update_anna_cooling(entity_id, data)
 
         self._cleanup_data(data)
@@ -484,7 +484,7 @@ def _get_actuator_functionalities(
                 item == "thermostat"
                 and (
                     entity["dev_class"] != "climate"
-                    if self.smile(ADAM)
+                    if self.check_name(ADAM)
                     else entity["dev_class"] != "thermostat"
                 )
             ):
@@ -539,7 +539,7 @@ def _get_actuator_mode(
 
         Collect the requested gateway mode.
         """
-        if not (self.smile(ADAM) and entity_id == self._gateway_id):
+        if not (self.check_name(ADAM) and entity_id == self._gateway_id):
             return None
 
         if (search := search_actuator_functionalities(appliance, key)) is not None:
@@ -605,10 +605,10 @@ def _process_on_off_device_c_heating_state(self, data: GwEntityData) -> None:
 
         Solution for Core issue #81839.
         """
-        if self.smile(ANNA):
+        if self.check_name(ANNA):
             data["binary_sensors"]["heating_state"] = data["c_heating_state"]
 
-        if self.smile(ADAM):
+        if self.check_name(ADAM):
             # First count when not present, then create and init to False.
             # When present init to False
             if "heating_state" not in data["binary_sensors"]:

plugwise/legacy/helper.py

@@ -73,10 +73,10 @@ def __init__(self) -> None:
         self._modules: etree.Element
         self._stretch_v2: bool
         self.gw_entities: dict[str, GwEntityData] = {}
-        self.smile_mac_address: str | None
-        self.smile_model: str
-        self.smile_version: Version
-        self.smile_zigbee_mac_address: str | None
+        self.smile.mac_address: str | None
+        self.smile.model: str
+        self.smile.version: Version
+        self.smile.zigbee_mac_address: str | None
 
     @property
     def gateway_id(self) -> str:
@@ -95,7 +95,7 @@ def _all_appliances(self) -> None:
 
         self._create_legacy_gateway()
         # For legacy P1 collect the connected SmartMeter info
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             appl = Munch()
             self._p1_smartmeter_info_finder(appl)
             # Legacy P1 has no more devices
@@ -167,13 +167,13 @@ def _all_locations(self) -> None:
             loc.loc_id = location.attrib["id"]
             # Filter the valid single location for P1 legacy: services not empty
             locator = "./services"
-            if self.smile_type == "power" and len(location.find(locator)) == 0:
+            if self.smile.type == "power" and len(location.find(locator)) == 0:
                 continue
 
             if loc.name == "Home":
                 self._home_loc_id = loc.loc_id
             # Replace location-name for P1 legacy, can contain privacy-related info
-            if self.smile_type == "power":
+            if self.smile.type == "power":
                 loc.name = "Home"
                 self._home_loc_id = loc.loc_id
 
@@ -185,18 +185,18 @@ def _create_legacy_gateway(self) -> None:
         Use the home_location or FAKE_APPL as entity id.
         """
         self._gateway_id = self._home_loc_id
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             self._gateway_id = FAKE_APPL
 
         self.gw_entities[self._gateway_id] = {"dev_class": "gateway"}
         self._count += 1
         for key, value in {
-            "firmware": str(self.smile_version),
+            "firmware": str(self.smile.version),
             "location": self._home_loc_id,
-            "mac_address": self.smile_mac_address,
-            "model": self.smile_model,
-            "name": self.smile_name,
-            "zigbee_mac_address": self.smile_zigbee_mac_address,
+            "mac_address": self.smile.mac_address,
+            "model": self.smile.model,
+            "name": self.smile.name,
+            "zigbee_mac_address": self.smile.zigbee_mac_address,
             "vendor": "Plugwise",
         }.items():
             if value is not None:
@@ -224,14 +224,14 @@ def _energy_entity_info_finder(self, appliance: etree, appl: Munch) -> Munch:
 
         Collect energy entity info (Smartmeter, Circle, Stealth, etc.): firmware, model and vendor name.
         """
-        if self.smile_type in ("power", "stretch"):
+        if self.smile.type in ("power", "stretch"):
             locator = "./services/electricity_point_meter"
             module_data = self._get_module_data(
                 appliance, locator, self._modules, 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":
+            if appl.zigbee_mac is None and self.smile.type != "power":
                 return None
 
             appl.hardware = module_data["hardware_version"]
@@ -253,7 +253,7 @@ def _p1_smartmeter_info_finder(self, appl: Munch) -> None:
         appl.entity_id = loc_id
         appl.location = loc_id
         appl.mac = None
-        appl.model = self.smile_model
+        appl.model = self.smile.model
         appl.model_id = None
         appl.name = "P1"
         appl.pwclass = "smartmeter"
@@ -272,7 +272,7 @@ def _get_measurement_data(self, entity_id: str) -> GwEntityData:
         # Get P1 smartmeter data from MODULES
         entity = self.gw_entities[entity_id]
         # !! DON'T CHANGE below two if-lines, will break stuff !!
-        if self.smile_type == "power":
+        if self.smile.type == "power":
             if entity["dev_class"] == "smartmeter":
                 data.update(self._power_data_from_modules())