Tado Async

Appearance

API Reference ​

The main Tado class is the entry point for interacting with the Tado API.

tadoasync.tadoasync ​

Asynchronous Python client for the Tado API.

TOKEN_URL ​

noqa: S105

DeviceActivationStatus Objects ​

python
class DeviceActivationStatus(enum.StrEnum)

Device Activation Status Enum.

NOT_STARTED ​

PENDING ​

COMPLETED ​

Inherited from base class:

capitalize ​

python
def capitalize(self, /)

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

casefold ​

python
def casefold(self, /)

Return a version of the string suitable for caseless comparisons.

center ​

python
def center(self, width, fillchar=' ', /)

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

count ​

python
def count(...)

S.count(sub[, start[, end]]) -> int

Return the number of non-overlapping occurrences of substring sub in string S[start:end]. Optional arguments start and end are interpreted as in slice notation.

encode ​

python
def encode(self, /, encoding='utf-8', errors='strict')

Encode the string using the codec registered for encoding.

encoding The encoding in which to encode the string. errors The error handling scheme to use for encoding errors. The default is 'strict' meaning that encoding errors raise a UnicodeEncodeError. Other possible values are 'ignore', 'replace' and 'xmlcharrefreplace' as well as any other name registered with codecs.register_error that can handle UnicodeEncodeErrors.

endswith ​

python
def endswith(...)

S.endswith(suffix[, start[, end]]) -> bool

Return True if S ends with the specified suffix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. suffix can also be a tuple of strings to try.

expandtabs ​

python
def expandtabs(self, /, tabsize=8)

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

find ​

python
def find(...)

S.find(sub[, start[, end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

format ​

python
def format(...)

S.format(*args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('{' and '}').

format_map ​

python
def format_map(...)

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('{' and '}').

index ​

python
def index(...)

S.index(sub[, start[, end]]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

isalnum ​

python
def isalnum(self, /)

Return True if the string is an alpha-numeric string, False otherwise.

A string is alpha-numeric if all characters in the string are alpha-numeric and there is at least one character in the string.

isalpha ​

python
def isalpha(self, /)

Return True if the string is an alphabetic string, False otherwise.

A string is alphabetic if all characters in the string are alphabetic and there is at least one character in the string.

isascii ​

python
def isascii(self, /)

Return True if all characters in the string are ASCII, False otherwise.

ASCII characters have code points in the range U+0000-U+007F. Empty string is ASCII too.

isdecimal ​

python
def isdecimal(self, /)

Return True if the string is a decimal string, False otherwise.

A string is a decimal string if all characters in the string are decimal and there is at least one character in the string.

isdigit ​

python
def isdigit(self, /)

Return True if the string is a digit string, False otherwise.

A string is a digit string if all characters in the string are digits and there is at least one character in the string.

isidentifier ​

python
def isidentifier(self, /)

Return True if the string is a valid Python identifier, False otherwise.

Call keyword.iskeyword(s) to test whether string s is a reserved identifier, such as "def" or "class".

islower ​

python
def islower(self, /)

Return True if the string is a lowercase string, False otherwise.

A string is lowercase if all cased characters in the string are lowercase and there is at least one cased character in the string.

isnumeric ​

python
def isnumeric(self, /)

Return True if the string is a numeric string, False otherwise.

A string is numeric if all characters in the string are numeric and there is at least one character in the string.

isprintable ​

python
def isprintable(self, /)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace ​

python
def isspace(self, /)

Return True if the string is a whitespace string, False otherwise.

A string is whitespace if all characters in the string are whitespace and there is at least one character in the string.

istitle ​

python
def istitle(self, /)

Return True if the string is a title-cased string, False otherwise.

In a title-cased string, upper- and title-case characters may only follow uncased characters and lowercase characters only cased ones.

isupper ​

python
def isupper(self, /)

Return True if the string is an uppercase string, False otherwise.

A string is uppercase if all cased characters in the string are uppercase and there is at least one cased character in the string.

join ​

python
def join(self, iterable, /)

Concatenate any number of strings.

The string whose method is called is inserted in between each given string. The result is returned as a new string.

Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'

ljust ​

python
def ljust(self, width, fillchar=' ', /)

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

lower ​

python
def lower(self, /)

Return a copy of the string converted to lowercase.

lstrip ​

python
def lstrip(self, chars=None, /)

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

maketrans ​

python
def maketrans(...)

Return a translation table usable for str.translate().

If there is only one argument, it must be a dictionary mapping Unicode ordinals (integers) or characters to Unicode ordinals, strings or None. Character keys will be then converted to ordinals. If there are two arguments, they must be strings of equal length, and in the resulting dictionary, each character in x will be mapped to the character at the same position in y. If there is a third argument, it must be a string, whose characters will be mapped to None in the result.

partition ​

python
def partition(self, sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing the original string and two empty strings.

removeprefix ​

python
def removeprefix(self, prefix, /)

Return a str with the given prefix string removed if present.

If the string starts with the prefix string, return string[len(prefix):]. Otherwise, return a copy of the original string.

removesuffix ​

python
def removesuffix(self, suffix, /)

Return a str with the given suffix string removed if present.

If the string ends with the suffix string and that suffix is not empty, return string[:-len(suffix)]. Otherwise, return a copy of the original string.

replace ​

python
def replace(self, old, new, count=-1, /)

Return a copy with all occurrences of substring old replaced by new.

count Maximum number of occurrences to replace. -1 (the default value) means replace all occurrences.

If the optional argument count is given, only the first count occurrences are replaced.

rfind ​

python
def rfind(...)

S.rfind(sub[, start[, end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

rindex ​

python
def rindex(...)

S.rindex(sub[, start[, end]]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within S[start:end]. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

rjust ​

python
def rjust(self, width, fillchar=' ', /)

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

rpartition ​

python
def rpartition(self, sep, /)

Partition the string into three parts using the given separator.

This will search for the separator in the string, starting at the end. If the separator is found, returns a 3-tuple containing the part before the separator, the separator itself, and the part after it.

If the separator is not found, returns a 3-tuple containing two empty strings and the original string.

rsplit ​

python
def rsplit(self, /, sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace
character (including \n \r \t \f and spaces) and will discard
empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip ​

python
def rstrip(self, chars=None, /)

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

split ​

python
def split(self, /, sep=None, maxsplit=-1)

Return a list of the substrings in the string, using sep as the separator string.

sep The separator used to split the string.

When set to None (the default value), will split on any whitespace
character (including \n \r \t \f and spaces) and will discard
empty strings from the result.

maxsplit Maximum number of splits. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

Note, str.split() is mainly useful for data that has been intentionally delimited. With natural text that includes punctuation, consider using the regular expression module.

splitlines ​

python
def splitlines(self, /, keepends=False)

Return a list of the lines in the string, breaking at line boundaries.

Line breaks are not included in the resulting list unless keepends is given and true.

startswith ​

python
def startswith(...)

S.startswith(prefix[, start[, end]]) -> bool

Return True if S starts with the specified prefix, False otherwise. With optional start, test S beginning at that position. With optional end, stop comparing S at that position. prefix can also be a tuple of strings to try.

strip ​

python
def strip(self, chars=None, /)

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

swapcase ​

python
def swapcase(self, /)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title ​

python
def title(self, /)

Return a version of the string where each word is titlecased.

More specifically, words start with uppercased characters and all remaining cased characters have lower case.

translate ​

python
def translate(self, table, /)

Replace each character in the string using the given translation table.

table Translation table, which must be a mapping of Unicode ordinals to Unicode ordinals, strings, or None.

The table must implement lookup/indexing via getitem, for instance a dictionary or list. If this operation raises LookupError, the character is left untouched. Characters mapped to None are deleted.

upper ​

python
def upper(self, /)

Return a copy of the string converted to uppercase.

zfill ​

python
def zfill(self, width, /)

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

Tado Objects ​

python
@dataclass
class Tado()

Base class for Tado.

async_init ​

python
async def async_init() -> None

Asynchronous initialization for the Tado object.

device_activation_status ​

python
@property
def device_activation_status() -> DeviceActivationStatus

Return the device activation status.

device_verification_url ​

python
@property
def device_verification_url() -> str | None

Return the device verification URL.

refresh_token ​

python
@property
def refresh_token() -> str | None

Return the refresh token.

login_device_flow ​

python
async def login_device_flow() -> DeviceActivationStatus

Login using device flow.

device_activation ​

python
async def device_activation() -> None

Start the device activation process and get the refresh token.

login ​

python
async def login() -> None

Perform login to Tado.

check_request_status ​

python
async def check_request_status(response_error: ClientResponseError,
                               *,
                               login: bool = False) -> None

Check the status of the request and raise the proper exception if needed.

get_me ​

python
async def get_me() -> GetMe

Get the user information.

get_devices ​

python
async def get_devices() -> list[Device]

Get the devices.

get_mobile_devices ​

python
async def get_mobile_devices() -> list[MobileDevice]

Get the mobile devices.

get_zones ​

python
async def get_zones() -> list[Zone]

Get the zones.

get_zone_states ​

python
async def get_zone_states() -> dict[str, ZoneState]

Get the zone states.

get_zone_state ​

python
async def get_zone_state(zone_id: int) -> ZoneState

Get the zone state.

get_weather ​

python
async def get_weather() -> Weather

Get the weather.

get_home_state ​

python
async def get_home_state() -> HomeState

Get the home state.

get_capabilities ​

python
async def get_capabilities(zone: int) -> Capabilities

Get the capabilities.

reset_zone_overlay ​

python
async def reset_zone_overlay(zone: int) -> None

Reset the zone overlay.

set_presence ​

python
async def set_presence(presence: str) -> None

Set the presence.

set_zone_overlay ​

python
async def set_zone_overlay(zone: int,
                           overlay_mode: str,
                           *,
                           set_temp: float | None = None,
                           duration: int | None = None,
                           device_type: str = "HEATING",
                           power: str = "ON",
                           mode: str | None = None,
                           fan_speed: str | None = None,
                           fan_level: str | None = None,
                           vertical_swing: str | None = None,
                           horizontal_swing: str | None = None,
                           swing: str | None = None) -> None

Set the zone overlay.

get_device_info ​

python
async def get_device_info(
        serial_no: str,
        attribute: str | None = None) -> TemperatureOffset | Device

Get the device info.

set_child_lock ​

python
async def set_child_lock(serial_no: str, *, child_lock: bool) -> None

Set the child lock.

set_meter_readings ​

python
async def set_meter_readings(reading: int,
                             date: datetime | None = None) -> None

Set the meter readings.

update_zone_data ​

python
async def update_zone_data(data: ZoneState) -> None

Update the zone data.

get_auto_geofencing_supported ​

python
async def get_auto_geofencing_supported() -> bool | None

Return whether the Tado Home supports auto geofencing.

close ​

python
async def close() -> None

Close open client session.