1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
from typing import Any
from PyViCare.PyViCareService import ViCareService
from PyViCare.PyViCareUtils import PyViCareNotSupportedFeatureError, handleAPICommandErrors, handleNotSupported
class Device:
"""This is the base class for all simple devices.
This class connects to the Viessmann ViCare API.
The authentication is done through OAuth2.
Note that currently, a new token is generated for each run.
"""
def __init__(self, service: ViCareService) -> None:
self.service = service
def getProperty(self, property_name: str) -> Any:
return self.service.getProperty(property_name)
def setProperty(self, property_name: str, action: str, data: Any) -> Any:
return self.service.setProperty(property_name, action, data)
@handleNotSupported
def getSerial(self):
return self.getProperty("device.serial")["properties"]["value"]["value"]
@handleNotSupported
def getDeviceErrors(self) -> list[Any]:
return list[Any](self.getProperty("device.messages.errors.raw")["properties"]["entries"]["value"])
def isLegacyDevice(self) -> bool:
return self.service.hasRoles(["type:legacy"])
def isE3Device(self) -> bool:
return self.service.hasRoles(["type:E3"])
def isDomesticHotWaterDevice(self):
return self._isTypeDevice("heating.dhw")
def isSolarThermalDevice(self):
return self._isTypeDevice("heating.solar")
def isVentilationDevice(self):
return self._isTypeDevice("ventilation")
def _isTypeDevice(self, deviceType: str):
try:
return self.getProperty(deviceType)["isEnabled"] and self.getProperty(deviceType)["properties"]["active"]["value"]
except PyViCareNotSupportedFeatureError:
return False
class ZigbeeDevice(Device):
@handleNotSupported
def getSerial(self) -> str:
return str(self.getProperty("device.zigbee.parent.id")["deviceId"])
@handleNotSupported
def getZigbeeParentID(self) -> str:
return str(self.getProperty("device.zigbee.parent.id")["properties"]["value"]["value"])
@handleNotSupported
def getZigbeeSignalStrength(self) -> int:
return int(self.getProperty("device.zigbee.lqi")["properties"]["strength"]["value"])
@handleNotSupported
def getName(self) -> str:
return str(self.getProperty("device.name")["properties"]["name"]["value"])
@handleAPICommandErrors
def setName(self, name: str) -> None:
self.setProperty("device.name", "setName", {'name': name})
@handleNotSupported
def getIdentification(self) -> bool:
return bool(self.getProperty("device.identification")["properties"]["triggered"]["value"])
class ZigbeeBatteryDevice(ZigbeeDevice):
@handleNotSupported
def getBatteryLevel(self) -> int:
return int(self.getProperty("device.power.battery")["properties"]["level"]["value"])
|
