plugwise 0.37.9__py3-none-any.whl → 0.38.0__py3-none-any.whl

plugwise/__init__.py

@@ -18,7 +18,14 @@ from plugwise.constants import (
     PlugwiseData,
     ThermoLoc,
 )
-from plugwise.exceptions import InvalidSetupError, ResponseError, UnsupportedDeviceError
+from plugwise.exceptions import (
+    ConnectionFailedError,
+    DataMissingError,
+    InvalidSetupError,
+    PlugwiseError,
+    ResponseError,
+    UnsupportedDeviceError,
+)
 from plugwise.helper import SmileComm
 from plugwise.legacy.smile import SmileLegacyAPI
 from plugwise.smile import SmileAPI
@@ -141,30 +148,28 @@ class Smile(SmileComm):
             self._user,
             self._port,
             self._timeout,
-         )
-        if self.smile_legacy:
-            self._smile_api = SmileLegacyAPI(
-                self._host,
-                self._passwd,
-                self._websession,
-                self._is_thermostat,
-                self._on_off_device,
-                self._opentherm_device,
-                self._stretch_v2,
-                self._target_smile,
-                self.loc_data,
-                self.smile_fw_version,
-                self.smile_hostname,
-                self.smile_hw_version,
-                self.smile_mac_address,
-                self.smile_model,
-                self.smile_name,
-                self.smile_type,
-                self.smile_zigbee_mac_address,
-                self._user,
-                self._port,
-                self._timeout,
-            )
+         ) if not self.smile_legacy else SmileLegacyAPI(
+            self._host,
+            self._passwd,
+            self._websession,
+            self._is_thermostat,
+            self._on_off_device,
+            self._opentherm_device,
+            self._stretch_v2,
+            self._target_smile,
+            self.loc_data,
+            self.smile_fw_version,
+            self.smile_hostname,
+            self.smile_hw_version,
+            self.smile_mac_address,
+            self.smile_model,
+            self.smile_name,
+            self.smile_type,
+            self.smile_zigbee_mac_address,
+            self._user,
+            self._port,
+            self._timeout,
+        )
 
         # Update all endpoints on first connect
         await self._smile_api.full_update_device()
@@ -289,17 +294,22 @@ class Smile(SmileComm):
         return return_model
 
     async def full_update_device(self) -> None:
-        """Perform a first fetch of all XML data, needed for initialization."""
+        """Helper-function used for testing."""
         await self._smile_api.full_update_device()
 
     def get_all_devices(self) -> None:
-        """Determine the devices present from the obtained XML-data."""
+        """Helper-function used for testing."""
         self._smile_api.get_all_devices()
 
     async def async_update(self) -> PlugwiseData:
         """Perform an incremental update for updating the various device states."""
-        data: PlugwiseData = await self._smile_api.async_update()
-        self.gateway_id = data.gateway["gateway_id"]
+        data = PlugwiseData({}, {})
+        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
+
         return data
 
 ########################################################################################################
@@ -366,4 +376,14 @@ class Smile(SmileComm):
 
     async def delete_notification(self) -> None:
         """Delete the active Plugwise Notification."""
-        await self._smile_api.delete_notification()
+        try:
+            await self._smile_api.delete_notification()
+        except ConnectionFailedError as exc:
+            raise PlugwiseError(f"Failed to delete notification: {str(exc)}") from exc
+
+    async def reboot_gateway(self) -> None:
+        """Reboot the Plugwise Gateway."""
+        try:
+            await self._smile_api.reboot_gateway()
+        except ConnectionFailedError as exc:
+            raise PlugwiseError(f"Failed to reboot gateway: {str(exc)}") from exc

plugwise/constants.py

@@ -17,6 +17,7 @@ DEGREE: Final = "°"
 ELECTRIC_POTENTIAL_VOLT: Final = "V"
 ENERGY_KILO_WATT_HOUR: Final = "kWh"
 ENERGY_WATT_HOUR: Final = "Wh"
+GATEWAY_REBOOT: Final = "/core/gateways;@reboot"
 PERCENTAGE: Final = "%"
 POWER_WATT: Final = "W"
 PRESET_AWAY: Final = "away"
@@ -388,6 +389,7 @@ class GatewayData(TypedDict, total=False):
     heater_id: str
     item_count: int
     notifications: dict[str, dict[str, str]]
+    reboot: bool
     smile_name: str
 
 

plugwise/data.py

@@ -38,6 +38,7 @@ class SmileData(SmileHelper):
                 "gateway_id": self.gateway_id,
                 "item_count": self._count,
                 "notifications": self._notifications,
+                "reboot": True,
                 "smile_name": self.smile_name,
             }
         )

plugwise/exceptions.py

@@ -9,6 +9,10 @@ class ConnectionFailedError(PlugwiseException):
     """Raised when unable to connect."""
 
 
+class DataMissingError(PlugwiseException):
+    """Raised when expected data is missing."""
+
+
 class InvalidAuthentication(PlugwiseException):
     """Raised when unable to authenticate."""
 
@@ -29,14 +33,6 @@ class DeviceSetupError(PlugwiseException):
     """Raised when device is missing critical setup data."""
 
 
-class DeviceTimeoutError(PlugwiseException):
-    """Raised when device is not supported."""
-
-
-class ErrorSendingCommandError(PlugwiseException):
-    """Raised when device is not accepting the command."""
-
-
 class ResponseError(PlugwiseException):
     """Raised when empty or error in response returned."""
 

plugwise/helper.py

@@ -123,6 +123,14 @@ class SmileComm:
                 resp = await self._websession.get(
                     url, headers=use_headers, auth=self._auth
                 )
+            if method == "post":
+                use_headers = {"Content-type": "text/xml"}
+                resp = await self._websession.post(
+                    url,
+                    headers=use_headers,
+                    data=data,
+                    auth=self._auth,
+                )
             if method == "put":
                 use_headers = {"Content-type": "text/xml"}
                 resp = await self._websession.put(
@@ -144,6 +152,17 @@ class SmileComm:
                 raise ConnectionFailedError from exc
             return await self._request(command, retry - 1)
 
+        if resp.status == 504:
+            if retry < 1:
+                LOGGER.warning(
+                    "Failed sending %s %s to Plugwise Smile, error: %s",
+                    method,
+                    command,
+                    "504 Gateway Timeout",
+                )
+                raise ConnectionFailedError
+            return await self._request(command, retry - 1)
+
         return await self._request_validate(resp, method)
 
     async def _request_validate(self, resp: ClientResponse, method: str) -> etree:
@@ -152,8 +171,8 @@ class SmileComm:
         if resp.status == 202:
             return
 
-        # Cornercase for stretch not responding with 202
-        if method == "put" and resp.status == 200:
+        # Cornercase for server not responding with 202
+        if method in ("post", "put") and resp.status == 200:
             return
 
         if resp.status == 401:
@@ -161,7 +180,14 @@ class SmileComm:
             LOGGER.error("%s", msg)
             raise InvalidAuthentication
 
-        if not (result := await resp.text()) or "<error>" in result:
+        if resp.status == 405:
+            msg = "405 Method not allowed."
+            LOGGER.error("%s", msg)
+            raise ConnectionFailedError
+
+        if not (result := await resp.text()) or (
+            "<error>" in result and "Not started" not in result
+        ):
             LOGGER.warning("Smile response empty or error in %s", result)
             raise ResponseError
 

plugwise/legacy/smile.py

@@ -149,6 +149,9 @@ class SmileLegacyAPI(SmileComm, SmileLegacyData):
     async def delete_notification(self) -> None:
         """Set-function placeholder for legacy devices."""
 
+    async def reboot_gateway(self) -> None:
+        """Set-function placeholder for legacy devices."""
+
     async def set_dhw_mode(self, mode: str) -> None:
         """Set-function placeholder for legacy devices."""
 

plugwise/smile.py

@@ -5,6 +5,7 @@ Plugwise backend module for Home Assistant Core.
 from __future__ import annotations
 
 import datetime as dt
+from typing import Any
 
 from plugwise.constants import (
     ADAM,
@@ -14,6 +15,7 @@ from plugwise.constants import (
     DEFAULT_TIMEOUT,
     DEFAULT_USERNAME,
     DOMAIN_OBJECTS,
+    GATEWAY_REBOOT,
     LOCATIONS,
     MAX_SETPOINT,
     MIN_SETPOINT,
@@ -26,7 +28,7 @@ from plugwise.constants import (
     ThermoLoc,
 )
 from plugwise.data import SmileData
-from plugwise.exceptions import PlugwiseError
+from plugwise.exceptions import ConnectionFailedError, DataMissingError, PlugwiseError
 from plugwise.helper import SmileComm
 
 import aiohttp
@@ -131,13 +133,15 @@ class SmileAPI(SmileComm, SmileData):
         # Perform a full update at day-change
         self.gw_data: GatewayData = {}
         self.gw_devices: dict[str, DeviceData] = {}
-        await self.full_update_device()
-        self.get_all_devices()
-
-        if "heater_id" in self.gw_data:
-            self._heater_id = self.gw_data["heater_id"]
-            if "cooling_enabled" in self.gw_devices[self._heater_id]["binary_sensors"]:
-                self._cooling_enabled = self.gw_devices[self._heater_id]["binary_sensors"]["cooling_enabled"]
+        try:
+            await self.full_update_device()
+            self.get_all_devices()
+            if "heater_id" in self.gw_data:
+                self._heater_id = self.gw_data["heater_id"]
+                if "cooling_enabled" in self.gw_devices[self._heater_id]["binary_sensors"]:
+                    self._cooling_enabled = self.gw_devices[self._heater_id]["binary_sensors"]["cooling_enabled"]
+        except KeyError as err:
+            raise DataMissingError("No Plugwise data received") from err
 
         return PlugwiseData(self.gw_data, self.gw_devices)
 
@@ -145,9 +149,21 @@ class SmileAPI(SmileComm, SmileData):
 ###  API Set and HA Service-related Functions                                                        ###
 ########################################################################################################
 
+    async def call_request(self, uri: str, **kwargs: Any) -> None:
+        """ConnectionFailedError wrapper for calling _request()."""
+        method: str = kwargs["method"]
+        try:
+            await self._request(uri, method=method)
+        except ConnectionFailedError as exc:
+            raise ConnectionFailedError from exc
+
     async def delete_notification(self) -> None:
         """Delete the active Plugwise Notification."""
-        await self._request(NOTIFICATIONS, method="delete")
+        await self.call_request(NOTIFICATIONS, method="delete")
+
+    async def reboot_gateway(self) -> None:
+        """Reboot the Gateway."""
+        await self.call_request(GATEWAY_REBOOT, method="post")
 
     async def set_number(
         self,

{plugwise-0.37.9.dist-info → plugwise-0.38.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plugwise
-Version: 0.37.9
+Version: 0.38.0
 Summary: Plugwise Smile (Adam/Anna/P1) and Stretch module for Python 3.
 Home-page: https://github.com/plugwise/python-plugwise
 Author: Plugwise device owners
@@ -54,12 +54,13 @@ This module supports `Smile`s (and `Stretch`), i.e. the networked plugwise devic
 Our main usage for this module is supporting [Home Assistant](https://www.home-assistant.io) / [home-assistant](http://github.com/home-assistant/core/)
 
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/plugwise)
-[![PyPI version fury.io](https://badge.fury.io/py/plugwise.svg)](https://pypi.python.org/pypi/plugwise/)
+[![CodeRabbit.ai is Awesome](https://img.shields.io/badge/AI-orange?label=CodeRabbit&color=orange&link=https%3A%2F%2Fcoderabbit.ai)](https://coderabbit.ai)
+[![renovate maintained](https://img.shields.io/badge/maintained%20with-renovate-blue?logo=renovatebot)](https://github.com/plugwise/python-plugwise/issues/291)
 
+[![PyPI version fury.io](https://badge.fury.io/py/plugwise.svg)](https://pypi.python.org/pypi/plugwise/)
 [![Latest release](https://github.com/plugwise/python-plugwise/workflows/Latest%20release/badge.svg)](https://github.com/plugwise/python-plugwise/actions)
 [![Newest commit](https://github.com/plugwise/python-plugwise/workflows/Latest%20commit/badge.svg)](https://github.com/plugwise/python-plugwise/actions)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/plugwise/python-plugwise/main.svg)](https://results.pre-commit.ci/latest/github/plugwise/python-plugwise/main)
-[![renovate maintained](https://img.shields.io/badge/maintained%20with-renovate-blue?logo=renovatebot)](https://github.com/plugwise/python-plugwise/issues/291)
 
 [![CodeFactor](https://www.codefactor.io/repository/github/plugwise/python-plugwise/badge)](https://www.codefactor.io/repository/github/plugwise/python-plugwise)
 [![codecov](https://codecov.io/gh/plugwise/python-plugwise/branch/main/graph/badge.svg)](https://codecov.io/gh/plugwise/python-plugwise)
@@ -94,9 +95,9 @@ See the [`plugwise-beta`](https://github.com/plugwise/plugwise-beta) repository
 
 ## Development/patches
 
-Like Home Assistant Core we use `pre-commit` and additionally run [pre-commit.ci](http://pre-commit.ci) to automatically validate your commits and PRs.
+Like Home Assistant Core, we use `pre-commit` and additionally run [pre-commit.ci](http://pre-commit.ci) to automatically validate your commits and PRs.
 
-If you want to create a PR please make sure you at least run `scripts/setup.sh`. This will ensure your environment is set up correctly before attempting to `git commit`. We sincerely and highly recommended also setting up local testing, see [`tests/README.md`](https://github.com/plugwise/python-plugwise/blob/main/tests/README.md) for more information and run `scripts/setup_test.sh` to prepare your environment.
+If you want to create a PR, please ensure you at least run `scripts/setup.sh`. This will ensure your environment is set up correctly before attempting to `git commit`. We sincerely and highly recommended also setting up local testing, see [`tests/README.md`](https://github.com/plugwise/python-plugwise/blob/main/tests/README.md) for more information and run `scripts/setup_test.sh` to prepare your environment.
 
 ## Project support status
 
@@ -125,13 +126,13 @@ Module providing interfacing with the Plugwise devices:
 
 ## License, origins and contributors
 
-As per the origins we have retained the appropriate licensing and including the MIT-license for this project.
+As per the origins, we have retained the appropriate licensing and including the MIT-license for this project.
 
 Origins (from newest to oldest):
 
 - Networked (Smile/Stretch) Plugwise support by @bouwew (Bouwe) and @CoMPaTech (Tom). We both support and help out @brefra (Frank) where possible, he's supporting the USB module and integration.
 - 'All' available Plugwise support by @bouwew (Bouwe), @brefra (Frank) and @CoMPaTech (Tom)
-- Upstreamed haanna/HA-core Anna, including all later products - 'Plugwise-Smile/Plugwise-HA/plugwise-beta` by @bouwew (Bouwe) & @CoMPaTech (Tom)
+- Upstreamed haanna/HA-core Anna, including all later products - 'Plugwise-Smile/Plugwise-HA/plugwise-beta' by @bouwew (Bouwe) & @CoMPaTech (Tom)
 - Networked Plugwise Anna module with custom_module - `haanna/anna-ha` via <https://github.com/laetificat> (Kevin)
 - USB-based stick module with custom_module - `plugwise-stick/plugwise` by @brefra (Frank)
 - USB-plugwise module - `plugwise` by <https://github.com/cyberjunky/python-plugwise> (Ron) originally by <https://github.com/aequitas/python-plugwise> (Johan) (with reference only in license to Sven)
@@ -139,4 +140,4 @@ Origins (from newest to oldest):
 
 ## Thanks
 
-On behalf all of us, big thanks to Plugwise and community members @riemers and @tane from [HAshop](https://hashop.nl) for their support and obviously all our users and testers who dealt with our typos and challenges. Disclaimer, while we are communicating with Plugwise and they expressed their gratitude through their newsletter, we are not part of Plugwise as a company. We are just a bunch of guys anxious to get our (and your) Plugwise products working with Home Assistant.
+On behalf of all of us, big thanks to Plugwise and community members @riemers and @tane from [HAshop](https://hashop.nl) for their support and obviously all our users and testers who dealt with our typos and challenges. Disclaimer, while we are communicating with Plugwise and they expressed their gratitude through their newsletter, we are not part of Plugwise as a company. We are just a bunch of guys anxious to get our (and your) Plugwise products working with Home Assistant.

plugwise-0.38.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+plugwise/__init__.py,sha256=yJu-PvXj2gov6G85fCptfNAbMkAb_tMfiv8Uc9PgnQ8,14936
+plugwise/common.py,sha256=P4sUYzgVcFsIR2DmQxeVeOiZvFZWpZXgwHA3XRc1Sx0,12538
+plugwise/constants.py,sha256=aP2ifDFIRuzYzuhJk1cOdqN84yR135eqCzAATrhxMo4,16646
+plugwise/data.py,sha256=HA3OoLrTad4ytns6_rfygwu8eGfopHJBNADGs-hvaQk,9054
+plugwise/exceptions.py,sha256=Ce-tO9uNsMB-8FP6VAxBvsHNJ-NIM9F0onUZOdZI4Ys,1110
+plugwise/helper.py,sha256=ctx5VbM9xQpNzHfL03WDP3H0yhhpC3MPI08LnhVUPxQ,43714
+plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plugwise/smile.py,sha256=Dldh70NxbOrOPY6sIV79lb4YADsUOVR1vXr8m98aWd4,18520
+plugwise/util.py,sha256=9ld46KJHWFze2eUrVSgUYn0g3zNerlpboM0iUa0H3ak,7830
+plugwise/legacy/data.py,sha256=DsHR9xgiFDg_Vh_6ZpOskw8ZhNQ3CmwjstI3yiH6MEk,3048
+plugwise/legacy/helper.py,sha256=6-tYQMEXepE5rec-hn6lt2EeknADI3J8UFuBSLgu8dk,17878
+plugwise/legacy/smile.py,sha256=O8LzM1yCfdu2tiebUcm73bd7f39PIjGbwMxgDeZ_FkE,10864
+plugwise-0.38.0.dist-info/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
+plugwise-0.38.0.dist-info/METADATA,sha256=5VGoiUgUS66yHXqvzJNupesOviaRbtyxS1z3OUMcnCs,9098
+plugwise-0.38.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+plugwise-0.38.0.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
+plugwise-0.38.0.dist-info/RECORD,,

plugwise-0.37.9.dist-info/RECORD

@@ -1,17 +0,0 @@
-plugwise/__init__.py,sha256=mI2mFZWucme1PJbsZssV7L7957nQot_LVS-ZeIcE-80,14427
-plugwise/common.py,sha256=P4sUYzgVcFsIR2DmQxeVeOiZvFZWpZXgwHA3XRc1Sx0,12538
-plugwise/constants.py,sha256=dvafW3u7LBbWUN05D1Tss7s4jxEDJiZDqnh4-q9isUM,16580
-plugwise/data.py,sha256=9sH2FkwGh5Uvbf42LmZPWutY9Qa-j9qmFZBobwJkLQo,9022
-plugwise/exceptions.py,sha256=rymGtWnXosdFkzSehc_41HVl2jXJEg_9Hq9APDEUwrk,1223
-plugwise/helper.py,sha256=nF1xJEw-frvuGMAydFAJrz_tN24Q3PcBnYNIwPeueZg,42817
-plugwise/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-plugwise/smile.py,sha256=tzE6yxWd8oOO3pK0g2bTw8WcuVQ9tM7tG3p0z7-LqWU,17815
-plugwise/util.py,sha256=9ld46KJHWFze2eUrVSgUYn0g3zNerlpboM0iUa0H3ak,7830
-plugwise/legacy/data.py,sha256=DsHR9xgiFDg_Vh_6ZpOskw8ZhNQ3CmwjstI3yiH6MEk,3048
-plugwise/legacy/helper.py,sha256=6-tYQMEXepE5rec-hn6lt2EeknADI3J8UFuBSLgu8dk,17878
-plugwise/legacy/smile.py,sha256=kU6eOh0c4Ao_S0yOJeggDuicRR7r3gScjYCEGJTMowA,10760
-plugwise-0.37.9.dist-info/LICENSE,sha256=mL22BjmXtg_wnoDnnaqps5_Bg_VGj_yHueX5lsKwbCc,1144
-plugwise-0.37.9.dist-info/METADATA,sha256=imJmtku4hd0Dnxjf7QKpc9BOUPNCNTfuQhjwVhj6FZc,8939
-plugwise-0.37.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-plugwise-0.37.9.dist-info/top_level.txt,sha256=MYOmktMFf8ZmX6_OE1y9MoCZFfY-L8DA0F2tA2IvE4s,9
-plugwise-0.37.9.dist-info/RECORD,,