PyViCare 2.51.0__tar.gz → 2.53.0__tar.gz

{pyvicare-2.51.0 → pyvicare-2.53.0}/PKG-INFO

@@ -1,8 +1,9 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: PyViCare
-Version: 2.51.0
+Version: 2.53.0
 Summary: Library to communicate with the Viessmann ViCare API.
 License: Apache-2.0
+License-File: LICENSE
 Keywords: viessmann,vicare,api
 Author: Simon Gillet
 Author-email: mail+pyvicare@gillet.ninja
@@ -19,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 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)
@@ -208,3 +210,22 @@ To make the test data comparable with future updates, it must be sorted. No worr
 jq ".data|=sort_by(.feature)" --sort-keys testData.json > testDataSorted.json
 ```
 
+## Testing
+
+### Home Assistant
+
+To test a certain change in Home Assistant, one needs to have a `ViCare` integration installed as a custom component.
+Change the dependency in the `manifest.json` to point to a GitHub branch or commit SHA:
+
+```json
+  "requirements": [
+    "PyViCare@git+https://github.com/openviess/PyViCare.git@<branchname>"
+  ],
+```
+
+To install `ViCare` as a custom component, one can use the terminal addon to install the changes from a certain Home Assistant PR:
+
+```sh
+curl -o- -L https://gist.githubusercontent.com/bdraco/43f8043cb04b9838383fd71353e99b18/raw/core_integration_pr | bash /dev/stdin -d vicare -p <pr-number>
+```
+

{pyvicare-2.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareDevice.py

@@ -1,7 +1,7 @@
 from typing import Any
 
 from PyViCare.PyViCareService import ViCareService
-from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleNotSupported
+from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleAPICommandErrors, handleNotSupported
 
 
 class Device:
@@ -42,3 +42,36 @@ class Device:
             return self.service.getProperty(deviceType)["isEnabled"] and self.service.getProperty(deviceType)["properties"]["active"]["value"]
         except PyViCareNotSupportedFeatureError:
             return False
+
+
+class ZigbeeDevice(Device):
+
+    @handleNotSupported
+    def getSerial(self) -> str:
+        return str(self.service.getProperty("device.zigbee.parent.id")["deviceId"])
+
+    @handleNotSupported
+    def getZigbeeParentID(self) -> str:
+        return str(self.service.getProperty("device.zigbee.parent.id")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getZigbeeSignalStrength(self) -> int:
+        return int(self.service.getProperty("device.zigbee.lqi")["properties"]["strength"]["value"])
+
+    @handleNotSupported
+    def getName(self) -> str:
+        return str(self.service.getProperty("device.name")["properties"]["name"]["value"])
+
+    @handleAPICommandErrors
+    def setName(self, name: str) -> None:
+        self.service.setProperty("device.name", "setName", {'name': name})
+
+    @handleNotSupported
+    def getIdentification(self) -> bool:
+        return bool(self.service.getProperty("device.identification")["properties"]["triggered"]["value"])
+
+class ZigbeeBatteryDevice(ZigbeeDevice):
+
+    @handleNotSupported
+    def getBatteryLevel(self) -> int:
+        return int(self.service.getProperty("device.power.battery")["properties"]["level"]["value"])

{pyvicare-2.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareDeviceConfig.py

@@ -2,6 +2,7 @@ import json
 import logging
 import re
 
+from PyViCare.PyViCareFloorHeating import FloorHeating, FloorHeatingChannel
 from PyViCare.PyViCareFuelCell import FuelCell
 from PyViCare.PyViCareGazBoiler import GazBoiler
 from PyViCare.PyViCareHeatingDevice import HeatingDevice
@@ -11,6 +12,7 @@ from PyViCare.PyViCareOilBoiler import OilBoiler
 from PyViCare.PyViCarePelletsBoiler import PelletsBoiler
 from PyViCare.PyViCareRadiatorActuator import RadiatorActuator
 from PyViCare.PyViCareRoomSensor import RoomSensor
+from PyViCare.PyViCareRepeater import Repeater
 from PyViCare.PyViCareElectricalEnergySystem import ElectricalEnergySystem
 from PyViCare.PyViCareGateway import Gateway
 from PyViCare.PyViCareVentilationDevice import VentilationDevice
@@ -50,9 +52,18 @@ class PyViCareDeviceConfig:
     def asRadiatorActuator(self):
         return RadiatorActuator(self.service)
 
+    def asFloorHeating(self):
+        return FloorHeating(self.service)
+
+    def asFloorHeatingChannel(self):
+        return FloorHeatingChannel(self.service)
+
     def asRoomSensor(self):
         return RoomSensor(self.service)
 
+    def asRepeater(self):
+        return Repeater(self.service)
+
     def asElectricalEnergySystem(self):
         return ElectricalEnergySystem(self.service)
 
@@ -88,7 +99,10 @@ class PyViCareDeviceConfig:
             (self.asVentilation, r"E3_ViAir", ["type:ventilation;central"]),
             (self.asVentilation, r"E3_VitoPure", ["type:ventilation;purifier"]),
             (self.asRadiatorActuator, r"E3_RadiatorActuator", ["type:radiator"]),
+            (self.asFloorHeating, r"Smart_zigbee_fht_main|E3_FloorHeatingCircuitDistributorBox", ["type:fhtMain"]),
+            (self.asFloorHeatingChannel, r"Smart_zigbee_fht_channel", ["type:fhtChannel"]),
             (self.asRoomSensor, r"E3_RoomSensor", ["type:climateSensor"]),
+            (self.asRepeater, r"E3_Repeater", ["type:repeater"]),
             (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.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareElectricalEnergySystem.py

@@ -88,6 +88,42 @@ class ElectricalEnergySystem(Device):
             "value"
         ]["unit"]
 
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedUnit(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["currentDay"]["unit"]
+
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedCurrentDay(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["currentDay"]["value"]
+
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedCurrentWeek(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["currentWeek"]["value"]
+
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedCurrentMonth(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["currentMonth"]["value"]
+
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedCurrentYear(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["currentYear"]["value"]
+
+    @handleNotSupported
+    def getElectricalEnergySystemTransferChargeCumulatedLifeCycle(self):
+        return self.service.getProperty("ess.transfer.charge.cumulated")[
+            "properties"
+        ]["lifeCycle"]["value"]
+
     @handleNotSupported
     def getElectricalEnergySystemTransferDischargeCumulatedUnit(self):
         return self.service.getProperty("ess.transfer.discharge.cumulated")[

pyvicare-2.53.0/PyViCare/PyViCareFloorHeating.py

@@ -0,0 +1,32 @@
+from PyViCare.PyViCareDevice import ZigbeeDevice, Device
+from PyViCare.PyViCareUtils import handleAPICommandErrors, handleNotSupported
+
+
+class FloorHeating(ZigbeeDevice):
+
+    @handleNotSupported
+    def getSupplyTemperature(self) -> float:
+        return float(self.service.getProperty("fht.sensors.temperature.supply")["properties"]["value"]["value"])
+
+    @handleNotSupported
+    def getActiveMode(self) -> str:
+        return str(self.service.getProperty("fht.operating.modes.active")["properties"]["value"]["value"])
+
+
+class FloorHeatingChannel(Device):
+
+    @handleNotSupported
+    def getSerial(self) -> str:
+        return str(self.service.getProperty("device.name")["deviceId"])
+
+    @handleNotSupported
+    def getName(self) -> str:
+        return str(self.service.getProperty("device.name")["properties"]["name"]["value"])
+
+    @handleAPICommandErrors
+    def setName(self, name: str) -> None:
+        self.service.setProperty("device.name", "setName", {'name': name})
+
+    @handleNotSupported
+    def getValvePosition(self) -> str:
+        return str(self.service.getProperty("fht.valve.state")["properties"]["status"]["value"])

{pyvicare-2.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareGazBoiler.py

@@ -260,6 +260,15 @@ class GazBoiler(HeatingDevice):
     def getPowerSummaryConsumptionDomesticHotWaterLastYear(self):
         return self.service.getProperty("heating.power.consumption.summary.dhw")["properties"]["lastYear"]["value"]
 
+    @handleNotSupported
+    def getSupplyPressureUnit(self) -> str:
+        # Returns heating supply pressure unit (e.g. bar)
+        return str(self.service.getProperty("heating.sensors.pressure.supply")["properties"]["value"]["unit"])
+
+    @handleNotSupported
+    def getSupplyPressure(self) -> float:
+        # Returns heating supply pressure
+        return float(self.service.getProperty("heating.sensors.pressure.supply")["properties"]["value"]["value"])
 
 class GazBurner(HeatingDeviceWithComponent):
 

{pyvicare-2.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareRadiatorActuator.py

@@ -1,20 +1,24 @@
-from PyViCare.PyViCareDevice import Device
+from PyViCare.PyViCareDevice import ZigbeeBatteryDevice
 from PyViCare.PyViCareUtils import handleAPICommandErrors, handleNotSupported
 
 
-class RadiatorActuator(Device):
+class RadiatorActuator(ZigbeeBatteryDevice):
 
     @handleNotSupported
-    def getSerial(self):
-        return self.service.getProperty("device.name")["deviceId"]
+    def getTemperature(self):
+        return self.service.getProperty("device.sensors.temperature")["properties"]["value"]["value"]
 
     @handleNotSupported
-    def getBatteryLevel(self) -> int:
-        return int(self.service.getProperty("device.power.battery")["properties"]["level"]["value"])
+    def getValvePosition(self) -> int:
+        return int(self.service.getProperty("trv.valve.position")["properties"]["position"]["value"])
 
     @handleNotSupported
-    def getTemperature(self):
-        return self.service.getProperty("device.sensors.temperature")["properties"]["value"]["value"]
+    def getChildLock(self) -> str:
+        return str(self.service.getProperty("trv.childLock")["properties"]["status"]["value"])
+
+    @handleNotSupported
+    def getMountingMode(self) -> bool:
+        return bool(self.service.getProperty("trv.mountingMode")["properties"]["active"]["value"])
 
     @handleNotSupported
     def getTargetTemperature(self):

pyvicare-2.53.0/PyViCare/PyViCareRepeater.py

@@ -0,0 +1,6 @@
+from PyViCare.PyViCareDevice import ZigbeeDevice
+
+
+class Repeater(ZigbeeDevice):
+
+    pass

{pyvicare-2.51.0 → pyvicare-2.53.0}/PyViCare/PyViCareRoomSensor.py

@@ -1,17 +1,13 @@
-from PyViCare.PyViCareDevice import Device
+from PyViCare.PyViCareDevice import ZigbeeBatteryDevice
 from PyViCare.PyViCareUtils import handleNotSupported
 
 
-class RoomSensor(Device):
+class RoomSensor(ZigbeeBatteryDevice):
 
     @handleNotSupported
     def getSerial(self):
         return self.service.getProperty("device.sensors.temperature")["deviceId"]
 
-    @handleNotSupported
-    def getBatteryLevel(self) -> int:
-        return int(self.service.getProperty("device.power.battery")["properties"]["level"]["value"])
-
     @handleNotSupported
     def getTemperature(self):
         return self.service.getProperty("device.sensors.temperature")["properties"]["value"]["value"]

{pyvicare-2.51.0 → pyvicare-2.53.0}/README.md

@@ -175,3 +175,22 @@ To make the test data comparable with future updates, it must be sorted. No worr
 ```sh
 jq ".data|=sort_by(.feature)" --sort-keys testData.json > testDataSorted.json
 ```
+
+## Testing
+
+### Home Assistant
+
+To test a certain change in Home Assistant, one needs to have a `ViCare` integration installed as a custom component.
+Change the dependency in the `manifest.json` to point to a GitHub branch or commit SHA:
+
+```json
+  "requirements": [
+    "PyViCare@git+https://github.com/openviess/PyViCare.git@<branchname>"
+  ],
+```
+
+To install `ViCare` as a custom component, one can use the terminal addon to install the changes from a certain Home Assistant PR:
+
+```sh
+curl -o- -L https://gist.githubusercontent.com/bdraco/43f8043cb04b9838383fd71353e99b18/raw/core_integration_pr | bash /dev/stdin -d vicare -p <pr-number>
+```

{pyvicare-2.51.0 → pyvicare-2.53.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "PyViCare"
-version = "2.51.0"
+version = "2.53.0"
 description = "Library to communicate with the Viessmann ViCare API."
 authors = [
   "Simon Gillet <mail+pyvicare@gillet.ninja>"
@@ -51,8 +51,8 @@ codespell = "^2.3.0"
 mypy = "^1.11.2"
 pylint = "^3.2.6"
 pytest = "^8.3.2"
-pytest-cov = "^6.0.0"
-ruff = "^0.12.0"
+pytest-cov = "^7.0.0"
+ruff = "^0.14.0"
 types-deprecated = "^1.2.15.20241117"
 types-requests = ">=2.31"