Add devices property, replacing the PlugwiseData output

Author: bouwew

plugwise/__init__.py

@@ -17,7 +17,7 @@
     SMILES,
     STATUS,
     SYSTEM,
-    PlugwiseData,
+    GwEntityData,
     SmileProps,
     ThermoLoc,
 )
@@ -63,6 +63,7 @@ def __init__(
         )
 
         self._cooling_present = False
+        self._devices: dict[str, GwEntityData] = {}
         self._elga = False
         self._is_thermostat = False
         self._last_active: dict[str, str | None] = {}
@@ -92,6 +93,11 @@ def cooling_present(self) -> bool:
             return self._smile_props["cooling_present"]
         return False
 
+    @property
+    def devices(self) -> dict[str, GwEntityData]:
+        """Return all devices and their data."""
+        return self._devices
+
     @property
     def gateway_id(self) -> str:
         """Return the gateway-id."""
@@ -338,16 +344,13 @@ def get_all_gateway_entities(self) -> None:
         """Collect the Plugwise Gateway entities and their data and states from the received raw XML-data."""
         self._smile_api.get_all_gateway_entities()
 
-    async def async_update(self) -> PlugwiseData:
+    async def async_update(self) -> None:
         """Update the Plughwise Gateway entities and their data and states."""
-        data = PlugwiseData(devices={}, gateway={})
         try:
-            data = await self._smile_api.async_update()
+            self._devices = await self._smile_api.async_update()
         except (DataMissingError, KeyError) as err:
             raise PlugwiseError("No Plugwise data received") from err
 
-        return data
-
     ########################################################################################################
     ###  API Set and HA Service-related Functions                                                        ###
     ########################################################################################################

plugwise/constants.py

@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 from collections import namedtuple
-from dataclasses import dataclass
 import logging
 from typing import Final, Literal, TypedDict, get_args
 
@@ -577,11 +576,3 @@ class GwEntityData(TypedDict, total=False):
     switches: SmileSwitches
     temperature_offset: ActuatorData
     thermostat: ActuatorData
-
-
-@dataclass
-class PlugwiseData:
-    """Plugwise data provided as output."""
-
-    devices: dict[str, GwEntityData]
-    gateway: SmileProps

plugwise/data.py

@@ -28,6 +28,7 @@ class SmileData(SmileHelper):
     def __init__(self) -> None:
         """Init."""
         self._smile_props: SmileProps
+        self.gw_entities: dict[str, GwEntityData]
         SmileHelper.__init__(self)
 
     def _all_entity_data(self) -> None:

plugwise/helper.py

@@ -109,7 +109,7 @@ def __init__(self) -> None:
         self._cooling_active = False
         self._cooling_enabled = False
 
-        self.gw_entities: dict[str, GwEntityData] = {}
+        self.gw_entities: dict[str, GwEntityData]
         self.smile_hw_version: str | None
         self.smile_mac_address: str | None
         self.smile_model: str
@@ -118,7 +118,7 @@ def __init__(self) -> None:
         self.smile_type: str
         self.smile_version: version.Version | None
         self.smile_zigbee_mac_address: str | None
-        self._zones: dict[str, GwEntityData] = {}
+        self._zones: dict[str, GwEntityData]
         SmileCommon.__init__(self)
 
     def _all_appliances(self) -> None:

plugwise/legacy/smile.py

@@ -19,7 +19,6 @@
     REQUIRE_APPLIANCES,
     RULES,
     GwEntityData,
-    PlugwiseData,
     SmileProps,
     ThermoLoc,
 )
@@ -98,7 +97,7 @@ def get_all_gateway_entities(self) -> None:
 
         self._all_entity_data()
 
-    async def async_update(self) -> PlugwiseData:
+    async def async_update(self) -> dict[str, GwEntityData]:
         """Perform an full update update at day-change: re-collect all gateway entities and their data and states.
 
         Otherwise perform an incremental update: only collect the entities updated data and states.
@@ -137,10 +136,7 @@ async def async_update(self) -> PlugwiseData:
                 raise DataMissingError("No legacy Plugwise data received") from err
 
         self._previous_day_number = day_number
-        return PlugwiseData(
-            devices=self.gw_entities,
-            gateway=self._smile_props,
-        )
+        return self.gw_entities
 
     ########################################################################################################
     ###  API Set and HA Service-related Functions                                                        ###

plugwise/smile.py

@@ -23,7 +23,6 @@
     OFF,
     RULES,
     GwEntityData,
-    PlugwiseData,
     SmileProps,
     ThermoLoc,
 )
@@ -114,7 +113,7 @@ def get_all_gateway_entities(self) -> None:
 
         self._all_entity_data()
 
-    async def async_update(self) -> PlugwiseData:
+    async def async_update(self) -> dict[str, GwEntityData]:
         """Perform an full update: re-collect all gateway entities and their data and states.
 
         Any change in the connected entities will be detected immediately.
@@ -140,10 +139,7 @@ async def async_update(self) -> PlugwiseData:
         except KeyError as err:
             raise DataMissingError("No Plugwise actual data received") from err
 
-        return PlugwiseData(
-            devices=self.gw_entities,
-            gateway=self._smile_props,
-        )
+        return self.gw_entities
 
     ########################################################################################################
     ###  API Set and HA Service-related Functions                                                        ###

tests/test_adam.py

@@ -52,6 +52,7 @@ async def test_connect_adam_plus_anna_new(self):
             "f2bf9048bef64cc5b6d5110154e33c81",
             "f871b8c4d63549319221e294e4f88074",
         ]
+        assert smile.reboot
 
         result = await self.tinker_thermostat(
             smile,

tests/test_init.py

@@ -608,14 +608,19 @@ def test_and_assert(test_dict, data, header):
                 if smile.smile_legacy:
                     await smile.full_xml_update()
                     smile.get_all_gateway_entities()
-                    data = await smile.async_update()
+                    await smile.async_update()
                     assert smile._timeout == 30
                 else:
-                    data = await smile.async_update()
+                    await smile.async_update()
                     assert smile._timeout == 10
             else:
                 _LOGGER.info("Asserting updated testdata:")
-                data = await smile.async_update()
+                await smile.async_update()
+
+        _LOGGER.info("Gateway id = %s", smile.gateway_id)
+        _LOGGER.info("Heater id = %s", smile.heater_id)
+        _LOGGER.info("Hostname = %s", smile.smile_hostname)
+        _LOGGER.info("Entities list = %s", smile.devices)
 
         self.cooling_present = smile.cooling_present
         self.notifications = smile.notifications
@@ -624,7 +629,7 @@ def test_and_assert(test_dict, data, header):
         self._cooling_active = False
         self._cooling_enabled = False
         if smile.heater_id != "None":
-            heat_cooler = data.devices[smile.heater_id]
+            heat_cooler = smile.devices[smile.heater_id]
             if "binary_sensors" in heat_cooler:
                 if "cooling_enabled" in heat_cooler["binary_sensors"]:
                     self._cooling_enabled = heat_cooler["binary_sensors"][
@@ -635,27 +640,24 @@ def test_and_assert(test_dict, data, header):
                         "cooling_state"
                     ]
 
-        self._write_json("all_data", {"devices": data.devices, "gateway": data.gateway})
+        self._write_json("all_data", {"devices": smile.devices})
 
         if "FIXTURES" in os.environ:
             _LOGGER.info("Skipping tests: Requested fixtures only")  # pragma: no cover
             return  # pragma: no cover
 
-        self.entity_list = list(data.devices.keys())
+        self.entity_list = list(smile.devices.keys())
         location_list = smile._loc_data
 
-        _LOGGER.info("Gateway id = %s", smile.gateway_id)
-        _LOGGER.info("Hostname = %s", smile.smile_hostname)
-        _LOGGER.info("Gateway data = %s", data.gateway)
-        _LOGGER.info("Entities list = %s", data.devices)
-        self.show_setup(location_list, data.devices)
+
+        self.show_setup(location_list, smile.devices)
 
         if skip_testing:
             return
 
         # Perform tests and asserts in two steps: devices and zones
         for header, data_dict in testdata.items():
-            test_and_assert(data_dict, data.devices, header)
+            test_and_assert(data_dict, smile.devices, header)
 
         # pragma warning restore S3776
 

tests/test_legacy_anna.py

@@ -31,6 +31,7 @@ async def test_connect_legacy_anna(self):
         await self.device_test(smile, "2020-03-22 00:00:01", testdata)
         assert smile.gateway_id == "0000aaaa0000aaaa0000aaaa0000aa00"
         assert self.entity_items == 41
+        assert not smile.reboot
 
         result = await self.tinker_legacy_thermostat(smile, schedule_on=False)
         assert result