PyViCare 2.55.1__tar.gz → 2.57.0__tar.gz

{pyvicare-2.55.1 → pyvicare-2.57.0}/PKG-INFO

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

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCare.py

@@ -61,7 +61,7 @@ class PyViCare:
 
                     logger.info("Device found: %s", device.modelId)
 
-                    yield PyViCareDeviceConfig(service, device.id, device.modelId, device.status)
+                    yield PyViCareDeviceConfig(service, device.id, device.modelId, device.status, device.deviceType, device.roles)
 
 
 class DictWrap(object):

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareAbstractOAuthManager.py

@@ -7,6 +7,7 @@ from authlib.integrations.requests_client import OAuth2Session
 
 from PyViCare import Feature
 from PyViCare.PyViCareUtils import (PyViCareCommandError,
+                                    PyViCareDeviceCommunicationError,
                                     PyViCareInternalServerError,
                                     PyViCareRateLimitError)
 
@@ -39,6 +40,7 @@ class AbstractViCareOAuthManager:
             logger.debug("Response to get request: %s", response)
             self.__handle_expired_token(response)
             self.__handle_rate_limit(response)
+            self.__handle_device_communication_error(response)
             self.__handle_server_error(response)
             return response
         except TokenExpiredError:
@@ -59,6 +61,10 @@ class AbstractViCareOAuthManager:
         if ("statusCode" in response and response["statusCode"] == 429):
             raise PyViCareRateLimitError(response)
 
+    def __handle_device_communication_error(self, response):
+        if ("errorType" in response and response["errorType"] == "DEVICE_COMMUNICATION_ERROR"):
+            raise PyViCareDeviceCommunicationError(response)
+
     def __handle_server_error(self, response):
         if ("statusCode" in response and response["statusCode"] >= 500):
             raise PyViCareInternalServerError(response)

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareCachedService.py

@@ -5,7 +5,10 @@ from typing import Any, List
 from PyViCare.PyViCareAbstractOAuthManager import AbstractViCareOAuthManager
 from PyViCare.PyViCareService import (ViCareDeviceAccessor, ViCareService,
                                       readFeature)
-from PyViCare.PyViCareUtils import PyViCareInvalidDataError, ViCareTimer
+from PyViCare.PyViCareUtils import (PyViCareDeviceCommunicationError,
+                                    PyViCareInvalidDataError,
+                                    PyViCareInternalServerError,
+                                    ViCareTimer)
 
 logger = logging.getLogger('ViCare')
 logger.addHandler(logging.NullHandler())
@@ -33,13 +36,20 @@ class ViCareCachedService(ViCareService):
     def __get_or_update_cache(self):
         with self.__lock:
             if self.is_cache_invalid():
-                # we always sett the cache time before we fetch the data
+                # we always set the cache time before we fetch the data
                 # to avoid consuming all the api calls if the api is down
                 # see https://github.com/home-assistant/core/issues/67052
                 # we simply return the old cache in this case
                 self.__cacheTime = ViCareTimer().now()
 
-                data = self.fetch_all_features()
+                try:
+                    data = self.fetch_all_features()
+                except (PyViCareDeviceCommunicationError, PyViCareInternalServerError) as e:
+                    if self.__cache is not None:
+                        logger.warning("API error, returning stale cache: %s", e)
+                        return self.__cache
+                    raise
+
                 if "data" not in data:
                     logger.error("Missing 'data' property when fetching data.")
                     raise PyViCareInvalidDataError(data)

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareDeviceConfig.py

@@ -22,11 +22,14 @@ logger.addHandler(logging.NullHandler())
 
 
 class PyViCareDeviceConfig:
-    def __init__(self, service, device_id, device_model, status):
+    # pylint: disable=too-many-arguments,too-many-positional-arguments
+    def __init__(self, service, device_id, device_model, status, device_type=None, roles=None):
         self.service = service
         self.device_id = device_id
         self.device_model = device_model
         self.status = status
+        self.device_type = device_type
+        self.roles = roles if roles is not None else []
 
     def asGeneric(self):
         return HeatingDevice(self.service)
@@ -85,6 +88,15 @@ class PyViCareDeviceConfig:
     def isOnline(self):
         return self.status == "Online"
 
+    def getDeviceType(self):
+        return self.device_type
+
+    def getRoles(self):
+        return self.roles
+
+    def isGateway(self):
+        return self.service._isGateway()  # pylint: disable=protected-access
+
     # see: https://vitodata300.viessmann.com/vd300/ApplicationHelp/VD300/1031_de_DE/Ger%C3%A4teliste.html
     def asAutoDetectDevice(self):
         device_types = [
@@ -122,12 +134,25 @@ class PyViCareDeviceConfig:
         return self.service.fetch_all_features()
 
     def dump_secure(self, flat=False):
+        raw_data = self.get_raw_json()
+        device_info = {
+            "id": self.device_id,
+            "modelId": self.device_model,
+            "type": self.device_type,
+            "status": self.status,
+            "roles": self.roles
+        }
+        output = {
+            "device": device_info,
+            "data": raw_data['data']
+        }
+
         if flat:
-            inner = ',\n'.join([json.dumps(x, sort_keys=True) for x in self.get_raw_json()['data']])
-            outer = json.dumps({'data': ['placeholder']}, indent=0)
+            inner = ',\n'.join([json.dumps(x, sort_keys=True) for x in output['data']])
+            outer = json.dumps({'device': output['device'], 'data': ['placeholder']}, indent=0, sort_keys=True)
             dumpJSON = outer.replace('"placeholder"', inner)
         else:
-            dumpJSON = json.dumps(self.get_raw_json(), indent=4, sort_keys=True)
+            dumpJSON = json.dumps(output, indent=4, sort_keys=True)
 
         def repl(m):
             return m.group(1) + ('#' * len(m.group(2))) + m.group(3)

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareFuelCell.py

@@ -192,9 +192,9 @@ class FuelCell(HeatingDevice):
         return self.getProperty("heating.fuelCell.power.production")["properties"]["year"]["value"][0]
 
     @handleNotSupported
-    def getFuelCellOperatingPhase(self):
+    def getFuelCellOperatingPhase(self) -> str:
         # Returns current operating phase as string, e.g. "standby" or "generation"
-        return self.getProperty("heating.fuelCell.operating.phase")["properties"]["value"]["value"]
+        return str(self.getProperty("fuelCell.operating.phase")["properties"]["value"]["value"])
 
     @handleNotSupported
     def getFuelCellPowerProductionCurrentUnit(self):
@@ -257,39 +257,39 @@ class FuelCell(HeatingDevice):
         return self.getProperty("heating.power.sold.cumulative")["properties"]["value"]["value"]
 
     @handleNotSupported
-    def getFuelCellFlowReturnTemperatureUnit(self):
+    def getFuelCellFlowReturnTemperatureUnit(self) -> str:
         # Returns flow return temperature unit, e.g. "celsius"
-        return self.getProperty("heating.fuelCell.sensors.temperature.return")["properties"]["value"]["unit"]
+        return str(self.getProperty("fuelCell.sensors.temperature.return")["properties"]["value"]["unit"])
 
     @handleNotSupported
-    def getFuelCellFlowReturnTemperature(self):
+    def getFuelCellFlowReturnTemperature(self) -> float:
         # Returns flow return temperature at the fuel cell as float
-        return self.getProperty("heating.fuelCell.sensors.temperature.return")["properties"]["value"]["value"]
+        return float(self.getProperty("fuelCell.sensors.temperature.return")["properties"]["value"]["value"])
 
     @handleNotSupported
-    def getFuelCellFlowSupplyTemperatureUnit(self):
+    def getFuelCellFlowSupplyTemperatureUnit(self) -> str:
         # Returns flow supply temperature unit, e.g. "celsius"
-        return self.getProperty("heating.fuelCell.sensors.temperature.supply")["properties"]["value"]["unit"]
+        return str(self.getProperty("fuelCell.sensors.temperature.supply")["properties"]["value"]["unit"])
 
     @handleNotSupported
-    def getFuelCellFlowSupplyTemperature(self):
+    def getFuelCellFlowSupplyTemperature(self) -> float:
         # Returns flow supply temperature at the fuel cell as float
-        return self.getProperty("heating.fuelCell.sensors.temperature.supply")["properties"]["value"]["value"]
+        return float(self.getProperty("fuelCell.sensors.temperature.supply")["properties"]["value"]["value"])
 
     @handleNotSupported
-    def getFuelCellOperationHours(self):
+    def getFuelCellOperationHours(self) -> int:
         # Returns the operation hours of the fuel cell
-        return self.getProperty("heating.fuelCell.statistics")["properties"]["operationHours"]["value"]
+        return int(self.getProperty("fuelCell.statistics")["properties"]["operationHours"]["value"])
 
     @handleNotSupported
-    def getFuelCellProductionHours(self):
+    def getFuelCellProductionHours(self) -> int:
         # Returns the production hours of the fuel cell
-        return self.getProperty("heating.fuelCell.statistics")["properties"]["productionHours"]["value"]
+        return int(self.getProperty("fuelCell.statistics")["properties"]["productionHours"]["value"])
 
     @handleNotSupported
-    def getFuelCellProductionStarts(self):
+    def getFuelCellProductionStarts(self) -> int:
         # Returns the number of production starts of the fuel cell
-        return self.getProperty("heating.fuelCell.statistics")["properties"]["productionStarts"]["value"]
+        return int(self.getProperty("fuelCell.statistics")["properties"]["productionStarts"]["value"])
 
     @handleNotSupported
     def getFuelCellGasConsumptionUnit(self):

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareGateway.py

@@ -9,5 +9,5 @@ class Gateway(Device):
         return self.getProperty("gateway.devices")["gatewayId"]
 
     @handleNotSupported
-    def getWifiSignalStrength(self):
-        return self.getProperty("gateway.wifi")["properties"]["strength"]["value"]
+    def getWifiSignalStrength(self) -> int:
+        return int(self.getProperty("gateway.wifi")["properties"]["strength"]["value"])

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareHeatPump.py

@@ -1,9 +1,11 @@
 from __future__ import annotations
+from contextlib import suppress
 from typing import Any, List
 from deprecated import deprecated
 
 from PyViCare.PyViCareHeatingDevice import HeatingDevice, HeatingDeviceWithComponent
-from PyViCare.PyViCareUtils import handleAPICommandErrors, handleNotSupported
+from PyViCare.PyViCareUtils import (PyViCareNotSupportedFeatureError,
+                                    handleAPICommandErrors, handleNotSupported)
 from PyViCare.PyViCareVentilationDevice import VentilationDevice
 
 
@@ -34,6 +36,13 @@ class HeatPump(HeatingDevice, VentilationDevice):
     def getEvaporator(self, evaporator) -> Evaporator:
         return Evaporator(self, evaporator)
 
+    @property
+    def inverters(self) -> List[Inverter]:
+        return [self.getInverter(x) for x in self.getAvailableCompressors()]
+
+    def getInverter(self, inverter) -> Inverter:
+        return Inverter(self, inverter)
+
     @handleNotSupported
     def getBufferMainTemperature(self):
         return self.getProperty("heating.bufferCylinder.sensors.temperature.main")["properties"]['value']['value']
@@ -313,6 +322,39 @@ class HeatPump(HeatingDevice, VentilationDevice):
     def getHeatingRodPowerConsumptionTotalThisYear(self) -> float:
         return float(self.getProperty("heating.heatingRod.power.consumption.total")["properties"]["year"]["value"][0])
 
+    # Cooling circuits
+    @property
+    def coolingCircuits(self) -> List[CoolingCircuit]:
+        return [self.getCoolingCircuit(x) for x in self.getAvailableCoolingCircuits()]
+
+    def getCoolingCircuit(self, circuit) -> CoolingCircuit:
+        return CoolingCircuit(self, circuit)
+
+    def getAvailableCoolingCircuits(self):
+        """Detect available cooling circuits (0, 1, 2, etc.)."""
+        available = []
+        for circuit in ['0', '1', '2', '3']:
+            with suppress(KeyError, PyViCareNotSupportedFeatureError):
+                if self.getProperty(f"heating.coolingCircuits.{circuit}.type") is not None:
+                    available.append(circuit)
+        return available
+
+
+class CoolingCircuit(HeatingDeviceWithComponent):
+    """Cooling circuit component for heat pumps with cooling capability."""
+
+    @property
+    def circuit(self) -> str:
+        return self.component
+
+    @handleNotSupported
+    def getType(self) -> str:
+        return str(self.getProperty(f"heating.coolingCircuits.{self.circuit}.type")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getReverseActive(self) -> bool:
+        return bool(self.getProperty(f"heating.coolingCircuits.{self.circuit}.reverse")["properties"]["active"]["value"])
+
 
 class Compressor(HeatingDeviceWithComponent):
 
@@ -356,6 +398,10 @@ class Compressor(HeatingDeviceWithComponent):
     def getPhase(self):
         return self.getProperty(f"heating.compressors.{self.compressor}")["properties"]["phase"]["value"]
 
+    @handleNotSupported
+    def getSpeed(self) -> int:
+        return int(self.getProperty(f"heating.compressors.{self.compressor}.speed.current")["properties"]["value"]["value"])
+
     @handleNotSupported
     def getHeatProductionCurrent(self) -> float:
         return float(self.getProperty(f"heating.compressors.{self.compressor}.heat.production.current")["properties"]["value"]["value"])
@@ -480,6 +526,23 @@ class Compressor(HeatingDeviceWithComponent):
         # Shows the inlet temperature of the compressor.
         return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.inlet")["properties"]["value"]["value"])
 
+    @handleNotSupported
+    def getOilTemperature(self) -> float:
+        # Shows the oil temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.oil")["properties"]["value"]["value"])
+
+    def getMotorChamberTemperature(self) -> float:
+        # Shows the motor chamber temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.motorChamber")["properties"]["value"]["value"])
+
+    def getAmbientTemperature(self) -> float:
+        # Shows the ambient temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.ambient")["properties"]["value"]["value"])
+
+    def getOverheatTemperature(self) -> float:
+        # Shows the overheat temperature of the compressor.
+        return float(self.getProperty(f"heating.compressors.{self.compressor}.sensors.temperature.overheat")["properties"]["value"]["value"])
+
 
 class Evaporator(HeatingDeviceWithComponent):
 
@@ -581,3 +644,22 @@ class Condensor(HeatingDeviceWithComponent):
     def getLiquidTemperature(self) -> float:
         # Shows the liquid temperature of the condenser.
         return float(self.getProperty(f"heating.condensors.{self.condensor}.sensors.temperature.liquid")["properties"]["value"]["value"])
+
+
+class Inverter(HeatingDeviceWithComponent):
+
+    @property
+    def inverter(self) -> str:
+        return self.component
+
+    @handleNotSupported
+    def getCurrent(self) -> float:
+        return float(self.getProperty(f"heating.inverters.{self.inverter}.sensors.power.current")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getPower(self) -> float:
+        return float(self.getProperty(f"heating.inverters.{self.inverter}.sensors.power.output")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getTemperature(self) -> float:
+        return float(self.getProperty(f"heating.inverters.{self.inverter}.sensors.temperature.powerModule")["properties"]["value"]["value"])

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareHeatingDevice.py

@@ -36,6 +36,10 @@ class HeatingDevice(Device):
     Note that currently, a new token is generated for each run.
     """
 
+    @handleNotSupported
+    def getWifiSignalStrength(self) -> int:
+        return int(self.getProperty("tcu.wifi")["properties"]["strength"]["value"])
+
     @property
     def circuits(self) -> List[Any]:
         return list([self.getCircuit(x) for x in self.getAvailableCircuits()])
@@ -194,6 +198,16 @@ class HeatingDevice(Device):
         return self.setProperty("heating.dhw.temperature.temp2", "setTargetTemperature",
                                         {"temperature": int(temperature)})
 
+    @handleNotSupported
+    def getDomesticHotWaterOperatingModes(self):
+        return self.getProperty("heating.dhw.operating.modes.active")[
+            "commands"]["setMode"]["params"]["mode"]["constraints"]["enum"]
+
+    @handleNotSupported
+    def getDomesticHotWaterActiveOperatingMode(self):
+        return self.getProperty("heating.dhw.operating.modes.active")[
+            "properties"]["value"]["value"]
+
     @handleAPICommandErrors
     def setDomesticHotWaterOperatingMode(self, mode):
         return self.setProperty("heating.dhw.operating.modes.active", "setMode",

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareUtils.py

@@ -105,6 +105,18 @@ class PyViCareInvalidDataError(Exception):
     pass
 
 
+class PyViCareDeviceCommunicationError(Exception):
+    def __init__(self, response):
+        extended_payload = response.get("extendedPayload", {})
+        reason = extended_payload.get("reason", "Unknown")
+
+        msg = f'Device communication error. Reason: {reason}'
+
+        super().__init__(self, msg)
+        self.message = msg
+        self.reason = reason
+
+
 class PyViCareRateLimitError(Exception):
 
     def __init__(self, response):

{pyvicare-2.55.1 → pyvicare-2.57.0}/PyViCare/PyViCareVentilationDevice.py

@@ -12,6 +12,10 @@ class VentilationDevice(Device):
     Note that currently, a new token is generated for each run.
     """
 
+    @handleNotSupported
+    def getWifiSignalStrength(self) -> int:
+        return int(self.getProperty("tcu.wifi")["properties"]["strength"]["value"])
+
     @handleNotSupported
     def getVentilationDemand(self) -> str:
         return str(self.getProperty("ventilation.operating.state")["properties"]["demand"]["value"])
@@ -285,3 +289,19 @@ class VentilationDevice(Device):
     @handleNotSupported
     def getExhaustVolumeFlow(self) -> int:
         return int(self.getProperty("ventilation.volumeFlow.current.output")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getConfiguredLevelOneVolumeFlow(self) -> int:
+        return int(self.getProperty("ventilation.levels.levelOne")["properties"]["volumeFlow"]["value"])
+
+    @handleNotSupported
+    def getConfiguredLevelTwoVolumeFlow(self) -> int:
+        return int(self.getProperty("ventilation.levels.levelTwo")["properties"]["volumeFlow"]["value"])
+
+    @handleNotSupported
+    def getConfiguredLevelThreeVolumeFlow(self) -> int:
+        return int(self.getProperty("ventilation.levels.levelThree")["properties"]["volumeFlow"]["value"])
+
+    @handleNotSupported
+    def getConfiguredLevelFourVolumeFlow(self) -> int:
+        return int(self.getProperty("ventilation.levels.levelFour")["properties"]["volumeFlow"]["value"])

{pyvicare-2.55.1 → pyvicare-2.57.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PyViCare"
-version = "2.55.1"
+version = "2.57.0"
 description = "Library to communicate with the Viessmann ViCare API."
 authors = [
   "Simon Gillet <mail+pyvicare@gillet.ninja>"
@@ -26,6 +26,7 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3",
   "License :: OSI Approved :: Apache Software License",
   "Topic :: Software Development :: Libraries :: Python Modules",
@@ -51,7 +52,7 @@ mypy = "^1.11.2"
 pylint = "^4.0.0"
 pytest = "^9.0.0"
 pytest-cov = "^7.0.0"
-ruff = "^0.14.0"
+ruff = "^0.15.0"
 types-deprecated = "^1.2.15.20241117"
 types-requests = ">=2.31"