Further progress

Author: CoMPaTech

plugwise/common.py

@@ -197,7 +197,7 @@ def _get_groups(self) -> None:
         if self.smile.type == "power" or self.check_name(ANNA):
             return
 
-        for group in self._domain_objects.findall("./group"):
+        for group in self._domain_objects.group:
             group_id = group.get("id")
             if group_id is None:
                 continue  # pragma: no cover
@@ -208,10 +208,10 @@ def _get_groups(self) -> None:
             group_name = group.find("name").text
             group_type = group.find("type").text
             if group_type in GROUP_TYPES:
-                self.gw_entities[group_id] = {
-                    "dev_class": group_type,
+                self.gw_entities[group.id] = {
+                    "dev_class": group.type,
                     "model": "Group",
-                    "name": group_name,
+                    "name": group.name,
                     "members": members,
                     "vendor": "Plugwise",
                 }

plugwise/helper.py

@@ -43,6 +43,7 @@
     ThermoLoc,
     ToggleNameType,
 )
+from plugwise.model import Appliance, ApplianceType, OffsetFunctionality
 from plugwise.util import (
     check_model,
     collect_power_values,
@@ -57,15 +58,6 @@
 from packaging import version
 
 
-def extend_plug_device_class(appl: Munch, appliance: etree.Element) -> None:
-    """Extend device_class name of Plugs (Plugwise and Aqara) - Pw-Beta Issue #739."""
-
-    if (description := appliance.description) is not None and (
-        "ZigBee protocol" in description or "smart plug" in description
-    ):
-        appl.pwclass = f"{appl.pwclass}_plug"
-
-
 def search_actuator_functionalities(
     appliance: etree.Element, actuator: str
 ) -> etree.Element | None:
@@ -130,28 +122,34 @@ def _get_appliances(self) -> None:
 
             # Don't collect data for the OpenThermGateway appliance, skip thermostat(s)
             # without actuator_functionalities, should be an orphaned device(s) (Core #81712)
-            if appl.pwclass == "open_therm_gateway" or (
-                appl.pwclass == "thermostat"
-                and appliance.find("actuator_functionalities/") is None
+            if appliance.type == ApplianceType.OPENTHERMGW or (
+                appliance.type == ApplianceType.THERMOSTAT
+                and appliance.actuator_functionalities is None
             ):
                 continue
 
-            if (appl_loc := appliance.location) is not None:
-                appl.location = appl_loc.get("id")
+            if appliance.location is not None:
+                appl.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 appl.pwclass not in THERMOSTAT_CLASSES:
-                appl.location = self._home_loc_id
+            elif appliance.type not in THERMOSTAT_CLASSES:
+                appliance.fixed_location = self._home_loc_id
 
-            # Don't show orphaned (no location) thermostat-types
-            if appl.pwclass in THERMOSTAT_CLASSES and appl.location is None:
+            # Don't show orphaned thermostat-types
+            if appliance.type in THERMOSTAT_CLASSES and appliance.location is None:
                 continue
 
-            extend_plug_device_class(appl, appliance)
+            # Extend device_class name of Plugs (Plugwise and Aqara) - Pw-Beta Issue #739
+            if appliance.description is not None and (
+                "ZigBee protocol" in appliance.description
+                or "smart plug" in appliance.description
+            ):
+                appliance.type = f"{appliance.type}_plug"
 
-            # Collect appliance info, skip orphaned/removed devices
-            if not (appl := self._appliance_info_finder(appl, appliance)):
-                continue
+            # TODO: recreate functionality
+            # # Collect appliance info, skip orphaned/removed devices
+            # if not (appl := self._appliance_info_finder(appl, appliance)):
+            #     continue
 
             self._create_gw_entities(appl)
 
@@ -225,12 +223,13 @@ def _get_locations(self) -> None:
                 "Error, location Home (building) not found!"
             )  # pragma: no cover
 
-    def _appliance_info_finder(self, appl: Munch, appliance: etree.Element) -> Munch:
+    def _appliance_info_finder(self, appliance: Appliance) -> Appliance:
         """Collect info for all appliances found."""
-        match appl.pwclass:
-            case "gateway":
-                # Collect gateway entity info
-                return self._appl_gateway_info(appl, appliance)
+        match application.type:
+            # No longer needed since we have a Gateway
+            # case "gateway":
+            #     # Collect gateway entity info
+            #     return self._appl_gateway_info(appl, appliance)
             case _ as dev_class if dev_class in THERMOSTAT_CLASSES:
                 # Collect thermostat entity info
                 return self._appl_thermostat_info(appl, appliance)
@@ -264,24 +263,14 @@ def _appliance_info_finder(self, appl: Munch, appliance: etree.Element) -> Munch
             case _:  # pragma: no cover
                 return Munch()
 
-    def _appl_gateway_info(self, appl: Munch, appliance: etree.Element) -> Munch:
+    def _appl_gateway_info(self, appliance: Appliance) -> Appliance:
         """Helper-function for _appliance_info_finder()."""
-        self._gateway_id = appl.entity_id
-        locator = "./gateway/firmware_version"
-        appl.firmware = self._domain_objects.find(locator).text
-        appl.hardware = self.smile.hw_version
-        appl.mac = self.smile.mac_address
-        appl.model = self.smile.model
-        appl.model_id = self.smile.model_id
-        appl.name = self.smile.name
-        appl.vendor_name = "Plugwise"
+        self._gateway_id = application.id
 
         # Adam: collect the ZigBee MAC address of the Smile
-        if self.check_name(ADAM):
-            if (
-                found := self._domain_objects.find(".//protocols/zig_bee_coordinator")
-            ) is not None:
-                appl.zigbee_mac = found.find("mac_address").text
+        if ADAM in appliance.name:
+            if (found := appliance.protocols.zig_bee_coordinator) is not None:
+                application.zigbee_mac = found.mac_address
 
             # Also, collect regulation_modes and check for cooling, indicating cooling-mode is present
             self._reg_allowed_modes = self._get_appl_actuator_modes(

plugwise/model.py

@@ -1,5 +1,6 @@
 """Plugwise models."""
 
+from enum import Enum
 from typing import Any
 
 from pydantic import BaseModel, ConfigDict, Field
@@ -167,12 +168,31 @@ class ZigBeeNode(WithID):
 
 
 # Appliance
+class ApplianceType(str, Enum):
+    """Define application types."""
+
+    GATEWAY = "gateway"
+    OPENTHERMGW = "open_therm_gateway"
+    THERMOSTAT = "thermostat"
+    CHP = "central_heating_pump"
+    CD = "computer_desktop"
+    HC = "heater_central"
+    HT = "hometheater"
+    THERMO_RV = "thermostatic_radiator_valve"
+    VA = "valve_actuator"
+    WHV = "water_heater_vessel"
+    ZONETHERMOMETER = "zone_thermometer"
+    ZONETHERMOSTAT = "zone_thermostat"
+
+    # TODO we still need all the '{}_plug' things here eventually
+
+
 class Appliance(WithID):
     """Plugwise Appliance."""
 
     name: str
     description: str | None = None
-    type: str
+    type: ApplianceType
     created_date: str
     modified_date: str | list[str] | None = None
     deleted_date: str | None = None
@@ -184,6 +204,9 @@ class Appliance(WithID):
         dict[str, BaseFunctionality | list[BaseFunctionality]] | None
     ) = None
 
+    # Internal processing
+    fixed_location: str | None = None
+
 
 # Module
 class Module(WithID):
@@ -204,6 +227,54 @@ class Module(WithID):
     protocols: dict[str, Any] | None = None  # ZigBeeNode, WLAN, LAN
 
 
+# Gateway
+class Gateway(Module):
+    """Plugwise Gateway."""
+
+    last_reset_date: str | list[str] | None = None
+    last_boot_date: str | list[str] | None = None
+
+    project: dict[str, Any] | None = None
+    gateway_environment: dict[str, Any] | None = None
+    features: dict[str, Any] | None = None
+
+
+# Group
+class ApplianceRef(WithID):
+    """Group appliance reference."""
+
+    pass
+
+
+class AppliancesContainer(PWBase):
+    """Group container containing appliance IDs."""
+
+    appliance: list[ApplianceRef] | ApplianceRef
+
+
+class GroupType(str, Enum):
+    """Define group types."""
+
+    PUMPING = "pumping"
+    SWITCHING = "switching"
+
+
+class Group(WithID):
+    """Group of appliances."""
+
+    name: str
+    description: str | None = None
+    type: GroupType | None = None
+
+    created_date: str
+    modified_date: str | list[str] | None = None
+    deleted_date: str | None = None
+
+    logs: dict[str, BaseLog | list[BaseLog]] | list[BaseLog] | None
+    appliances: AppliancesContainer | None = None
+    actuator_functionalities: dict[str, BaseFunctionality] | None = None
+
+
 # Location
 class Location(WithID):
     """Plugwise Location."""
@@ -226,6 +297,8 @@ class DomainObjects(PWBase):
     """Plugwise Domain Objects."""
 
     appliance: list[Appliance] = []
+    gateway: Gateway | list[Gateway] | None = None
+    group: Group | list[Group] | None = None
     module: list[Module] = []
     location: list[Location] = []
     notification: Notification | list[Notification] | None = None
@@ -237,3 +310,37 @@ class Root(PWBase):
     """Main XML definition."""
 
     domain_objects: DomainObjects
+
+
+# Mappings
+
+
+class SwitchDeviceType(str, Enum):
+    """Define switch device types."""
+
+    TOGGLE = "toggle"
+    LOCK = "lock"
+
+
+class SwitchFunctionType(str, Enum):
+    """Define switch function types."""
+
+    TOGGLE = "toggle_functionality"
+    LOCK = "lock"
+    NONE = None
+
+
+class SwitchActuatorType(str, Enum):
+    """Define switch actuator types."""
+
+    DHWCM = "domestic_hot_water_comfort_mode"
+    CE = "cooling_enabled"
+
+
+class Switch(BaseModel):
+    """Switch/relay definition."""
+
+    device: SwitchDeviceType = SwitchDeviceType.TOGGLE
+    func_type: SwitchFunctionType = SwitchFunctionType.TOGGLE
+    act_type: SwitchActuatorType = SwitchActuatorType.CE
+    func: SwitchFunctionType = SwitchFunctionType.NONE

plugwise/smile.py

@@ -38,10 +38,10 @@
 from munch import Munch
 import xmltodict
 
-from .model import Appliance, Root
+from .model import Appliance, Root, Switch
 
 
-def model_to_switch_items(model: str, state: str, switch: Munch) -> tuple[str, Munch]:
+def model_to_switch_items(model: str, state: str, switch: Switch) -> tuple[str, Switch]:
     """Translate state and switch attributes based on model name.
 
     Helper function for set_switch_state().