PyViCare 2.61.0__tar.gz → 2.62.0__tar.gz

{pyvicare-2.61.0 → pyvicare-2.62.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyViCare
-Version: 2.61.0
+Version: 2.62.0
 Summary: Library to communicate with the Viessmann ViCare API.
 License: Apache-2.0
 License-File: LICENSE
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: authlib (>1.2.0)
-Requires-Dist: deprecated (>=1.2.15,<2.0.0)
+Requires-Dist: deprecated (>=1.3.0,<2.0.0)
 Requires-Dist: requests (>=2.31.0)
 Project-URL: Bug Tracker, https://github.com/openviess/PyViCare/issues
 Project-URL: Changelog, https://github.com/openviess/PyViCare/releases

{pyvicare-2.61.0 → pyvicare-2.62.0}/PyViCare/PyViCareCachedServiceBase.py

@@ -34,6 +34,11 @@ class ViCareCachedServiceBase(ViCareService):
         entities = self._extract_entities(data, accessor)
         return readFeature(entities, property_name)
 
+    def fetch_all_features(self, accessor: ViCareDeviceAccessor) -> Any:
+        # cached, so a caller refreshing with fetch_all_features() warms the
+        # cache the following getProperty calls read from
+        return self._get_or_update_cache(accessor)
+
     def setProperty(self, accessor: ViCareDeviceAccessor, property_name: str, action: str, data: Any) -> Any:
         response = super().setProperty(accessor, property_name, action, data)
         self.clear_cache()

{pyvicare-2.61.0 → pyvicare-2.62.0}/PyViCare/PyViCareCachedServiceViaGateway.py

@@ -28,7 +28,3 @@ class ViCareCachedServiceViaGateway(ViCareCachedServiceBase, ViCareServiceViaGat
 
     def _extract_entities(self, data: dict, accessor: ViCareDeviceAccessor) -> list[dict[str, Any]]:
         return filter_features_for_device(data["data"], accessor.device_id)
-
-    def fetch_all_features(self, accessor: ViCareDeviceAccessor) -> Any:
-        # cached too, so per-device coordinators share one bulk fetch
-        return self._get_or_update_cache(accessor)

{pyvicare-2.61.0 → pyvicare-2.62.0}/PyViCare/PyViCareDeviceConfig.py

@@ -20,6 +20,7 @@ from PyViCare.PyViCareService import (ViCareDeviceAccessor, ViCareService,
                                       hasRoles, is_gateway_role)
 from PyViCare.PyViCareUtils import PyViCareNotPaidForError
 from PyViCare.PyViCareVentilationDevice import VentilationDevice
+from PyViCare.PyViCareWaterTreatment import WaterTreatment
 
 logger = logging.getLogger(__name__)
 logger.addHandler(logging.NullHandler())
@@ -84,6 +85,9 @@ class PyViCareDeviceConfig:
     def asVentilation(self):
         return VentilationDevice(self.accessor, self.service, self.roles)
 
+    def asWaterTreatment(self):
+        return WaterTreatment(self.accessor, self.service, self.roles)
+
     def getConfig(self):
         return self.accessor
 
@@ -127,6 +131,7 @@ class PyViCareDeviceConfig:
             (self.asRoomControl, r"E3_RoomControl|Smart_RoomControl", ["type:virtual;smartRoomControl"]),
             (self.asRoomSensor, r"E3_RoomSensor", ["type:climateSensor"]),
             (self.asRepeater, r"E3_Repeater", ["type:repeater"]),
+            (self.asWaterTreatment, r"VitosetAqua", ["type:waterTreatment"]),
             (self.asGateway, r"E3_TCU41_x04", ["type:gateway;TCU100"]),
             (self.asGateway, r"E3_TCU19_x05", ["type:gateway;TCU200"]),
             (self.asGateway, r"E3_TCU10_x07", ["type:gateway;TCU300"]),

pyvicare-2.62.0/PyViCare/PyViCareWaterTreatment.py

@@ -0,0 +1,141 @@
+from contextlib import suppress
+from typing import Any, List, Optional
+
+from PyViCare.PyViCareDevice import Device
+from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleNotSupported
+
+
+_LEAK_SENSOR_SLOTS = 5
+
+
+class WaterTreatment(Device):
+    """Viessmann Vitoset Aqua water treatment station.
+
+    Combines water softener, leak detection (up to 5 sensors), consumption metering
+    and main shutoff valve in one device.
+    """
+
+    # --- Softener ---
+
+    @handleNotSupported
+    def getSaltDaysRemaining(self) -> int:
+        return int(self.getProperty("water.softener.salt.level.days")["properties"]["remaining"]["value"])
+
+    @handleNotSupported
+    def getLowSaltAlertDays(self) -> int:
+        return int(self.getProperty("water.softener.configuration.lowSaltAlert")["properties"]["lowLevelAlertDays"]["value"])
+
+    # --- Consumption ---
+
+    @handleNotSupported
+    def getCurrentFlow(self) -> float:
+        return float(self.getProperty("water.consumption.flow.current")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getMaxFlow(self) -> float:
+        return float(self.getProperty("water.consumption.flow.max")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getTotalConsumption(self) -> int:
+        return int(self.getProperty("water.consumption.summary")["properties"]["total"]["value"])
+
+    # --- Leak Detection ---
+
+    @property
+    def leakSensors(self) -> List["LeakSensor"]:
+        return [LeakSensor(self, slot) for slot in self.getAvailableLeakSensorSlots()]
+
+    def getAvailableLeakSensorSlots(self) -> List[int]:
+        available: List[int] = []
+        for slot in range(_LEAK_SENSOR_SLOTS):
+            with suppress(PyViCareNotSupportedFeatureError):
+                feature = self.getProperty(f"water.leakDetection.sensors.leakage.{slot}")
+                if feature.get("isEnabled"):
+                    available.append(slot)
+        return available
+
+    @handleNotSupported
+    def getFlowAlertMaxDuration(self) -> int:
+        return int(self.getProperty("water.leakDetection.configuration.flowAlert")["properties"]["maxDuration"]["value"])
+
+    @handleNotSupported
+    def getFlowAlertMaxFlow(self) -> float:
+        return float(self.getProperty("water.leakDetection.configuration.flowAlert")["properties"]["maxFlow"]["value"])
+
+    # --- Shutoff Valve ---
+
+    @handleNotSupported
+    def getShutoffPosition(self) -> str:
+        return str(self.getProperty("water.valves.shutoff.position")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getShutoffMotorState(self) -> str:
+        return str(self.getProperty("water.valves.shutoff.motor")["properties"]["state"]["value"])
+
+    @handleNotSupported
+    def getHolidayModeActive(self) -> bool:
+        return bool(self.getProperty("water.valves.shutoff.holiday")["properties"]["active"]["value"])
+
+
+class LeakSensor:
+    """Single wireless leakage sensor connected to a Vitoset Aqua."""
+
+    def __init__(self, device: WaterTreatment, slot: int) -> None:
+        self.service = device.service
+        self.slot = slot
+        self.device = device
+
+    @property
+    def id(self) -> int:
+        return self.slot
+
+    def getProperty(self, property_name: str) -> Any:
+        return self.device.getProperty(property_name)
+
+    @handleNotSupported
+    def getStatus(self) -> str:
+        return str(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}")["properties"]["status"]["value"])
+
+    @handleNotSupported
+    def getLeakDetected(self) -> bool:
+        return bool(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getSensorId(self) -> str:
+        return str(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.id")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getName(self) -> str:
+        return str(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.name")["properties"]["name"]["value"])
+
+    @handleNotSupported
+    def getBatteryPercent(self) -> int:
+        return int(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.battery")["properties"]["level"]["value"])
+
+    @handleNotSupported
+    def getRssi(self) -> int:
+        return int(self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.rssi")["properties"]["value"]["value"])
+
+    def getHardwareVersion(self) -> Optional[dict[str, int]]:
+        try:
+            feature = self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.version.hardware")
+        except PyViCareNotSupportedFeatureError:
+            return None
+        return self._versionFields(feature.get("properties") or {})
+
+    def getSoftwareVersion(self) -> Optional[dict[str, int]]:
+        try:
+            feature = self.getProperty(f"water.leakDetection.sensors.leakage.{self.slot}.version.software")
+        except PyViCareNotSupportedFeatureError:
+            return None
+        return self._versionFields(feature.get("properties") or {})
+
+    @staticmethod
+    def _versionFields(props: dict[str, Any]) -> Optional[dict[str, int]]:
+        if not props:
+            return None
+        return {
+            field: int(props[field]["value"])
+            for field in ("build", "family", "revision", "version")
+            if field in props
+        }

{pyvicare-2.61.0 → pyvicare-2.62.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PyViCare"
-version = "2.61.0"
+version = "2.62.0"
 description = "Library to communicate with the Viessmann ViCare API."
 authors = [
   "Simon Gillet <mail+pyvicare@gillet.ninja>"
@@ -45,15 +45,15 @@ Changelog = "https://github.com/openviess/PyViCare/releases"
 authlib = ">1.2.0"
 python = "^3.10"
 requests = ">=2.31.0"
-deprecated = "^1.2.15"
+deprecated = "^1.3.0"
 
 [tool.poetry.group.dev.dependencies]
-codespell = "2.4.2"
-mypy = "2.3.0"
-pylint = "4.0.6"
+codespell = "2.4.3"
+mypy = "2.3.1"
+pylint = "4.0.7"
 pytest = "9.1.1"
 pytest-cov = "7.1.0"
-ruff = "0.15.21"
+ruff = "0.15.22"
 types-deprecated = "^1.2.15.20241117"
 types-requests = ">=2.31"