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
|
"""
PyTado interface abstraction to use app.tado.com or hops.tado.com
"""
import datetime
import functools
import warnings
import requests
import PyTado.interface.api as API
from PyTado.exceptions import TadoException
from PyTado.http import DeviceActivationStatus, Http
def deprecated(new_func_name):
"""
A decorator to mark functions as deprecated. It will result in a warning being emitted
when the function is used, advising the user to use the new function instead.
Args:
new_func_name (str): The name of the new function that should be used instead.
Returns:
function: A decorator that wraps the deprecated function and emits a warning.
"""
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
warnings.warn(
f"The '{func.__name__}' method is deprecated, use '{new_func_name}' instead. "
"Deprecated methods will be removed with 1.0.0.",
DeprecationWarning,
stacklevel=2,
)
return getattr(args[0], new_func_name)(*args, **kwargs)
return wrapper
return decorator
class Tado:
"""Interacts with a Tado thermostat via public API.
Example usage: t = Tado()
t.device_activation() # Activate device
t.get_climate(1) # Get climate, zone 1.
"""
def __init__(
self,
token_file_path: str | None = None,
saved_refresh_token: str | None = None,
http_session: requests.Session | None = None,
debug: bool = False,
):
"""
Initializes the interface class.
Args:
token_file_path (str | None, optional): Path to a file which will be used to persist
the refresh_token token. Defaults to None.
saved_refresh_token (str | None, optional): A previously saved refresh token.
Defaults to None.
http_session (requests.Session | None, optional): An optional HTTP session to use for
requests (can be used in unit tests). Defaults to None.
debug (bool, optional): Flag to enable or disable debug mode. Defaults to False.
"""
self._http = Http(
token_file_path=token_file_path,
saved_refresh_token=saved_refresh_token,
http_session=http_session,
debug=debug,
)
self._api: API.Tado | API.TadoX | None = None
self._debug = debug
def __getattr__(self, name):
"""Delegate the called method to api implementation (hops_tado.py or my_tado.py)."""
self._ensure_api_initialized()
return getattr(self._api, name)
def device_verification_url(self) -> str | None:
"""Returns the URL for device verification."""
return self._http.device_verification_url
def device_activation_status(self) -> DeviceActivationStatus:
"""Returns the status of the device activation."""
return self._http.device_activation_status
def device_activation(self) -> None:
"""Activates the device."""
self._http.device_activation()
self._ensure_api_initialized()
def get_refresh_token(self) -> str | None:
"""
Retrieve the refresh token from the current api connection.
Returns:
str | None: The current refresh token, or None if not available.
"""
return self._http.refresh_token
def _ensure_api_initialized(self):
"""Ensures the API client is initialized."""
if self._api is None:
if self._http.device_activation_status == DeviceActivationStatus.COMPLETED:
if self._http.is_x_line:
self._api = API.TadoX(http=self._http, debug=self._debug)
else:
self._api = API.Tado(http=self._http, debug=self._debug)
else:
raise TadoException(
"API is not initialized. Please complete device authentication first."
)
# region Deprecated Methods
# pylint: disable=invalid-name
@deprecated("get_me")
def getMe(self):
"""Gets home information. (deprecated)"""
return self.get_me()
@deprecated("get_devices")
def getDevices(self):
"""Gets device information. (deprecated)"""
return self.get_devices()
@deprecated("get_zones")
def getZones(self):
"""Gets zones information. (deprecated)"""
return self.get_zones()
@deprecated("set_child_lock")
def setChildLock(self, device_id, enabled):
"""Set the child lock for a device"""
return self.set_child_lock(device_id, enabled)
@deprecated("get_zone_state")
def getZoneState(self, zone):
"""Gets current state of Zone as a TadoZone object. (deprecated)"""
return self.get_zone_state(zone)
@deprecated("get_zone_states")
def getZoneStates(self):
"""Gets current states of all zones. (deprecated)"""
return self.get_zone_states()
@deprecated("get_state")
def getState(self, zone):
"""Gets current state of Zone. (deprecated)"""
return self.get_state(zone)
@deprecated("get_home_state")
def getHomeState(self):
"""Gets current state of Home. (deprecated)"""
return self.get_home_state()
@deprecated("get_auto_geofencing_supported")
def getAutoGeofencingSupported(self):
"""Return whether the Tado Home supports auto geofencing (deprecated)"""
return self.get_auto_geofencing_supported()
@deprecated("get_capabilities")
def getCapabilities(self, zone):
"""Gets current capabilities of Zone zone. (deprecated)"""
return self.get_capabilities(zone)
@deprecated("get_climate")
def getClimate(self, zone):
"""Gets temp (centigrade) and humidity (% RH) for Zone zone. (deprecated)"""
return self.get_climate(zone)
@deprecated("get_timetable")
def getTimetable(self, zone):
"""Get the Timetable type currently active (Deprecated)"""
return self.get_timetable(zone)
@deprecated("get_historic")
def getHistoric(self, zone, date):
"""Gets historic information on given date for zone. (Deprecated)"""
return self.get_historic(zone, date)
@deprecated("set_timetable")
def setTimetable(self, zone, _id):
"""Set the Timetable type currently active (Deprecated)
id = 0 : ONE_DAY (MONDAY_TO_SUNDAY)
id = 1 : THREE_DAY (MONDAY_TO_FRIDAY, SATURDAY, SUNDAY)
id = 3 : SEVEN_DAY (MONDAY, TUESDAY, WEDNESDAY ...)"""
return self.set_timetable(zone, _id)
@deprecated("get_schedule")
def getSchedule(self, zone, _id, day=None):
"""Get the JSON representation of the schedule for a zone. Zone has 3 different schedules,
one for each timetable (see setTimetable)"""
return self.get_schedule(zone, _id, day)
@deprecated("set_schedule")
def setSchedule(self, zone, _id, day, data):
"""Set the schedule for a zone, day is required"""
return self.set_schedule(zone, _id, day, data)
@deprecated("get_weather")
def getWeather(self):
"""Gets outside weather data (Deprecated)"""
return self.get_weather()
@deprecated("get_air_comfort")
def getAirComfort(self):
"""Gets air quality information (Deprecated)"""
return self.get_air_comfort()
@deprecated("get_users")
def getAppUsers(self):
"""Gets getAppUsers data (deprecated)"""
return self.get_app_user()
@deprecated("get_mobile_devices")
def getMobileDevices(self):
"""Gets information about mobile devices (Deprecated)"""
return self.get_mobile_devices()
@deprecated("reset_zone_overlay")
def resetZoneOverlay(self, zone):
"""Delete current overlay (Deprecated)"""
return self.reset_zone_overlay(zone)
@deprecated("set_zone_overlay")
def setZoneOverlay(
self,
zone,
overlayMode,
setTemp=None,
duration=None,
deviceType="HEATING",
power="ON",
mode=None,
fanSpeed=None,
swing=None,
fanLevel=None,
verticalSwing=None,
horizontalSwing=None,
):
"""Set current overlay for a zone (Deprecated)"""
return self.set_zone_overlay(
zone,
overlay_mode=overlayMode,
set_temp=setTemp,
duration=duration,
device_type=deviceType,
power=power,
mode=mode,
fan_speed=fanSpeed,
swing=swing,
fan_level=fanLevel,
vertical_swing=verticalSwing,
horizontal_swing=horizontalSwing,
)
@deprecated("get_zone_overlay_default")
def getZoneOverlayDefault(self, zone):
"""Get current overlay default settings for zone. (Deprecated)"""
return self.get_zone_overlay_default(zone)
@deprecated("set_home")
def setHome(self):
"""Sets HomeState to HOME (Deprecated)"""
return self.set_home()
@deprecated("set_away")
def setAway(self):
"""Sets HomeState to AWAY (Deprecated)"""
return self.set_away()
@deprecated("change_presence")
def changePresence(self, presence):
"""Sets HomeState to presence (Deprecated)"""
return self.change_presence(presence=presence)
@deprecated("set_auto")
def setAuto(self):
"""Sets HomeState to AUTO (Deprecated)"""
return self.set_auto()
@deprecated("get_window_state")
def getWindowState(self, zone):
"""Returns the state of the window for zone (Deprecated)"""
return self.get_window_state(zone=zone)
@deprecated("get_open_window_detected")
def getOpenWindowDetected(self, zone):
"""Returns whether an open window is detected. (Deprecated)"""
return self.get_open_window_detected(zone=zone)
@deprecated("set_open_window")
def setOpenWindow(self, zone):
"""Sets the window in zone to open (Deprecated)"""
return self.set_open_window(zone=zone)
@deprecated("reset_open_window")
def resetOpenWindow(self, zone):
"""Sets the window in zone to closed (Deprecated)"""
return self.reset_open_window(zone=zone)
@deprecated("get_device_info")
def getDeviceInfo(self, device_id, cmd=""):
"""Gets information about devices
with option to get specific info i.e. cmd='temperatureOffset' (Deprecated)
"""
return self.get_device_info(device_id=device_id, cmd=cmd)
@deprecated("set_temp_offset")
def setTempOffset(self, device_id, offset=0, measure="celsius"):
"""Set the Temperature offset on the device. (Deprecated)"""
return self.set_temp_offset(device_id=device_id, offset=offset, measure=measure)
@deprecated("get_eiq_tariffs")
def getEIQTariffs(self):
"""Get Energy IQ tariff history (Deprecated)"""
return self.get_eiq_tariffs()
@deprecated("get_eiq_meter_readings")
def getEIQMeterReadings(self):
"""Get Energy IQ meter readings (Deprecated)"""
return self.get_eiq_meter_readings()
@deprecated("set_eiq_meter_readings")
def setEIQMeterReadings(self, date=datetime.datetime.now().strftime("%Y-%m-%d"), reading=0):
"""Send Meter Readings to Tado (Deprecated)
date format is YYYY-MM-DD, reading is without decimals
"""
return self.set_eiq_meter_readings(date=date, reading=reading)
@deprecated("set_eiq_tariff")
def setEIQTariff(
self,
from_date=datetime.datetime.now().strftime("%Y-%m-%d"),
to_date=datetime.datetime.now().strftime("%Y-%m-%d"),
tariff=0,
unit="m3",
is_period=False,
):
"""Send Tariffs to Tado (Deprecated)
date format is YYYY-MM-DD, tariff is with decimals, unit is either
m3 or kWh, set is_period to true to set a period of price
"""
return self.set_eiq_tariff(
from_date=from_date,
to_date=to_date,
tariff=tariff,
unit=unit,
is_period=is_period,
)
# pylint: enable=invalid-name
# endregion
|