API Documentation for PyTado
Module PyTado.interface.api
Tado
Interacts with a Tado thermostat via public my.tado.com API.
Example usage: http = Http() http.device_activation() # Activate the device t = Tado(http) t.get_climate(1) # Get climate, zone 1.
change_presence(self, presence: <enum 'Presence'>)
Sets HomeState to presence
Parameters:
- self (Unknown): Required
- presence (
<enum 'Presence'>): Required
get_air_comfort(self)
Gets air quality information
Parameters:
- self (Unknown): Required
get_auto_geofencing_supported(self)
Return whether the Tado Home supports auto geofencing
Parameters:
- self (Unknown): Required
get_capabilities(self, zone)
Gets current capabilities of zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_climate(self, zone)
Gets temp (centigrade) and humidity (% RH) for zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_device_info(self, device_id, cmd)
Gets information about devices with option to get specific info i.e. cmd='temperatureOffset'
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- cmd (Unknown):
get_devices(self)
Gets device information.
Parameters:
- self (Unknown): Required
get_eiq_consumption_overview(self, date)
Get consumption overview data for a specific month
Args: date (str): The year-month to get the consumption overview for.
Returns: dict: Consumption overview data for the specified month
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04
get_eiq_meter_readings(self)
Get Energy IQ meter readings
Parameters:
- self (Unknown): Required
get_eiq_tariffs(self)
Get Energy IQ tariff history
Parameters:
- self (Unknown): Required
get_heating_circuits(self)
Gets available heating circuits
Parameters:
- self (Unknown): Required
get_historic(self, zone, date)
Gets historic information on given date for zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- date (Unknown): Required
get_home_state(self)
Gets current state of Home.
Parameters:
- self (Unknown): Required
get_me(self)
Gets home information.
Parameters:
- self (Unknown): Required
get_mobile_devices(self)
Gets information about mobile devices
Parameters:
- self (Unknown): Required
get_open_window_detected(self, zone)
Returns whether an open window is detected.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_running_times(self, date)
Get the running times from the Minder API
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04-30
get_schedule(self, zone: <class 'int'>, timetable: <enum 'Timetable'>, day)
Get the JSON representation of the schedule for a zone. Zone has 3 different schedules, one for each timetable (see setTimetable)
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required - timetable (
<enum 'Timetable'>): Required - day (Unknown): None
get_state(self, zone)
Gets current state of Zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_timetable(self, zone: <class 'int'>)
Get the Timetable type currently active
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_users(self)
Gets active users in home
Parameters:
- self (Unknown): Required
get_weather(self)
Gets outside weather data
Parameters:
- self (Unknown): Required
get_window_state(self, zone)
Returns the state of the window for zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_zone_control(self, zone)
Get zone control information
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_zone_overlay_default(self, zone: <class 'int'>)
Get current overlay default settings for zone.
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_zone_state(self, zone: <class 'int'>)
Gets current state of Zone as a TadoZone object.
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_zone_states(self)
Gets current states of all zones.
Parameters:
- self (Unknown): Required
get_zones(self)
Gets zones information.
Parameters:
- self (Unknown): Required
reset_open_window(self, zone)
Sets the window in zone to closed
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
reset_zone_overlay(self, zone)
Delete current overlay
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
set_auto(self)
Sets HomeState to AUTO
Parameters:
- self (Unknown): Required
set_away(self)
Sets HomeState to AWAY
Parameters:
- self (Unknown): Required
set_child_lock(self, device_id, child_lock)
Sets the child lock on a device
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- child_lock (Unknown): Required
set_eiq_meter_readings(self, date, reading)
Send Meter Readings to Tado, date format is YYYY-MM-DD, reading is without decimals
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04-30
- reading (Unknown): 0
set_eiq_tariff(self, from_date, to_date, tariff, unit, is_period)
Send Tariffs to Tado, 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
Parameters:
- self (Unknown): Required
- from_date (Unknown): 2025-04-30
- to_date (Unknown): 2025-04-30
- tariff (Unknown): 0
- unit (Unknown): m3
- is_period (Unknown): False
set_home(self)
Sets HomeState to HOME
Parameters:
- self (Unknown): Required
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
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
set_schedule(self, zone, timetable: <enum 'Timetable'>, day, data)
Set the schedule for a zone, day is required
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- timetable (
<enum 'Timetable'>): Required - day (Unknown): Required
- data (Unknown): Required
set_temp_offset(self, device_id, offset, measure)
Set the Temperature offset on the device.
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- offset (Unknown): 0
- measure (Unknown): celsius
set_timetable(self, zone: <class 'int'>, timetable: <enum 'Timetable'>)
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 ...)
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required - timetable (
<enum 'Timetable'>): Required
set_zone_heating_circuit(self, zone, heating_circuit)
Sets the heating circuit for a zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- heating_circuit (Unknown): Required
set_zone_overlay(self, zone, overlay_mode, set_temp, duration, device_type, power, mode, fan_speed, swing, fan_level, vertical_swing, horizontal_swing)
Set current overlay for a zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- overlay_mode (Unknown): Required
- set_temp (Unknown): None
- duration (Unknown): None
- device_type (Unknown): HEATING
- power (Unknown): ON
- mode (Unknown): None
- fan_speed (Unknown): None
- swing (Unknown): None
- fan_level (Unknown): None
- vertical_swing (Unknown): None
- horizontal_swing (Unknown): None
TadoX
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.
change_presence(self, presence: <enum 'Presence'>)
Sets HomeState to presence
Parameters:
- self (Unknown): Required
- presence (
<enum 'Presence'>): Required
get_air_comfort(self)
Gets air quality information
Parameters:
- self (Unknown): Required
get_auto_geofencing_supported(self)
Return whether the Tado Home supports auto geofencing
Parameters:
- self (Unknown): Required
get_capabilities(self, zone)
Gets current capabilities of zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_climate(self, zone)
Gets temp (centigrade) and humidity (% RH) for zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_device_info(self, device_id, cmd)
Gets information about devices with option to get specific info i.e. cmd='temperatureOffset'
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- cmd (Unknown):
get_devices(self)
Gets device information.
Parameters:
- self (Unknown): Required
get_eiq_consumption_overview(self, date)
Get consumption overview data for a specific month
Args: date (str): The year-month to get the consumption overview for.
Returns: dict: Consumption overview data for the specified month
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04
get_eiq_meter_readings(self)
Get Energy IQ meter readings
Parameters:
- self (Unknown): Required
get_eiq_tariffs(self)
Get Energy IQ tariff history
Parameters:
- self (Unknown): Required
get_flow_temperature_optimization(self)
Get the current flow temperature optimization
Parameters:
- self (Unknown): Required
get_heating_circuits(self)
Gets available heating circuits
Parameters:
- self (Unknown): Required
get_historic(self, zone, date)
Gets historic information on given date for zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- date (Unknown): Required
get_home_state(self)
Gets current state of Home.
Parameters:
- self (Unknown): Required
get_me(self)
Gets home information.
Parameters:
- self (Unknown): Required
get_mobile_devices(self)
Gets information about mobile devices
Parameters:
- self (Unknown): Required
get_open_window_detected(self, zone)
Returns whether an open window is detected.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_running_times(self, date)
Get the running times from the Minder API
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04-30
get_schedule(self, zone: <class 'int'>, timetable: <enum 'Timetable'>, day)
Get the JSON representation of the schedule for a zone. Zone has 3 different schedules, one for each timetable (see setTimetable)
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required - timetable (
<enum 'Timetable'>): Required - day (Unknown): None
get_state(self, zone)
Gets current state of Zone.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_timetable(self, zone: <class 'int'>)
Get the Timetable type currently active
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_users(self)
Gets active users in home
Parameters:
- self (Unknown): Required
get_weather(self)
Gets outside weather data
Parameters:
- self (Unknown): Required
get_window_state(self, zone)
Returns the state of the window for zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_zone_control(self, zone)
Get zone control information
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
get_zone_overlay_default(self, zone: <class 'int'>)
Get current overlay default settings for zone.
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_zone_state(self, zone: <class 'int'>)
Gets current state of Zone as a TadoXZone object.
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required
get_zone_states(self)
Gets current states of all zones.
Parameters:
- self (Unknown): Required
get_zones(self)
Gets zones (or rooms in Tado X API) information.
Parameters:
- self (Unknown): Required
reset_open_window(self, zone)
Sets the window in zone to closed
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
reset_zone_overlay(self, zone)
Delete current overlay
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
set_auto(self)
Sets HomeState to AUTO
Parameters:
- self (Unknown): Required
set_away(self)
Sets HomeState to AWAY
Parameters:
- self (Unknown): Required
set_child_lock(self, device_id, child_lock)
" Set and toggle the child lock on the device.
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- child_lock (Unknown): Required
set_eiq_meter_readings(self, date, reading)
Send Meter Readings to Tado, date format is YYYY-MM-DD, reading is without decimals
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04-30
- reading (Unknown): 0
set_eiq_tariff(self, from_date, to_date, tariff, unit, is_period)
Send Tariffs to Tado, 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
Parameters:
- self (Unknown): Required
- from_date (Unknown): 2025-04-30
- to_date (Unknown): 2025-04-30
- tariff (Unknown): 0
- unit (Unknown): m3
- is_period (Unknown): False
set_flow_temperature_optimization(self, max_flow_temperature: <class 'float'>)
Set the flow temperature optimization.
max_flow_temperature: float, the maximum flow temperature in Celsius
Parameters:
- self (Unknown): Required
- max_flow_temperature (
<class 'float'>): Required
set_home(self)
Sets HomeState to HOME
Parameters:
- self (Unknown): Required
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
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
set_schedule(self, zone, timetable: <enum '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 } } } ]
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- timetable (
<enum 'Timetable'>): Required - day (Unknown): Required
- data (Unknown): Required
set_temp_offset(self, device_id, offset, measure)
Set the Temperature offset on the device.
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- offset (Unknown): 0
- measure (Unknown): celsius
set_timetable(self, zone: <class 'int'>, timetable: <enum 'Timetable'>)
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 ...)
Parameters:
- self (Unknown): Required
- zone (
<class 'int'>): Required - timetable (
<enum 'Timetable'>): Required
set_zone_heating_circuit(self, zone, heating_circuit)
Sets the heating circuit for a zone
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- heating_circuit (Unknown): Required
set_zone_overlay(self, zone, overlay_mode, set_temp, duration, device_type, power, mode, fan_speed, swing, fan_level, vertical_swing, horizontal_swing)
Set current overlay for a zone, a room in Tado X API.
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- overlay_mode (Unknown): Required
- set_temp (Unknown): None
- duration (Unknown): None
- device_type (Unknown): HEATING
- power (Unknown): ON
- mode (Unknown): None
- fan_speed (Unknown): None
- swing (Unknown): None
- fan_level (Unknown): None
- vertical_swing (Unknown): None
- horizontal_swing (Unknown): None
Module PyTado.interface
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.
changePresence(self, presence)
Sets HomeState to presence (Deprecated)
Parameters:
- self (Unknown): Required
- presence (Unknown): Required
device_activation(self)
Activates the device.
Parameters:
- self (Unknown): Required
device_activation_status(self)
Returns the status of the device activation.
Parameters:
- self (Unknown): Required
device_verification_url(self)
Returns the URL for device verification.
Parameters:
- self (Unknown): Required
getAirComfort(self)
Gets air quality information (Deprecated)
Parameters:
- self (Unknown): Required
getAppUsers(self)
Gets getAppUsers data (deprecated)
Parameters:
- self (Unknown): Required
getAutoGeofencingSupported(self)
Return whether the Tado Home supports auto geofencing (deprecated)
Parameters:
- self (Unknown): Required
getCapabilities(self, zone)
Gets current capabilities of Zone zone. (deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getClimate(self, zone)
Gets temp (centigrade) and humidity (% RH) for Zone zone. (deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getDeviceInfo(self, device_id, cmd)
Gets information about devices with option to get specific info i.e. cmd='temperatureOffset' (Deprecated)
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- cmd (Unknown):
getDevices(self)
Gets device information. (deprecated)
Parameters:
- self (Unknown): Required
getEIQMeterReadings(self)
Get Energy IQ meter readings (Deprecated)
Parameters:
- self (Unknown): Required
getEIQTariffs(self)
Get Energy IQ tariff history (Deprecated)
Parameters:
- self (Unknown): Required
getHistoric(self, zone, date)
Gets historic information on given date for zone. (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- date (Unknown): Required
getHomeState(self)
Gets current state of Home. (deprecated)
Parameters:
- self (Unknown): Required
getMe(self)
Gets home information. (deprecated)
Parameters:
- self (Unknown): Required
getMobileDevices(self)
Gets information about mobile devices (Deprecated)
Parameters:
- self (Unknown): Required
getOpenWindowDetected(self, zone)
Returns whether an open window is detected. (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getSchedule(self, zone, _id, day)
Get the JSON representation of the schedule for a zone. Zone has 3 different schedules, one for each timetable (see setTimetable)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- _id (Unknown): Required
- day (Unknown): None
getState(self, zone)
Gets current state of Zone. (deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getTimetable(self, zone)
Get the Timetable type currently active (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getWeather(self)
Gets outside weather data (Deprecated)
Parameters:
- self (Unknown): Required
getWindowState(self, zone)
Returns the state of the window for zone (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getZoneOverlayDefault(self, zone)
Get current overlay default settings for zone. (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getZoneState(self, zone)
Gets current state of Zone as a TadoZone object. (deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
getZoneStates(self)
Gets current states of all zones. (deprecated)
Parameters:
- self (Unknown): Required
getZones(self)
Gets zones information. (deprecated)
Parameters:
- self (Unknown): Required
get_refresh_token(self)
Retrieve the refresh token from the current api connection.
Returns: str | None: The current refresh token, or None if not available.
Parameters:
- self (Unknown): Required
resetOpenWindow(self, zone)
Sets the window in zone to closed (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
resetZoneOverlay(self, zone)
Delete current overlay (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
setAuto(self)
Sets HomeState to AUTO (Deprecated)
Parameters:
- self (Unknown): Required
setAway(self)
Sets HomeState to AWAY (Deprecated)
Parameters:
- self (Unknown): Required
setChildLock(self, device_id, enabled)
Set the child lock for a device
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- enabled (Unknown): Required
setEIQMeterReadings(self, date, reading)
Send Meter Readings to Tado (Deprecated)
date format is YYYY-MM-DD, reading is without decimals
Parameters:
- self (Unknown): Required
- date (Unknown): 2025-04-30
- reading (Unknown): 0
setEIQTariff(self, from_date, to_date, tariff, unit, is_period)
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
Parameters:
- self (Unknown): Required
- from_date (Unknown): 2025-04-30
- to_date (Unknown): 2025-04-30
- tariff (Unknown): 0
- unit (Unknown): m3
- is_period (Unknown): False
setHome(self)
Sets HomeState to HOME (Deprecated)
Parameters:
- self (Unknown): Required
setOpenWindow(self, zone)
Sets the window in zone to open (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
setSchedule(self, zone, _id, day, data)
Set the schedule for a zone, day is required
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- _id (Unknown): Required
- day (Unknown): Required
- data (Unknown): Required
setTempOffset(self, device_id, offset, measure)
Set the Temperature offset on the device. (Deprecated)
Parameters:
- self (Unknown): Required
- device_id (Unknown): Required
- offset (Unknown): 0
- measure (Unknown): celsius
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 ...)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- _id (Unknown): Required
setZoneOverlay(self, zone, overlayMode, setTemp, duration, deviceType, power, mode, fanSpeed, swing, fanLevel, verticalSwing, horizontalSwing)
Set current overlay for a zone (Deprecated)
Parameters:
- self (Unknown): Required
- zone (Unknown): Required
- overlayMode (Unknown): Required
- setTemp (Unknown): None
- duration (Unknown): None
- deviceType (Unknown): HEATING
- power (Unknown): ON
- mode (Unknown): None
- fanSpeed (Unknown): None
- swing (Unknown): None
- fanLevel (Unknown): None
- verticalSwing (Unknown): None
- horizontalSwing (Unknown): None
Module PyTado.zone
TadoXZone
Tado Zone data structure for hops.tado.com (Tado X) API.
Attributes:
- precision (
float):0.01 - from_data (
classmethod):<classmethod(<function TadoXZone.from_data at 0x7f39b1b119e0>)>
TadoZone
Tado Zone data structure for my.tado.com.
Attributes:
- current_temp (
NoneType):None - current_temp_timestamp (
NoneType):None - current_humidity (
NoneType):None - current_humidity_timestamp (
NoneType):None - is_away (
NoneType):None - current_hvac_action (
str):OFF - current_fan_speed (
NoneType):None - current_fan_level (
NoneType):None - current_hvac_mode (
NoneType):None - current_swing_mode (
NoneType):None - current_vertical_swing_mode (
NoneType):None - current_horizontal_swing_mode (
NoneType):None - target_temp (
NoneType):None - available (
bool):False - power (
NoneType):None - link (
NoneType):None - connection (
NoneType):None - ac_power_timestamp (
NoneType):None - heating_power_timestamp (
NoneType):None - ac_power (
NoneType):None - heating_power (
NoneType):None - heating_power_percentage (
NoneType):None - tado_mode (
NoneType):None - overlay_termination_type (
NoneType):None - overlay_termination_timestamp (
NoneType):None - default_overlay_termination_type (
NoneType):None - default_overlay_termination_duration (
NoneType):None - preparation (
bool):False - open_window (
bool):False - open_window_detected (
bool):False - precision (
float):0.1 - overlay_active (
property):<property object at 0x7f39b1b26e80> - from_data (
classmethod):<classmethod(<function TadoZone.from_data at 0x7f39b1b11bc0>)>