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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
from contextlib import suppress
from deprecated import deprecated
from PyViCare.PyViCareDevice import Device
from PyViCare.PyViCareUtils import (PyViCareNotSupportedFeatureError, handleAPICommandErrors, handleNotSupported)
class VentilationDevice(Device):
"""This is the base class for all ventilation 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.
"""
@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"])
@handleNotSupported
def getVentilationReason(self) -> str:
return str(self.getProperty("ventilation.operating.state")["properties"]["reason"]["value"])
@handleNotSupported
def getVentilationModes(self) -> list[str]:
return list[str](self.getProperty("ventilation.operating.modes.active")["commands"]["setMode"]["params"]["mode"]["constraints"]["enum"])
@handleNotSupported
@deprecated(reason="renamed, use getVentilationModes", version="2.40.0")
def getAvailableModes(self):
return self.getVentilationModes()
@handleNotSupported
def getVentilationMode(self, mode: str) -> bool:
return bool(self.getProperty(f"ventilation.operating.modes.{mode}")["properties"]["active"]["value"])
@handleNotSupported
def getActiveVentilationMode(self) -> str:
return str(self.getProperty("ventilation.operating.modes.active")["properties"]["value"]["value"])
@handleNotSupported
def getVentilationLevels(self) -> list[str]:
return list[str](self.getProperty("ventilation.operating.modes.permanent")["commands"]["setLevel"]["params"]["level"]["constraints"]["enum"])
@handleNotSupported
@deprecated(reason="renamed, use getVentilationLevels", version="2.40.0")
def getPermanentLevels(self) -> list[str]:
return list[str](self.getVentilationLevels())
@handleNotSupported
def getVentilationLevel(self) -> str:
return str(self.getProperty("ventilation.operating.state")["properties"]["level"]["value"])
@handleAPICommandErrors
def setVentilationLevel(self, level: str):
return self.setProperty("ventilation.operating.modes.permanent", "setLevel", {'level': level})
@handleAPICommandErrors
@deprecated(reason="renamed, use setVentilationLevel", version="2.40.0")
def setPermanentLevel(self, level: str):
return self.setVentilationLevel(level)
@handleNotSupported
@deprecated(reason="renamed, use getActiveVentilationMode", version="2.40.0")
def getActiveMode(self):
return self.getActiveVentilationMode()
def activateVentilationMode(self, mode: str):
""" Set the active ventilation mode
Parameters
----------
mode : str
Valid mode can be obtained using getVentilationModes()
Returns
-------
result: json
json representation of the answer
"""
return self.setProperty("ventilation.operating.modes.active", "setMode", {'mode': mode})
@deprecated(reason="renamed, use activateVentilationMode", version="2.40.0")
def setActiveMode(self, mode):
""" Set the active mode
Parameters
----------
mode : str
Valid mode can be obtained using getModes()
Returns
-------
result: json
json representation of the answer
"""
return self.activateVentilationMode(mode)
@handleNotSupported
def getVentilationQuickmodes(self) -> list[str]:
available_quickmodes = []
for quickmode in ['comfort', 'eco', 'forcedLevelFour', 'holiday', 'standby', 'silent']:
with suppress(PyViCareNotSupportedFeatureError):
if self.getProperty(f"ventilation.quickmodes.{quickmode}") is not None:
available_quickmodes.append(quickmode)
return available_quickmodes
@handleNotSupported
def getVentilationQuickmode(self, quickmode: str) -> bool:
return bool(self.getProperty(f"ventilation.quickmodes.{quickmode}")["properties"]["active"]["value"])
@handleNotSupported
def activateVentilationQuickmode(self, quickmode: str) -> None:
self.setProperty(f"ventilation.quickmodes.{quickmode}", "activate", {})
@handleNotSupported
def deactivateVentilationQuickmode(self, quickmode: str) -> None:
self.setProperty(f"ventilation.quickmodes.{quickmode}", "deactivate", {})
@handleNotSupported
def getVentilationPrograms(self):
available_programs = []
for program in ['basic', 'intensive', 'reduced', 'standard', 'standby', 'holidayAtHome', 'permanent']:
with suppress(PyViCareNotSupportedFeatureError):
if self.getProperty(f"ventilation.operating.programs.{program}") is not None:
available_programs.append(program)
return available_programs
@handleNotSupported
@deprecated(reason="renamed, use getVentilationPrograms", version="2.40.0")
def getAvailablePrograms(self):
return self.getVentilationPrograms()
@handleNotSupported
def getActiveVentilationProgram(self):
return self.getProperty("ventilation.operating.programs.active")["properties"]["value"]["value"]
@handleNotSupported
@deprecated(reason="renamed, use getActiveVentilationProgram", version="2.40.0")
def getActiveProgram(self):
return self.getActiveVentilationProgram()
def activateVentilationProgram(self, program):
""" Activate a program
NOTE
DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
Parameters
----------
program : str
Returns
-------
result: json
json representation of the answer
"""
return self.setProperty(f"ventilation.operating.programs.{program}", "activate", {})
@deprecated(reason="renamed, use activateVentilationProgram", version="2.40.0")
def activateProgram(self, program):
""" Activate a program
NOTE
DEVICE_COMMUNICATION_ERROR can just mean that the program is already on
Parameters
----------
program : str
Returns
-------
result: json
json representation of the answer
"""
return self.activateVentilationProgram(program)
def deactivateVentilationProgram(self, program):
""" Deactivate a program
Parameters
----------
program : str
Returns
-------
result: json
json representation of the answer
"""
return self.setProperty(f"ventilation.operating.programs.{program}", "deactivate", {})
@deprecated(reason="renamed, use deactivateVentilationProgram", version="2.40.0")
def deactivateProgram(self, program):
""" Deactivate a program
Parameters
----------
program : str
Returns
-------
result: json
json representation of the answer
"""
return self.deactivateVentilationProgram(program)
@handleNotSupported
def getVentilationSchedule(self):
properties = self.getProperty("ventilation.schedule")["properties"]
return {
"active": properties["active"]["value"],
"mon": properties["entries"]["value"]["mon"],
"tue": properties["entries"]["value"]["tue"],
"wed": properties["entries"]["value"]["wed"],
"thu": properties["entries"]["value"]["thu"],
"fri": properties["entries"]["value"]["fri"],
"sat": properties["entries"]["value"]["sat"],
"sun": properties["entries"]["value"]["sun"]
}
@handleNotSupported
@deprecated(reason="renamed, use getVentilationSchedule", version="2.40.0")
def getSchedule(self):
return self.getVentilationSchedule()
@handleNotSupported
def getOutsideTemperature(self) -> float:
return float(self.getProperty("ventilation.sensors.temperature.outside")["properties"]["value"]["value"])
@handleNotSupported
def getOutsideHumidity(self) -> int:
return int(self.getProperty("ventilation.sensors.humidity.outdoor")["properties"]["value"]["value"])
@handleNotSupported
def getSupplyTemperature(self) -> float:
return float(self.getProperty("ventilation.sensors.temperature.supply")["properties"]["value"]["value"])
@handleNotSupported
def getSupplyHumidity(self) -> int:
return int(self.getProperty("ventilation.sensors.humidity.supply")["properties"]["value"]["value"])
@handleNotSupported
def getVolatileOrganicCompounds(self) -> int:
return int(self.getProperty("ventilation.sensors.volatileOrganicCompounds")["properties"]["value"]["value"])
@handleNotSupported
def getAirborneDustPM1(self) -> float:
return float(self.getProperty("ventilation.sensors.airBorneDust.pm1")["properties"]["value"]["value"])
@handleNotSupported
def getAirborneDustPM2d5(self) -> float:
return float(self.getProperty("ventilation.sensors.airBorneDust.pm2d5")["properties"]["value"]["value"])
@handleNotSupported
def getAirborneDustPM4(self) -> float:
return float(self.getProperty("ventilation.sensors.airBorneDust.pm4")["properties"]["value"]["value"])
@handleNotSupported
def getAirborneDustPM10(self) -> float:
return float(self.getProperty("ventilation.sensors.airBorneDust.pm10")["properties"]["value"]["value"])
@handleNotSupported
def getFilterHours(self) -> int:
return int(self.getProperty("ventilation.filter.runtime")["properties"]["operatingHours"]["value"])
@handleNotSupported
def getFilterRemainingHours(self) -> int:
return int(self.getProperty("ventilation.filter.runtime")["properties"]["remainingHours"]["value"])
@handleNotSupported
def getFilterOverdueHours(self) -> int:
return int(self.getProperty("ventilation.filter.runtime")["properties"]["overdueHours"]["value"])
@handleNotSupported
def getSupplyFanHours(self) -> int:
return int(self.getProperty("ventilation.fan.supply.runtime")["properties"]["value"]["value"])
@handleNotSupported
def getSupplyFanSpeed(self) -> int:
return int(self.getProperty("ventilation.fan.supply")["properties"]["current"]["value"])
@handleNotSupported
def getSupplyFanTargetSpeed(self) -> int:
return int(self.getProperty("ventilation.fan.supply")["properties"]["target"]["value"])
@handleNotSupported
def getHeatExchangerFrostProtectionActive(self) -> bool:
return "off" != str(self.getProperty("ventilation.heatExchanger.frostprotection")["properties"]["status"]["value"])
@handleNotSupported
def getSupplyVolumeFlow(self) -> int:
return int(self.getProperty("ventilation.volumeFlow.current.input")["properties"]["value"]["value"])
@handleNotSupported
def getExhaustVolumeFlow(self) -> int:
return int(self.getProperty("ventilation.volumeFlow.current.output")["properties"]["value"]["value"])
|
