plugwise 1.4.2a2__tar.gz → 1.4.4__tar.gz

{plugwise-1.4.2a2 → plugwise-1.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.4.2a2
+Version: 1.4.4
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise/__init__.py

@@ -6,7 +6,6 @@ from __future__ import annotations
 
 from plugwise.constants import (
     DEFAULT_PORT,
-    DEFAULT_TIMEOUT,
     DEFAULT_USERNAME,
     DOMAIN_OBJECTS,
     LOGGER,
@@ -32,6 +31,7 @@ from plugwise.smile import SmileAPI
 
 import aiohttp
 from defusedxml import ElementTree as etree
+from packaging.version import Version, parse
 
 
 class Smile(SmileComm):
@@ -61,7 +61,6 @@ class Smile(SmileComm):
         self._host = host
         self._passwd = password
         self._port = port
-        self._timeout = timeout
         self._user = username
         self._websession = websession
 
@@ -77,7 +76,7 @@ class Smile(SmileComm):
         self._target_smile: str = NONE
         self.gateway_id: str = NONE
         self.loc_data: dict[str, ThermoLoc] = {}
-        self.smile_fw_version: str | None = None
+        self.smile_fw_version: Version | None = None
         self.smile_hostname: str = NONE
         self.smile_hw_version: str | None = None
         self.smile_legacy = False
@@ -86,10 +85,10 @@ class Smile(SmileComm):
         self.smile_model_id: str | None = None
         self.smile_name: str = NONE
         self.smile_type: str = NONE
-        self.smile_version: str = NONE
+        self.smile_version: Version | None = None
         self.smile_zigbee_mac_address: str | None = None
 
-    async def connect(self) -> bool:
+    async def connect(self) -> Version | None:
         """Connect to Plugwise device and determine its name, type and version."""
         result = await self._request(DOMAIN_OBJECTS)
         # Work-around for Stretch fw 2.7.18
@@ -128,7 +127,7 @@ class Smile(SmileComm):
         self._smile_api = SmileAPI(
             self._host,
             self._passwd,
-            self._timeout,
+            self._request,
             self._websession,
             self._cooling_present,
             self._elga,
@@ -152,7 +151,7 @@ class Smile(SmileComm):
          ) if not self.smile_legacy else SmileLegacyAPI(
             self._host,
             self._passwd,
-            self._timeout,
+            self._request,
             self._websession,
             self._is_thermostat,
             self._on_off_device,
@@ -175,7 +174,7 @@ class Smile(SmileComm):
         # Update all endpoints on first connect
         await self._smile_api.full_update_device()
 
-        return True
+        return self.smile_version
 
     async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
         """Helper-function for connect().
@@ -186,7 +185,7 @@ class Smile(SmileComm):
         if (gateway := result.find("./gateway")) is not None:
             if (v_model := gateway.find("vendor_model")) is not None:
                 model = v_model.text
-            self.smile_fw_version = gateway.find("firmware_version").text
+            self.smile_fw_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
@@ -194,9 +193,6 @@ class Smile(SmileComm):
         else:
             model = await self._smile_detect_legacy(result, dsmrmain, model)
 
-        if not self.smile_legacy:
-            self._timeout = DEFAULT_TIMEOUT
-
         if model == "Unknown" or self.smile_fw_version is None:  # pragma: no cover
             # Corner case check
             LOGGER.error(
@@ -205,7 +201,7 @@ class Smile(SmileComm):
             )
             raise UnsupportedDeviceError
 
-        version_major: str = self.smile_fw_version.split(".", 1)[0]
+        version_major= str(self.smile_fw_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:
@@ -272,7 +268,7 @@ class Smile(SmileComm):
             or network is not None
         ):
             system = await self._request(SYSTEM)
-            self.smile_fw_version = system.find("./gateway/firmware").text
+            self.smile_fw_version = parse(system.find("./gateway/firmware").text)
             return_model = system.find("./gateway/product").text
             self.smile_hostname = system.find("./gateway/hostname").text
             # If wlan0 contains data it's active, so eth0 should be checked last
@@ -283,7 +279,7 @@ class Smile(SmileComm):
         # P1 legacy:
         elif dsmrmain is not None:
             status = await self._request(STATUS)
-            self.smile_fw_version = status.find("./system/version").text
+            self.smile_fw_version = parse(status.find("./system/version").text)
             return_model = status.find("./system/product").text
             self.smile_hostname = status.find("./network/hostname").text
             self.smile_mac_address = status.find("./network/mac_address").text

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise/helper.py

@@ -62,6 +62,7 @@ from dateutil import tz
 from dateutil.parser import parse
 from defusedxml import ElementTree as etree
 from munch import Munch
+from packaging.version import Version
 
 
 class SmileComm:
@@ -250,7 +251,7 @@ class SmileHelper(SmileCommon):
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
         self.loc_data: dict[str, ThermoLoc]
-        self.smile_fw_version: str | None
+        self.smile_fw_version: Version | None
         self.smile_hw_version: str | None
         self.smile_mac_address: str | None
         self.smile_model: str
@@ -425,7 +426,7 @@ class SmileHelper(SmileCommon):
     def _appl_gateway_info(self, appl: Munch, appliance: etree) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         self.gateway_id = appliance.attrib["id"]
-        appl.firmware = self.smile_fw_version
+        appl.firmware = str(self.smile_fw_version)
         appl.hardware = self.smile_hw_version
         appl.mac = self.smile_mac_address
         appl.model = self.smile_model

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise/legacy/helper.py

@@ -44,6 +44,7 @@ from plugwise.util import (
 # This way of importing aiohttp is because of patch/mocking in testing (aiohttp timeouts)
 from defusedxml import ElementTree as etree
 from munch import Munch
+from packaging.version import Version
 
 
 def etree_to_dict(element: etree) -> dict[str, str]:
@@ -81,7 +82,7 @@ class SmileLegacyHelper(SmileCommon):
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
         self.loc_data: dict[str, ThermoLoc]
-        self.smile_fw_version: str | None
+        self.smile_fw_version: Version | None
         self.smile_hw_version: str | None
         self.smile_mac_address: str | None
         self.smile_model: str
@@ -194,7 +195,7 @@ class SmileLegacyHelper(SmileCommon):
         self.gw_devices[self.gateway_id] = {"dev_class": "gateway"}
         self._count += 1
         for key, value in {
-            "firmware": self.smile_fw_version,
+            "firmware": str(self.smile_fw_version),
             "location": self._home_location,
             "mac_address": self.smile_mac_address,
             "model": self.smile_model,

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise/legacy/smile.py

@@ -4,6 +4,7 @@ Plugwise backend module for Home Assistant Core - covering the legacy P1, Anna,
 """
 from __future__ import annotations
 
+from collections.abc import Awaitable, Callable
 import datetime as dt
 from typing import Any
 
@@ -24,14 +25,14 @@ from plugwise.constants import (
     ThermoLoc,
 )
 from plugwise.exceptions import ConnectionFailedError, PlugwiseError
-from plugwise.helper import SmileComm
 from plugwise.legacy.data import SmileLegacyData
 
 import aiohttp
 from munch import Munch
+from packaging.version import Version
 
 
-class SmileLegacyAPI(SmileComm, SmileLegacyData):
+class SmileLegacyAPI(SmileLegacyData):
     """The Plugwise SmileLegacyAPI class."""
 
     # pylint: disable=too-many-instance-attributes, too-many-public-methods
@@ -40,7 +41,7 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
         self,
         host: str,
         password: str,
-        timeout: int,
+        request: Callable[..., Awaitable[Any]],
         websession: aiohttp.ClientSession,
         _is_thermostat: bool,
         _on_off_device: bool,
@@ -48,7 +49,7 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
         _stretch_v2: bool,
         _target_smile: str,
         loc_data: dict[str, ThermoLoc],
-        smile_fw_version: str | None,
+        smile_fw_version: Version | None,
         smile_hostname: str,
         smile_hw_version: str | None,
         smile_mac_address: str | None,
@@ -60,14 +61,6 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
         username: str = DEFAULT_USERNAME,
     ) -> None:
         """Set the constructor for this class."""
-        super().__init__(
-            host,
-            password,
-            port,
-            timeout,
-            username,
-            websession,
-         )
         SmileLegacyData.__init__(self)
 
         self._cooling_present = False
@@ -76,8 +69,8 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
         self._opentherm_device = _opentherm_device
         self._stretch_v2 = _stretch_v2
         self._target_smile = _target_smile
-        self._timeout = timeout
         self.loc_data = loc_data
+        self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
@@ -91,12 +84,12 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
 
     async def full_update_device(self) -> None:
         """Perform a first fetch of all XML data, needed for initialization."""
-        self._domain_objects = await self._request(DOMAIN_OBJECTS)
-        self._locations = await self._request(LOCATIONS)
-        self._modules = await self._request(MODULES)
+        self._domain_objects = await self.request(DOMAIN_OBJECTS)
+        self._locations = await self.request(LOCATIONS)
+        self._modules = await self.request(MODULES)
         # P1 legacy has no appliances
         if self.smile_type != "power":
-            self._appliances = await self._request(APPLIANCES)
+            self._appliances = await self.request(APPLIANCES)
 
     def get_all_devices(self) -> None:
         """Determine the evices present from the obtained XML-data.
@@ -131,12 +124,12 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
             self.get_all_devices()
         # Otherwise perform an incremental update
         else:
-            self._domain_objects = await self._request(DOMAIN_OBJECTS)
+            self._domain_objects = await self.request(DOMAIN_OBJECTS)
             match self._target_smile:
                 case "smile_v2":
-                    self._modules = await self._request(MODULES)
+                    self._modules = await self.request(MODULES)
                 case self._target_smile if self._target_smile in REQUIRE_APPLIANCES:
-                    self._appliances = await self._request(APPLIANCES)
+                    self._appliances = await self.request(APPLIANCES)
 
             self._update_gw_devices()
 
@@ -291,10 +284,10 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
         await self.call_request(uri, method="put", data=data)
 
     async def call_request(self, uri: str, **kwargs: Any) -> None:
-        """ConnectionFailedError wrapper for calling _request()."""
+        """ConnectionFailedError wrapper for calling request()."""
         method: str = kwargs["method"]
         data: str | None = kwargs.get("data")
         try:
-            await self._request(uri, method=method, data=data)
+            await self.request(uri, method=method, data=data)
         except ConnectionFailedError as exc:
             raise ConnectionFailedError from exc

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise/smile.py

@@ -4,6 +4,7 @@ Plugwise backend module for Home Assistant Core.
 """
 from __future__ import annotations
 
+from collections.abc import Awaitable, Callable
 import datetime as dt
 from typing import Any
 
@@ -28,16 +29,16 @@ from plugwise.constants import (
 )
 from plugwise.data import SmileData
 from plugwise.exceptions import ConnectionFailedError, DataMissingError, PlugwiseError
-from plugwise.helper import SmileComm
 
 import aiohttp
 from defusedxml import ElementTree as etree
 
 # Dict as class
 from munch import Munch
+from packaging.version import Version
 
 
-class SmileAPI(SmileComm, SmileData):
+class SmileAPI(SmileData):
     """The Plugwise SmileAPI helper class for actual Plugwise devices."""
 
     # pylint: disable=too-many-instance-attributes, too-many-public-methods
@@ -46,7 +47,7 @@ class SmileAPI(SmileComm, SmileData):
         self,
         host: str,
         password: str,
-        timeout: int,
+        request: Callable[..., Awaitable[Any]],
         websession: aiohttp.ClientSession,
         _cooling_present: bool,
         _elga: bool,
@@ -57,7 +58,7 @@ class SmileAPI(SmileComm, SmileData):
         _schedule_old_states: dict[str, dict[str, str]],
         gateway_id: str,
         loc_data: dict[str, ThermoLoc],
-        smile_fw_version: str | None,
+        smile_fw_version: Version | None,
         smile_hostname: str | None,
         smile_hw_version: str | None,
         smile_mac_address: str | None,
@@ -69,14 +70,6 @@ class SmileAPI(SmileComm, SmileData):
         username: str = DEFAULT_USERNAME,
     ) -> None:
         """Set the constructor for this class."""
-        super().__init__(
-            host,
-            password,
-            port,
-            timeout,
-            username,
-            websession,
-        )
         SmileData.__init__(self)
 
         self._cooling_present = _cooling_present
@@ -86,9 +79,9 @@ class SmileAPI(SmileComm, SmileData):
         self._on_off_device = _on_off_device
         self._opentherm_device = _opentherm_device
         self._schedule_old_states = _schedule_old_states
-        self._timeout = timeout
         self.gateway_id = gateway_id
         self.loc_data = loc_data
+        self.request = request
         self.smile_fw_version = smile_fw_version
         self.smile_hostname = smile_hostname
         self.smile_hw_version = smile_hw_version
@@ -103,7 +96,7 @@ class SmileAPI(SmileComm, SmileData):
 
     async def full_update_device(self) -> None:
         """Perform a first fetch of all XML data, needed for initialization."""
-        self._domain_objects = await self._request(DOMAIN_OBJECTS)
+        self._domain_objects = await self.request(DOMAIN_OBJECTS)
         self._get_plugwise_notifications()
 
     def get_all_devices(self) -> None:
@@ -461,10 +454,10 @@ class SmileAPI(SmileComm, SmileData):
         await self.call_request(uri, method="put", data=data)
 
     async def call_request(self, uri: str, **kwargs: Any) -> None:
-        """ConnectionFailedError wrapper for calling _request()."""
+        """ConnectionFailedError wrapper for calling request()."""
         method: str = kwargs["method"]
         data: str | None = kwargs.get("data")
         try:
-            await self._request(uri, method=method, data=data)
+            await self.request(uri, method=method, data=data)
         except ConnectionFailedError as exc:
             raise ConnectionFailedError from exc

{plugwise-1.4.2a2 → plugwise-1.4.4}/plugwise.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 1.4.2a2
+Version: 1.4.4
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners

{plugwise-1.4.2a2 → plugwise-1.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "1.4.2a2"
+version         = "1.4.4"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3."
 readme          = "README.md"

{plugwise-1.4.2a2 → plugwise-1.4.4}/tests/test_init.py

@@ -17,6 +17,7 @@ import pytest
 # Testing
 import aiohttp
 from freezegun import freeze_time
+from packaging import version
 
 pw_constants = importlib.import_module("plugwise.constants")
 pw_exceptions = importlib.import_module("plugwise.exceptions")
@@ -344,15 +345,17 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
             assert smile._timeout == 10
 
         # Connect to the smile
+        version = None
         try:
-            connection_state = await smile.connect()
-            assert connection_state
+            version = await smile.connect()
+            assert version is not None
             return server, smile, client
         except (
             pw_exceptions.ConnectionFailedError,
             pw_exceptions.InvalidXMLError,
             pw_exceptions.InvalidAuthentication,
         ) as exception:
+            assert version is None
             await self.disconnect(server, client)
             raise exception
 
@@ -427,15 +430,17 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
             assert smile._timeout == 30
 
         # Connect to the smile
+        version = None
         try:
-            connection_state = await smile.connect()
-            assert connection_state
+            version = await smile.connect()
+            assert version is not None
             return server, smile, client
         except (
             pw_exceptions.ConnectionFailedError,
             pw_exceptions.InvalidXMLError,
             pw_exceptions.InvalidAuthentication,
         ) as exception:
+            assert version is None
             await self.disconnect(server, client)
             raise exception
 
@@ -1004,7 +1009,7 @@ class TestPlugwise:  # pylint: disable=attribute-defined-outside-init
         if smile_version:
             log_msg = f" # Assert version matching '{smile_version}"
             parent_logger.info(log_msg)
-            assert smile.smile_version == smile_version
+            assert smile.smile_version == version.parse(smile_version)
         log_msg = f" # Assert legacy {smile_legacy}"
         parent_logger.info(log_msg)
         if smile_legacy: