Merge branch 'master' into feature/heating-schedule-setter

Author: CFenner

.github/workflows/format.yml

@@ -28,3 +28,19 @@ jobs:
             -exec sh -c 'mv $1 $1.tmp; jq ".data|=sort_by(.feature)" --sort-keys $1.tmp > $1; rm $1.tmp' shell {} ";"
       - name: 🔍 Verify
         run: git diff --name-only --exit-code
+
+  deprecations:
+    name: validate deprecation database
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v6.0.2
+      - name: Set up Python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: Update deprecation database
+        run: python check_deprecations.py --update
+      - name: Verify no changes
+        run: git diff --exit-code
+        if: always()

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: ["3.10", "3.11", "3.12"]
+        python: ["3.10", "3.11", "3.12", "3.13"]
     steps:
       - name: ⤵️ Check out code from GitHub
         uses: actions/checkout@v6.0.2

PyViCare/PyViCare.py

@@ -61,7 +61,7 @@ def __extract_devices(self):
 
                     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/PyViCareAbstractOAuthManager.py

@@ -7,6 +7,7 @@
 
 from PyViCare import Feature
 from PyViCare.PyViCareUtils import (PyViCareCommandError,
+                                    PyViCareDeviceCommunicationError,
                                     PyViCareInternalServerError,
                                     PyViCareRateLimitError)
 
@@ -39,6 +40,7 @@ def get(self, url: str) -> Any:
             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 @@ def __handle_rate_limit(self, response):
         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/PyViCareCachedService.py

@@ -5,7 +5,10 @@
 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 @@ def setProperty(self, property_name, action, data):
     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/PyViCareDeviceConfig.py

@@ -22,11 +22,14 @@
 
 
 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 @@ def getModel(self):
     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 @@ def get_raw_json(self):
         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/PyViCareFuelCell.py

@@ -23,6 +23,7 @@ def getAvailableBurners(self):
     def getReturnTemperature(self):
         return self.getProperty("heating.sensors.temperature.return")["properties"]["value"]["value"]
 
+    # Total power consumption:
     @handleNotSupported
     def getPowerConsumptionUnit(self):
         return self.getProperty("heating.power.consumption.total")["properties"]["day"]["unit"]
@@ -59,6 +60,7 @@ def getPowerConsumptionYears(self):
     def getPowerConsumptionThisYear(self):
         return self.getProperty('heating.power.consumption.total')['properties']['year']['value'][0]
 
+    # Power consumption for Heating:
     @handleNotSupported
     def getPowerConsumptionHeatingUnit(self):
         return self.getProperty("heating.power.consumption.heating")["properties"]["day"]["unit"]
@@ -95,6 +97,24 @@ def getPowerConsumptionHeatingYears(self):
     def getPowerConsumptionHeatingThisYear(self):
         return self.getProperty('heating.power.consumption.heating')['properties']['year']['value'][0]
 
+    # Power consumption for Domestic Hot Water:
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterUnit(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["unit"]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterToday(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisMonth(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisYear(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["year"]["value"][0]
+
+    # Gas consumption:
     @handleNotSupported
     def getGasConsumptionUnit(self):
         return self.getProperty("heating.gas.consumption.total")["properties"]["day"]["unit"]

PyViCare/PyViCareGazBoiler.py

@@ -103,9 +103,13 @@ def getBoilerTargetTemperature(self):
     def getDomesticHotWaterChargingLevel(self):
         return self.getProperty("heating.dhw.charging.level")["properties"]["value"]["value"]
 
+    # Total power consumption:
     @handleNotSupported
     def getPowerConsumptionUnit(self):
-        return self.getProperty("heating.power.consumption.total")["properties"]["day"]["unit"]
+        try :
+            return self.getProperty("heating.power.consumption.total")["properties"]["day"]["unit"]
+        except KeyError:
+            return self.getProperty("heating.power.consumption.total")["properties"]["unit"]["value"]
 
     @handleNotSupported
     def getPowerConsumptionDays(self):
@@ -139,6 +143,7 @@ def getPowerConsumptionYears(self):
     def getPowerConsumptionThisYear(self):
         return self.getProperty("heating.power.consumption.total")["properties"]["year"]["value"][0]
 
+    # Flow
     @handleNotSupported
     def getVolumetricFlowReturn(self):
         return self.getProperty("heating.sensors.volumetricFlow.allengra")["properties"]["value"]["value"]
@@ -204,6 +209,26 @@ def getGasSummaryConsumptionDomesticHotWaterLastYear(self):
 
     # Power consumption for Heating:
     @handleNotSupported
+    def getPowerConsumptionHeatingUnit(self):
+        try:
+            return self.getProperty("heating.power.consumption.heating")["properties"]["day"]["unit"]
+        except KeyError:
+            return self.getProperty("heating.power.consumption.heating")["properties"]["unit"]["value"]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingToday(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["day"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingThisMonth(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingThisYear(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["year"]["value"][0]
+
+    # Power summary consumption for Heating:
+    @handleNotSupported
     def getPowerSummaryConsumptionHeatingUnit(self):
         return self.getProperty("heating.power.consumption.summary.heating")["properties"]["currentDay"]["unit"]
 
@@ -233,6 +258,26 @@ def getPowerSummaryConsumptionHeatingLastYear(self):
 
     # Power consumption for Domestic Hot Water:
     @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterUnit(self):
+        try:
+            return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["unit"]
+        except KeyError:
+            return self.getProperty("heating.power.consumption.dhw")["properties"]["unit"]["value"]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterToday(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisMonth(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisYear(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["year"]["value"][0]
+
+    # Power summary consumption for Domestic Hot Water:
+    @handleNotSupported
     def getPowerSummaryConsumptionDomesticHotWaterUnit(self):
         return self.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentDay"]["unit"]
 

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
 
 
@@ -51,6 +53,23 @@ def getBufferTopTemperature(self):
 
     # Power consumption for Heating:
     @handleNotSupported
+    def getPowerConsumptionHeatingUnit(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["day"]["unit"]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingToday(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["day"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingThisMonth(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionHeatingThisYear(self):
+        return self.getProperty("heating.power.consumption.heating")["properties"]["year"]["value"][0]
+
+    # Power summary consumption for Heating:
+    @handleNotSupported
     def getPowerSummaryConsumptionHeatingUnit(self):
         return self.getProperty("heating.power.consumption.summary.heating")["properties"]["currentDay"]["unit"]
 
@@ -95,6 +114,7 @@ def getPowerConsumptionCoolingThisMonth(self):
     def getPowerConsumptionCoolingThisYear(self):
         return self.getProperty("heating.power.consumption.cooling")["properties"]["year"]["value"][0]
 
+    # Total power consumption:
     @handleNotSupported
     def getPowerConsumptionUnit(self):
         return self.getProperty("heating.power.consumption.total")["properties"]["day"]["unit"]
@@ -103,11 +123,32 @@ def getPowerConsumptionUnit(self):
     def getPowerConsumptionToday(self):
         return self.getProperty("heating.power.consumption.total")["properties"]["day"]["value"][0]
 
+    @handleNotSupported
+    def getPowerConsumptionThisMonth(self):
+        return self.getProperty("heating.power.consumption.total")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionThisYear(self):
+        return self.getProperty("heating.power.consumption.total")["properties"]["year"]["value"][0]
+
+    # Power consumption for Domestic Hot Water:
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterUnit(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["unit"]
+
     @handleNotSupported
     def getPowerConsumptionDomesticHotWaterToday(self):
         return self.getProperty("heating.power.consumption.dhw")["properties"]["day"]["value"][0]
 
-    # Power consumption for Domestic Hot Water:
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisMonth(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["month"]["value"][0]
+
+    @handleNotSupported
+    def getPowerConsumptionDomesticHotWaterThisYear(self):
+        return self.getProperty("heating.power.consumption.dhw")["properties"]["year"]["value"][0]
+
+    # Power summary consumption for Domestic Hot Water:
     @handleNotSupported
     def getPowerSummaryConsumptionDomesticHotWaterUnit(self):
         return self.getProperty("heating.power.consumption.summary.dhw")["properties"]["currentDay"]["unit"]
@@ -320,6 +361,39 @@ def getHeatingRodPowerConsumptionHeatingThisYear(self) -> float:
     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):