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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
|
"""
PyTado interface implementation for hops.tado.com (Tado X).
"""
import functools
import logging
from typing import Any
from ...exceptions import TadoNotSupportedException
from ...http import Action, Domain, Http, Mode, TadoRequest, TadoXRequest
from ...logger import Logger
from ...zone import TadoXZone, TadoZone
from .my_tado import Tado, Timetable
def not_supported(reason):
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
raise TadoNotSupportedException(f"{func.__name__} is not supported: {reason}")
return wrapper
return decorator
_LOGGER = Logger(__name__)
class TadoX(Tado):
"""Interacts with a Tado thermostat via hops.tado.com (Tado X) API.
Example usage: http = Http()
http.device_activation() # Activate the device
t = TadoX(http)
t.get_climate(1) # Get climate, room 1.
"""
def __init__(
self,
http: Http,
debug: bool = False,
):
"""Class Constructor"""
super().__init__(http=http, debug=debug)
if not http.is_x_line:
raise TadoNotSupportedException("TadoX is only usable with LINE_X Generation")
if debug:
_LOGGER.setLevel(logging.DEBUG)
else:
_LOGGER.setLevel(logging.WARNING)
self._http = http
# Track whether the user's Tado instance supports auto-geofencing,
# set to None until explicitly set
self._auto_geofencing_supported = None
def get_devices(self):
"""
Gets device information.
"""
request = TadoXRequest()
request.command = "roomsAndDevices"
rooms_and_devices: list[dict[str, Any]] = self._http.request(request)
rooms = rooms_and_devices["rooms"]
devices = [device for room in rooms for device in room["devices"]]
for device in devices:
serial_number = device.get("serialNo", device.get("serialNumber"))
if not serial_number:
continue
request = TadoXRequest()
request.domain = Domain.DEVICES
request.device = serial_number
device.update(self._http.request(request))
if "otherDevices" in rooms_and_devices:
devices.append(rooms_and_devices["otherDevices"])
return devices
def get_zones(self):
"""
Gets zones (or rooms in Tado X API) information.
"""
request = TadoXRequest()
request.command = "roomsAndDevices"
return self._http.request(request)["rooms"]
def get_zone_state(self, zone: int) -> TadoZone:
"""
Gets current state of Zone as a TadoXZone object.
"""
return TadoXZone.from_data(zone, self.get_state(zone))
def get_zone_states(self):
"""
Gets current states of all zones.
"""
request = TadoXRequest()
request.command = "rooms"
return self._http.request(request)
def get_state(self, zone):
"""
Gets current state of Zone.
"""
request = TadoXRequest()
request.command = f"rooms/{zone:d}"
data = self._http.request(request)
return data
@not_supported("This method is not currently supported by the Tado X API")
def get_capabilities(self, zone):
"""
Gets current capabilities of zone.
"""
pass
def get_climate(self, zone):
"""
Gets temp (centigrade) and humidity (% RH) for zone.
"""
data = self.get_state(zone)["sensorDataPoints"]
return {
"temperature": data["insideTemperature"]["value"],
"humidity": data["humidity"]["percentage"],
}
@not_supported("Tado X API only support seven days timetable")
def set_timetable(self, zone: int, timetable: Timetable) -> None:
"""
Set the Timetable type currently active
id = 0 : ONE_DAY (MONDAY_TO_SUNDAY)
id = 1 : THREE_DAY (MONDAY_TO_FRIDAY, SATURDAY, SUNDAY)
id = 3 : SEVEN_DAY (MONDAY, TUESDAY, WEDNESDAY ...)
"""
pass
def get_schedule(self, zone: int, timetable: Timetable, day=None) -> dict[str, Any]:
"""
Get the JSON representation of the schedule for a zone.
Zone has 3 different schedules, one for each timetable (see setTimetable)
"""
request = TadoXRequest()
request.command = f"rooms/{zone:d}/schedule"
return self._http.request(request)
def set_schedule(self, zone, timetable: Timetable, day, data):
"""
Set the schedule for a zone, day is not required for Tado X API.
example data
[
{
"start": "00:00",
"end": "07:05",
"dayType": "MONDAY",
"setting": {
"power": "ON",
"temperature": {
"value": 18
}
}
},
{
"start": "07:05",
"end": "22:05",
"dayType": "MONDAY",
"setting": {
"power": "ON",
"temperature": {
"value": 22
}
}
},
{
"start": "22:05",
"end": "24:00",
"dayType": "MONDAY",
"setting": {
"power": "ON",
"temperature": {
"value": 18
}
}
}
]
"""
request = TadoXRequest()
request.command = f"rooms/{zone:d}/schedule"
request.action = Action.SET
request.payload = data
request.mode = Mode.OBJECT
return self._http.request(request)
def reset_zone_overlay(self, zone):
"""
Delete current overlay
"""
request = TadoXRequest()
request.command = f"rooms/{zone:d}/resumeSchedule"
request.action = Action.SET
return self._http.request(request)
def set_zone_overlay(
self,
zone,
overlay_mode,
set_temp=None,
duration=None,
device_type="HEATING",
power="ON",
mode=None,
fan_speed=None,
swing=None,
fan_level=None,
vertical_swing=None,
horizontal_swing=None,
):
"""
Set current overlay for a zone, a room in Tado X API.
"""
post_data = {
"setting": {"type": device_type, "power": power},
"termination": {"type": overlay_mode},
}
if set_temp is not None:
post_data["setting"]["temperature"] = {
"value": set_temp,
"valueRaw": set_temp,
"precision": 0.1,
}
if duration is not None:
post_data["termination"]["durationInSeconds"] = duration
request = TadoXRequest()
request.command = f"rooms/{zone:d}/manualControl"
request.action = Action.SET
request.payload = post_data
return self._http.request(request)
@not_supported("Concept of zones is not available by Tado X API, they use rooms")
def get_zone_overlay_default(self, zone: int):
"""
Get current overlay default settings for zone.
"""
pass
def get_open_window_detected(self, zone):
"""
Returns whether an open window is detected.
"""
data = self.get_state(zone)
if data["openWindow"] and "activated" in data["openWindow"]:
return {"openWindowDetected": True}
else:
return {"openWindowDetected": False}
def set_open_window(self, zone):
"""
Sets the window in zone to open
Note: This can only be set if an open window was detected in this zone
"""
request = TadoXRequest()
request.command = f"rooms/{zone}/openWindow"
request.action = Action.SET
return self._http.request(request)
def reset_open_window(self, zone):
"""
Sets the window in zone to closed
"""
request = TadoXRequest()
request.command = f"rooms/{zone}/openWindow"
request.action = Action.RESET
return self._http.request(request)
def get_device_info(self, device_id, cmd=""):
"""
Gets information about devices
with option to get specific info i.e. cmd='temperatureOffset'
"""
if cmd:
request = TadoRequest()
request.command = cmd
else:
request = TadoXRequest()
request.action = Action.GET
request.domain = Domain.DEVICES
request.device = device_id
return self._http.request(request)
def set_temp_offset(self, device_id, offset=0, measure="celsius"):
"""
Set the Temperature offset on the device.
"""
request = TadoXRequest()
request.command = f"roomsAndDevices/devices/{device_id}"
request.action = Action.CHANGE
request.payload = {"temperatureOffset": offset}
return self._http.request(request)
def set_child_lock(self, device_id, child_lock):
""" "
Set and toggle the child lock on the device.
"""
request = TadoXRequest()
request.command = f"roomsAndDevices/devices/{device_id}"
request.action = Action.CHANGE
request.payload = {"childLockEnabled": child_lock}
self._http.request(request)
def set_flow_temperature_optimization(self, max_flow_temperature: float):
"""
Set the flow temperature optimization.
max_flow_temperature: float, the maximum flow temperature in Celsius
"""
request = TadoXRequest()
request.action = Action.CHANGE
request.domain = Domain.HOME
request.command = "settings/flowTemperatureOptimization"
request.payload = {"maxFlowTemperature": max_flow_temperature}
return self._http.request(request)
def get_flow_temperature_optimization(self):
"""
Get the current flow temperature optimization
"""
request = TadoXRequest()
request.action = Action.GET
request.domain = Domain.HOME
request.command = "settings/flowTemperatureOptimization"
return self._http.request(request)
|