Rename gw_data to _smile_props

bouwew · bouwew · commit 6ee7f780cb67 · 2025-01-18T14:14:12.000+01:00
diff --git a/plugwise/__init__.py b/plugwise/__init__.py
@@ -17,8 +17,8 @@
     SMILES,
     STATUS,
     SYSTEM,
-    GatewayData,
     PlugwiseData,
+    SmileProps,
     ThermoLoc,
 )
 from plugwise.exceptions import (
@@ -70,10 +70,10 @@ def __init__(
         self._opentherm_device = False
         self._schedule_old_states: dict[str, dict[str, str]] = {}
         self._smile_api: SmileAPI | SmileLegacyAPI
+        self._smile_props: SmileProps = {}
         self._stretch_v2 = False
         self._target_smile: str = NONE
         self.cooling_present = False
-        self.gw_data: GatewayData = {}
         self.smile_hostname: str = NONE
         self.smile_hw_version: str | None = None
         self.smile_legacy = False
@@ -88,27 +88,27 @@ def __init__(
     @property
     def gateway_id(self) -> str:
         """Return the gateway-id."""
-        return self.gw_data["gateway_id"]
+        return self._smile_props["gateway_id"]
 
     @property
     def heater_id(self) -> str:
         """Return the heater-id."""
-        return self.gw_data["heater_id"]
+        return self._smile_props["heater_id"]
 
     @property
     def item_count(self) -> int:
         """Return the item-count."""
-        return self.gw_data["item_count"]
+        return self._smile_props["item_count"]
 
     @property
     def notifications(self) -> dict[str, dict[str, str]]:
         """Return the Plugwise notifications."""
-        return self.gw_data["notifications"]
+        return self._smile_props["notifications"]
 
     @property
     def reboot(self) -> bool:
         """Return the reboot capability."""
-        return self.gw_data["reboot"]
+        return self._smile_props["reboot"]
 
     async def connect(self) -> Version | None:
         """Connect to the Plugwise Gateway and determine its name, type, version, and other data."""
@@ -156,8 +156,8 @@ async def connect(self) -> Version | None:
                 self._opentherm_device,
                 self._request,
                 self._schedule_old_states,
+                self._smile_props,
                 self.cooling_present,
-                self.gw_data,
                 self.smile_hostname,
                 self.smile_hw_version,
                 self.smile_mac_address,
@@ -174,9 +174,9 @@ async def connect(self) -> Version | None:
                 self._on_off_device,
                 self._opentherm_device,
                 self._request,
+                self._smile_props,
                 self._stretch_v2,
                 self._target_smile,
-                self.gw_data,
                 self.smile_hostname,
                 self.smile_hw_version,
                 self.smile_mac_address,
diff --git a/plugwise/constants.py b/plugwise/constants.py
@@ -394,8 +394,8 @@
 )
 
 
-class GatewayData(TypedDict, total=False):
-    """The Gateway Data class."""
+class SmileProps(TypedDict, total=False):
+    """The SmileProps Data class."""
 
     cooling_present: bool
     gateway_id: str
@@ -584,4 +584,4 @@ class PlugwiseData:
     """Plugwise data provided as output."""
 
     devices: dict[str, GwEntityData]
-    gateway: GatewayData
+    gateway: SmileProps
diff --git a/plugwise/data.py b/plugwise/data.py
@@ -15,8 +15,8 @@
     NONE,
     OFF,
     ActuatorData,
-    GatewayData,
     GwEntityData,
+    SmileProps,
 )
 from plugwise.helper import SmileHelper
 from plugwise.util import remove_empty_platform_dicts
@@ -27,27 +27,27 @@ class SmileData(SmileHelper):
 
     def __init__(self) -> None:
         """Init."""
-        self.gw_data: GatewayData
+        self._smile_props: SmileProps
         SmileHelper.__init__(self)
 
     def _all_entity_data(self) -> None:
         """Helper-function for get_all_gateway_entities().
 
-        Collect data for each entity and add to self.gw_data and self.gw_entities.
+        Collect data for each entity and add to self._smile_props and self.gw_entities.
         """
         self._update_gw_entities()
         if self.smile(ADAM):
             self._update_zones()
             self.gw_entities.update(self._zones)
 
-        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
+        self._smile_props["gateway_id"] = self._gateway_id
+        self._smile_props["item_count"] = self._count
+        self._smile_props["notifications"] = self._notifications
+        self._smile_props["reboot"] = True
+        self._smile_props["smile_name"] = self.smile_name
         if self._is_thermostat:
-            self.gw_data["heater_id"] = self._heater_id
-            self.gw_data["cooling_present"] = self.cooling_present
+            self._smile_props["heater_id"] = self._heater_id
+            self._smile_props["cooling_present"] = self.cooling_present
 
     def _update_zones(self) -> None:
         """Helper-function for _all_entity_data() and async_update().
diff --git a/plugwise/legacy/data.py b/plugwise/legacy/data.py
@@ -7,7 +7,7 @@
 
 # Dict as class
 # Version detection
-from plugwise.constants import NONE, OFF, GatewayData, GwEntityData
+from plugwise.constants import NONE, OFF, GwEntityData, SmileProps
 from plugwise.legacy.helper import SmileLegacyHelper
 from plugwise.util import remove_empty_platform_dicts
 
@@ -17,21 +17,21 @@ class SmileLegacyData(SmileLegacyHelper):
 
     def __init__(self) -> None:
         """Init."""
-        self.gw_data: GatewayData
+        self._smile_props: SmileProps
         SmileLegacyHelper.__init__(self)
 
     def _all_entity_data(self) -> None:
         """Helper-function for get_all_gateway_entities().
 
-        Collect data for each entity and add to self.gw_data and self.gw_entities.
+        Collect data for each entity and add to self._smile_props and self.gw_entities.
         """
         self._update_gw_entities()
-        self.gw_data["gateway_id"] = self.gateway_id
-        self.gw_data["item_count"] = self._count
-        self.gw_data["smile_name"] = self.smile_name
+        self._smile_props["gateway_id"] = self.gateway_id
+        self._smile_props["item_count"] = self._count
+        self._smile_props["smile_name"] = self.smile_name
         if self._is_thermostat:
-            self.gw_data["heater_id"] = self._heater_id
-            self.gw_data["cooling_present"] = False
+            self._smile_props["heater_id"] = self._heater_id
+            self._smile_props["cooling_present"] = False
 
     def _update_gw_entities(self) -> None:
         """Helper-function for _all_entity_data() and async_update().
diff --git a/plugwise/legacy/smile.py b/plugwise/legacy/smile.py
@@ -18,9 +18,9 @@
     OFF,
     REQUIRE_APPLIANCES,
     RULES,
-    GatewayData,
     GwEntityData,
     PlugwiseData,
+    SmileProps,
     ThermoLoc,
 )
 from plugwise.exceptions import ConnectionFailedError, DataMissingError, PlugwiseError
@@ -42,9 +42,9 @@ def __init__(
         _on_off_device: bool,
         _opentherm_device: bool,
         _request: Callable[..., Awaitable[Any]],
+        _smile_props: SmileProps,
         _stretch_v2: bool,
         _target_smile: str,
-        gw_data: GatewayData,
         smile_hostname: str,
         smile_hw_version: str | None,
         smile_mac_address: str | None,
@@ -60,10 +60,10 @@ def __init__(
         self._on_off_device = _on_off_device
         self._opentherm_device = _opentherm_device
         self._request = _request
+        self._smile_props = _smile_props
         self._stretch_v2 = _stretch_v2
         self._target_smile = _target_smile
         self.cooling_present = False
-        self.gw_data = gw_data
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
         self.smile_mac_address = smile_mac_address
@@ -139,7 +139,7 @@ async def async_update(self) -> PlugwiseData:
         self._previous_day_number = day_number
         return PlugwiseData(
             devices=self.gw_entities,
-            gateway=self.gw_data,
+            gateway=self._smile_props,
         )
 
     ########################################################################################################
diff --git a/plugwise/smile.py b/plugwise/smile.py
@@ -22,9 +22,9 @@
     NOTIFICATIONS,
     OFF,
     RULES,
-    GatewayData,
     GwEntityData,
     PlugwiseData,
+    SmileProps,
     ThermoLoc,
 )
 from plugwise.data import SmileData
@@ -52,8 +52,8 @@ def __init__(
         _opentherm_device: bool,
         _request: Callable[..., Awaitable[Any]],
         _schedule_old_states: dict[str, dict[str, str]],
+        _smile_props: SmileProps,
         cooling_present: bool,
-        gw_data: GatewayData,
         smile_hostname: str | None,
         smile_hw_version: str | None,
         smile_mac_address: str | None,
@@ -75,8 +75,8 @@ def __init__(
         self._opentherm_device = _opentherm_device
         self._request = _request
         self._schedule_old_states = _schedule_old_states
+        self._smile_props = _smile_props
         self.cooling_present = cooling_present
-        self.gw_data = gw_data
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
         self.smile_mac_address = smile_mac_address
@@ -126,8 +126,8 @@ async def async_update(self) -> PlugwiseData:
             self.get_all_gateway_entities()
             # Set self._cooling_enabled - required for set_temperature(),
             # also, check for a failed data-retrieval
-            if "heater_id" in self.gw_data:
-                heat_cooler = self.gw_entities[self.gw_data["heater_id"]]
+            if "heater_id" in self._smile_props:
+                heat_cooler = self.gw_entities[self._smile_props["heater_id"]]
                 if (
                     "binary_sensors" in heat_cooler
                     and "cooling_enabled" in heat_cooler["binary_sensors"]
@@ -142,7 +142,7 @@ async def async_update(self) -> PlugwiseData:
 
         return PlugwiseData(
             devices=self.gw_entities,
-            gateway=self.gw_data,
+            gateway=self._smile_props,
         )
 
     ########################################################################################################
