Introduce Smile properties

Author: bouwew

plugwise/__init__.py

@@ -17,6 +17,7 @@
     SMILES,
     STATUS,
     SYSTEM,
+    GatewayData,
     PlugwiseData,
     ThermoLoc,
 )
@@ -73,7 +74,7 @@ def __init__(
         self._smile_api: SmileAPI | SmileLegacyAPI
         self._stretch_v2 = False
         self._target_smile: str = NONE
-        self.gateway_id: str = NONE
+        self.gw_data: GatewayData = {}
         self.smile_fw_version: Version | None = None
         self.smile_hostname: str = NONE
         self.smile_hw_version: str | None = None
@@ -86,6 +87,16 @@ def __init__(
         self.smile_version: Version | None = None
         self.smile_zigbee_mac_address: str | None = None
 
+    @property
+    def gateway_id(self) -> str:
+        """Return the Smile gateway-id."""
+        return self.gw_data["gateway_id"]
+
+    @property
+    def heater_id(self) -> str:
+        """Return the Smile heater-id."""
+        return self.gw_data["heater_id"]
+
     async def connect(self) -> Version | None:
         """Connect to the Plugwise Gateway and determine its name, type, version, and other data."""
         result = await self._request(DOMAIN_OBJECTS)
@@ -133,7 +144,7 @@ async def connect(self) -> Version | None:
                 self._on_off_device,
                 self._opentherm_device,
                 self._schedule_old_states,
-                self.gateway_id,
+                self.gw_data,
                 self.smile_fw_version,
                 self.smile_hostname,
                 self.smile_hw_version,
@@ -153,6 +164,7 @@ async def connect(self) -> Version | None:
                 self._opentherm_device,
                 self._stretch_v2,
                 self._target_smile,
+                self.gw_data,
                 self.smile_fw_version,
                 self.smile_hostname,
                 self.smile_hw_version,
@@ -306,7 +318,6 @@ async def async_update(self) -> PlugwiseData:
         data = PlugwiseData(devices={}, gateway={})
         try:
             data = await self._smile_api.async_update()
-            self.gateway_id = data.gateway["gateway_id"]
         except (DataMissingError, KeyError) as err:
             raise PlugwiseError("No Plugwise data received") from err
 

plugwise/data.py

@@ -15,6 +15,7 @@
     NONE,
     OFF,
     ActuatorData,
+    GatewayData,
     GwEntityData,
 )
 from plugwise.helper import SmileHelper
@@ -26,6 +27,7 @@ class SmileData(SmileHelper):
 
     def __init__(self) -> None:
         """Init."""
+        self.gw_data: GatewayData
         SmileHelper.__init__(self)
 
     def _all_entity_data(self) -> None:
@@ -38,19 +40,14 @@ def _all_entity_data(self) -> None:
             self._update_zones()
             self.gw_entities.update(self._zones)
 
-        self.gw_data.update(
-            {
-                "gateway_id": self.gateway_id,
-                "item_count": self._count,
-                "notifications": self._notifications,
-                "reboot": True,
-                "smile_name": self.smile_name,
-            }
-        )
+        self.gw_data["gateway_id"] = self._gateway_id
+        self.gw_data["item_count"] = self._count
+        self.gw_data["notifications"] = self._notifications
+        self.gw_data["reboot"] = True
+        self.gw_data["smile_name"] = self.smile_name
         if self._is_thermostat:
-            self.gw_data.update(
-                {"heater_id": self._heater_id, "cooling_present": self._cooling_present}
-            )
+            self.gw_data["heater_id"] = self._heater_id
+            self.gw_data["cooling_present"] = self._cooling_present
 
     def _update_zones(self) -> None:
         """Helper-function for _all_entity_data() and async_update().
@@ -69,7 +66,7 @@ def _update_gw_entities(self) -> None:
         mac_list: list[str] = []
         for entity_id, entity in self.gw_entities.items():
             data = self._get_entity_data(entity_id)
-            if entity_id == self.gateway_id:
+            if entity_id == self._gateway_id:
                 mac_list = self._detect_low_batteries()
                 self._add_or_update_notifications(entity_id, entity, data)
 
@@ -123,7 +120,7 @@ def _add_or_update_notifications(
     ) -> None:
         """Helper-function adding or updating the Plugwise notifications."""
         if (
-            entity_id == self.gateway_id
+            entity_id == self._gateway_id
             and (self._is_thermostat or self.smile_type == "power")
         ) or (
             "binary_sensors" in entity
@@ -305,7 +302,7 @@ def _climate_data(
 
     def check_reg_mode(self, mode: str) -> bool:
         """Helper-function for device_data_climate()."""
-        gateway = self.gw_entities[self.gateway_id]
+        gateway = self.gw_entities[self._gateway_id]
         return (
             "regulation_modes" in gateway and gateway["select_regulation_mode"] == mode
         )

plugwise/helper.py

@@ -37,7 +37,6 @@
     ActuatorData,
     ActuatorDataType,
     ActuatorType,
-    GatewayData,
     GwEntityData,
     SensorType,
     ThermoLoc,
@@ -78,8 +77,8 @@ def __init__(self) -> None:
         self._domain_objects: etree
         self._endpoint: str
         self._elga: bool
+        self._gateway_id: str
         self._gw_allowed_modes: list[str] = []
-        self._heater_id: str
         self._home_loc_id: str
         self._home_location: etree
         self._is_thermostat: bool
@@ -110,8 +109,6 @@ def __init__(self) -> None:
         self._cooling_active = False
         self._cooling_enabled = False
 
-        self.gateway_id: str
-        self.gw_data: GatewayData = {}
         self.gw_entities: dict[str, GwEntityData] = {}
         self.smile_fw_version: version.Version | None
         self.smile_hw_version: str | None
@@ -203,7 +200,7 @@ def _get_p1_smartmeter_info(self) -> None:
             LOGGER.error("No module data found for SmartMeter")  # pragma: no cover
             return  # pragma: no cover
         appl.available = None
-        appl.entity_id = self.gateway_id
+        appl.entity_id = self._gateway_id
         appl.firmware = module_data["firmware_version"]
         appl.hardware = module_data["hardware_version"]
         appl.location = self._home_loc_id
@@ -216,8 +213,8 @@ def _get_p1_smartmeter_info(self) -> None:
         appl.zigbee_mac = None
 
         # Replace the entity_id of the gateway by the smartmeter location_id
-        self.gw_entities[self._home_loc_id] = self.gw_entities.pop(self.gateway_id)
-        self.gateway_id = self._home_loc_id
+        self.gw_entities[self._home_loc_id] = self.gw_entities.pop(self._gateway_id)
+        self._gateway_id = self._home_loc_id
 
         self._create_gw_entities(appl)
 
@@ -290,7 +287,7 @@ def _appliance_info_finder(self, appl: Munch, appliance: etree) -> Munch:
 
     def _appl_gateway_info(self, appl: Munch, appliance: etree) -> Munch:
         """Helper-function for _appliance_info_finder()."""
-        self.gateway_id = appliance.attrib["id"]
+        self._gateway_id = appliance.attrib["id"]
         appl.firmware = str(self.smile_fw_version)
         appl.hardware = self.smile_hw_version
         appl.mac = self.smile_mac_address
@@ -568,7 +565,7 @@ def _get_actuator_mode(
 
         Collect the requested gateway mode.
         """
-        if not (self.smile(ADAM) and entity_id == self.gateway_id):
+        if not (self.smile(ADAM) and entity_id == self._gateway_id):
             return None
 
         if (search := search_actuator_functionalities(appliance, key)) is not None:
@@ -609,7 +606,7 @@ def _get_gateway_mode(
 
     def _get_gateway_outdoor_temp(self, entity_id: str, data: GwEntityData) -> None:
         """Adam & Anna: the Smile outdoor_temperature is present in the Home location."""
-        if self._is_thermostat and entity_id == self.gateway_id:
+        if self._is_thermostat and entity_id == self._gateway_id:
             locator = "./logs/point_log[type='outdoor_temperature']/period/measurement"
             if (found := self._home_location.find(locator)) is not None:
                 value = format_measure(found.text, NONE)

plugwise/legacy/data.py

@@ -7,7 +7,7 @@
 
 # Dict as class
 # Version detection
-from plugwise.constants import NONE, OFF, GwEntityData
+from plugwise.constants import NONE, OFF, GatewayData, GwEntityData
 from plugwise.legacy.helper import SmileLegacyHelper
 from plugwise.util import remove_empty_platform_dicts
 
@@ -17,6 +17,7 @@ class SmileLegacyData(SmileLegacyHelper):
 
     def __init__(self) -> None:
         """Init."""
+        self.gw_data: GatewayData
         SmileLegacyHelper.__init__(self)
 
     def _all_entity_data(self) -> None:
@@ -25,17 +26,12 @@ def _all_entity_data(self) -> None:
         Collect data for each entity and add to self.gw_data and self.gw_entities.
         """
         self._update_gw_entities()
-        self.gw_data.update(
-            {
-                "gateway_id": self.gateway_id,
-                "item_count": self._count,
-                "smile_name": self.smile_name,
-            }
-        )
+        self.gw_data["gateway_id"] = self.gateway_id
+        self.gw_data["item_count"] = self._count
+        self.gw_data["smile_name"] = self.smile_name
         if self._is_thermostat:
-            self.gw_data.update(
-                {"heater_id": self._heater_id, "cooling_present": False}
-            )
+            self.gw_data["heater_id"] = self._heater_id
+            self.gw_data["cooling_present"] = False
 
     def _update_gw_entities(self) -> None:
         """Helper-function for _all_entity_data() and async_update().

plugwise/legacy/helper.py

@@ -30,7 +30,6 @@
     ActuatorDataType,
     ActuatorType,
     ApplianceType,
-    GatewayData,
     GwEntityData,
     SensorType,
     ThermoLoc,
@@ -81,7 +80,6 @@ def __init__(self) -> None:
         self._system: etree
 
         self.gateway_id: str
-        self.gw_data: GatewayData = {}
         self.gw_entities: dict[str, GwEntityData] = {}
         self.smile_fw_version: Version | None
         self.smile_hw_version: str | None

plugwise/legacy/smile.py

@@ -44,6 +44,7 @@ def __init__(
         _opentherm_device: bool,
         _stretch_v2: bool,
         _target_smile: str,
+        gw_data: GatewayData,
         smile_fw_version: Version | None,
         smile_hostname: str,
         smile_hw_version: str | None,
@@ -61,6 +62,7 @@ def __init__(
         self._opentherm_device = _opentherm_device
         self._stretch_v2 = _stretch_v2
         self._target_smile = _target_smile
+        self.gw_data = gw_data
         self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
@@ -109,7 +111,6 @@ async def async_update(self) -> PlugwiseData:
             LOGGER.info(
                 "Performing daily full-update, reload the Plugwise integration when a single entity becomes unavailable."
             )
-            self.gw_data: GatewayData = {}
             self.gw_entities: dict[str, GwEntityData] = {}
             try:
                 await self.full_xml_update()

plugwise/smile.py

@@ -18,6 +18,7 @@
     LOCATIONS,
     MAX_SETPOINT,
     MIN_SETPOINT,
+    NONE,
     NOTIFICATIONS,
     OFF,
     RULES,
@@ -52,7 +53,7 @@ def __init__(
         _on_off_device: bool,
         _opentherm_device: bool,
         _schedule_old_states: dict[str, dict[str, str]],
-        gateway_id: str,
+        gw_data: GatewayData,
         smile_fw_version: Version | None,
         smile_hostname: str | None,
         smile_hw_version: str | None,
@@ -67,14 +68,15 @@ def __init__(
         self._cooling_enabled = False
         self._cooling_present = _cooling_present
         self._elga = _elga
-        self._heater_id: str
+        self._gateway_id: str = NONE
+        self._heater_id: str = NONE
         self._is_thermostat = _is_thermostat
         self._last_active = _last_active
         self._loc_data = _loc_data
         self._on_off_device = _on_off_device
         self._opentherm_device = _opentherm_device
         self._schedule_old_states = _schedule_old_states
-        self.gateway_id = gateway_id
+        self.gw_data = gw_data
         self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
@@ -119,7 +121,6 @@ async def async_update(self) -> PlugwiseData:
 
         Any change in the connected entities will be detected immediately.
         """
-        self.gw_data: GatewayData = {}
         self.gw_entities: dict[str, GwEntityData] = {}
         self._zones: dict[str, GwEntityData] = {}
         try:
@@ -137,7 +138,7 @@ async def async_update(self) -> PlugwiseData:
                         "cooling_enabled"
                     ]
             else:  # cover failed data-retrieval for P1
-                _ = self.gw_entities[self.gateway_id]["location"]
+                _ = self.gw_entities[self._gateway_id]["location"]
         except KeyError as err:
             raise DataMissingError("No Plugwise actual data received") from err
 
@@ -268,7 +269,7 @@ async def set_gateway_mode(self, mode: str) -> None:
             vacation_time = time_2 + "T23:00:00.000Z"
             valid = f"<valid_from>{vacation_time}</valid_from><valid_to>{end_time}</valid_to>"
 
-        uri = f"{APPLIANCES};id={self.gateway_id}/gateway_mode_control"
+        uri = f"{APPLIANCES};id={self._gateway_id}/gateway_mode_control"
         data = f"<gateway_mode_control_functionality><mode>{mode}</mode>{valid}</gateway_mode_control_functionality>"
 
         await self.call_request(uri, method="put", data=data)