PyViCare 2.58.0__tar.gz → 2.59.0__tar.gz

{pyvicare-2.58.0 → pyvicare-2.59.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyViCare
-Version: 2.58.0
+Version: 2.59.0
 Summary: Library to communicate with the Viessmann ViCare API.
 License: Apache-2.0
 License-File: LICENSE

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCare.py

@@ -9,7 +9,7 @@ from PyViCare.PyViCareOAuthManager import ViCareOAuthManager
 from PyViCare.PyViCareService import ViCareDeviceAccessor, ViCareService
 from PyViCare.PyViCareUtils import PyViCareInvalidDataError
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareAbstractOAuthManager.py

@@ -9,12 +9,20 @@ from PyViCare import Feature
 from PyViCare.PyViCareUtils import (PyViCareCommandError,
                                     PyViCareDeviceCommunicationError,
                                     PyViCareInternalServerError,
+                                    PyViCareNotPaidForError,
                                     PyViCareRateLimitError)
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 API_BASE_URL = 'https://api.viessmann-climatesolutions.com/iot/v2'
+AUTHORIZE_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/authorize'
+TOKEN_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/token'
+
+SCOPE_IOT = "IoT"
+SCOPE_USER = "User"
+SCOPE_OFFLINE_ACCESS = "offline_access"
+SCOPE_INTERNAL = "internal"
 
 
 class AbstractViCareOAuthManager:
@@ -41,6 +49,7 @@ class AbstractViCareOAuthManager:
             self.__handle_expired_token(response)
             self.__handle_rate_limit(response)
             self.__handle_device_communication_error(response)
+            self.__handle_not_paid_for(response)
             self.__handle_server_error(response)
             return response
         except TokenExpiredError:
@@ -65,6 +74,10 @@ class AbstractViCareOAuthManager:
         if ("errorType" in response and response["errorType"] == "DEVICE_COMMUNICATION_ERROR"):
             raise PyViCareDeviceCommunicationError(response)
 
+    def __handle_not_paid_for(self, response):
+        if ("errorType" in response and response["errorType"] == "PACKAGE_NOT_PAID_FOR"):
+            raise PyViCareNotPaidForError(response)
+
     def __handle_server_error(self, response):
         if ("statusCode" in response and response["statusCode"] >= 500):
             raise PyViCareInternalServerError(response)

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareBrowserOAuthManager.py

@@ -7,17 +7,21 @@ from http.server import BaseHTTPRequestHandler, HTTPServer
 from authlib.common.security import generate_token
 from authlib.integrations.requests_client import OAuth2Session
 
-from PyViCare.PyViCareAbstractOAuthManager import AbstractViCareOAuthManager
+from PyViCare.PyViCareAbstractOAuthManager import (
+    AUTHORIZE_URL,
+    SCOPE_IOT,
+    SCOPE_OFFLINE_ACCESS,
+    SCOPE_USER,
+    TOKEN_URL,
+    AbstractViCareOAuthManager,
+)
 from PyViCare.PyViCareUtils import (PyViCareBrowserOAuthTimeoutReachedError,
                                     PyViCareInvalidCredentialsError)
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-AUTHORIZE_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/authorize'
-TOKEN_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/token'
 REDIRECT_PORT = 51125
-VIESSMANN_SCOPE = ["IoT User", "offline_access"]
 AUTH_TIMEOUT = 60 * 3
 
 
@@ -50,7 +54,7 @@ class ViCareBrowserOAuthManager(AbstractViCareOAuthManager):
     def __execute_browser_authentication(self):
         redirect_uri = f"http://localhost:{REDIRECT_PORT}"
         oauth_session = OAuth2Session(
-            self.client_id, redirect_uri=redirect_uri, scope=VIESSMANN_SCOPE, code_challenge_method='S256')
+            self.client_id, redirect_uri=redirect_uri, scope=[SCOPE_IOT, SCOPE_USER, SCOPE_OFFLINE_ACCESS], code_challenge_method='S256')
         code_verifier = generate_token(48)
         authorization_url, _ = oauth_session.create_authorization_url(AUTHORIZE_URL, code_verifier=code_verifier)
 

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareCachedService.py

@@ -8,9 +8,11 @@ from PyViCare.PyViCareService import (ViCareDeviceAccessor, ViCareService,
 from PyViCare.PyViCareUtils import (PyViCareDeviceCommunicationError,
                                     PyViCareInvalidDataError,
                                     PyViCareInternalServerError,
+                                    PyViCareNotPaidForError,
+                                    PyViCareNotSupportedFeatureError,
                                     ViCareTimer)
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 
@@ -44,6 +46,11 @@ class ViCareCachedService(ViCareService):
 
                 try:
                     data = self.fetch_all_features()
+                except PyViCareNotPaidForError as e:
+                    logger.error("Viessmann API denied access (PACKAGE_NOT_PAID_FOR). Features unavailable: %s", e)
+                    if self.__cache is not None:
+                        return self.__cache
+                    raise PyViCareNotSupportedFeatureError("PACKAGE_NOT_PAID_FOR")
                 except (PyViCareDeviceCommunicationError, PyViCareInternalServerError) as e:
                     if self.__cache is not None:
                         logger.warning("API error, returning stale cache: %s", e)

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareDeviceConfig.py

@@ -17,7 +17,7 @@ from PyViCare.PyViCareElectricalEnergySystem import ElectricalEnergySystem
 from PyViCare.PyViCareGateway import Gateway
 from PyViCare.PyViCareVentilationDevice import VentilationDevice
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareOAuthManager.py

@@ -8,17 +8,20 @@ import requests
 from authlib.common.security import generate_token
 from authlib.integrations.requests_client import OAuth2Session
 
-from PyViCare.PyViCareAbstractOAuthManager import AbstractViCareOAuthManager
+from PyViCare.PyViCareAbstractOAuthManager import (
+    AUTHORIZE_URL,
+    SCOPE_IOT,
+    SCOPE_USER,
+    TOKEN_URL,
+    AbstractViCareOAuthManager,
+)
 from PyViCare.PyViCareUtils import (PyViCareInvalidConfigurationError,
                                     PyViCareInvalidCredentialsError)
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
-AUTHORIZE_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/authorize'
-TOKEN_URL = 'https://iam.viessmann-climatesolutions.com/idp/v3/token'
 REDIRECT_URI = "vicare://oauth-callback/everest"
-VIESSMANN_SCOPE = ["IoT User"]
 
 
 class ViCareOAuthManager(AbstractViCareOAuthManager):
@@ -55,7 +58,7 @@ class ViCareOAuthManager(AbstractViCareOAuthManager):
             oauth sessions object
         """
         oauth_session = OAuth2Session(
-            self.client_id, redirect_uri=REDIRECT_URI, scope=VIESSMANN_SCOPE, code_challenge_method='S256')
+            self.client_id, redirect_uri=REDIRECT_URI, scope=[SCOPE_IOT, SCOPE_USER], code_challenge_method='S256')
         code_verifier = generate_token(48)
         authorization_url, _ = oauth_session.create_authorization_url(AUTHORIZE_URL, code_verifier=code_verifier)
         logger.debug("Auth URL is: %s", authorization_url)

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareService.py

@@ -5,7 +5,7 @@ from typing import Any, List
 from PyViCare.PyViCareAbstractOAuthManager import AbstractViCareOAuthManager
 from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError
 
-logger = logging.getLogger('ViCare')
+logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
 
 def readFeature(entities, property_name):

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareUtils.py

@@ -105,6 +105,17 @@ class PyViCareInvalidDataError(Exception):
     pass
 
 
+class PyViCareNotPaidForError(Exception):
+    def __init__(self, response):
+        extended_payload = response.get("extendedPayload", {})
+        monetization = extended_payload.get("monetization", "Unknown")
+
+        msg = f"Feature not available: {monetization}"
+
+        super().__init__(self, msg)
+        self.message = msg
+
+
 class PyViCareDeviceCommunicationError(Exception):
     def __init__(self, response):
         extended_payload = response.get("extendedPayload", {})

{pyvicare-2.58.0 → pyvicare-2.59.0}/PyViCare/PyViCareVentilationDevice.py

@@ -230,10 +230,26 @@ class VentilationDevice(Device):
     def getSupplyTemperature(self) -> float:
         return float(self.getProperty("ventilation.sensors.temperature.supply")["properties"]["value"]["value"])
 
+    @handleNotSupported
+    def getExhaustTemperature(self) -> float:
+        return float(self.getProperty("ventilation.sensors.temperature.exhaust")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getExtractTemperature(self) -> float:
+        return float(self.getProperty("ventilation.sensors.temperature.extract")["properties"]["value"]["value"])
+
     @handleNotSupported
     def getSupplyHumidity(self) -> int:
         return int(self.getProperty("ventilation.sensors.humidity.supply")["properties"]["value"]["value"])
 
+    @handleNotSupported
+    def getExhaustHumidity(self) -> int:
+        return int(self.getProperty("ventilation.sensors.humidity.exhaust")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getExtractHumidity(self) -> int:
+        return int(self.getProperty("ventilation.sensors.humidity.extract")["properties"]["value"]["value"])
+
     @handleNotSupported
     def getVolatileOrganicCompounds(self) -> int:
         return int(self.getProperty("ventilation.sensors.volatileOrganicCompounds")["properties"]["value"]["value"])
@@ -282,6 +298,10 @@ class VentilationDevice(Device):
     def getHeatExchangerFrostProtectionActive(self) -> bool:
         return "off" != str(self.getProperty("ventilation.heatExchanger.frostprotection")["properties"]["status"]["value"])
 
+    @handleNotSupported
+    def getHeatRecoveryEfficiency(self) -> float:
+        return float(self.getProperty("ventilation.heating.recovery")["properties"]["value"]["value"])
+
     @handleNotSupported
     def getSupplyVolumeFlow(self) -> int:
         return int(self.getProperty("ventilation.volumeFlow.current.input")["properties"]["value"]["value"])

{pyvicare-2.58.0 → pyvicare-2.59.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PyViCare"
-version = "2.58.0"
+version = "2.59.0"
 description = "Library to communicate with the Viessmann ViCare API."
 authors = [
   "Simon Gillet <mail+pyvicare@gillet.ninja>"