Skip to main content

A library (and a command line client) to control your Tado Smart Thermostat.

Project description

Tado python library

Libtado Logo

License: GPL-3.0 GitHub Repo stars

build Docs

A library to control your Tado Smart Thermostat. This repository contains an actual library in libtado/api.py and a proof of concept command line client in libtado/__main__.py.

The tested version of APIs is Tado v2.

⚠️ Breaking change in v4 ⚠️

Starting the 21st of March 2025, the Tado authentication workflow will definitely change to OAuth2 device code grant flow.

Here is the link to the official announcement: Tado Support Article - How do I authenticate to access the REST API?

Now, you have to use the TADO_CREDENTIALS_FILE or TADO_REFRESH variables to authenticate. You can find more documentation on how to authenticate in the Libtado - CLI Configuration documentation.

Installation

You can download official library with pip install libtado.

But because I do not own a Tado anymore you may want to use a fork of libtado instead. For example you can install the fork that is currently (February 2019) maintained and improved by @germainlefebvre4. Please note that I do not monitor or verify changes of this repository. Please check the source yourself.

git clone https://github.com/germainlefebvre4/libtado.git

Please check out https://libtado.readthedocs.io for more documentation.

Usage

Download the repository. You can work inside it. Beware that the examples assume that they can access the file ./libtado/api.py.

Define a location and filename that will hold the credentials (refresh token) of your Tado login.

It is recommended to use a directory that only your application has access to, as the credentials file holds sensitive information!

Now you can call it in your Python script!

import libtado.api
import webbrowser   # only needed for direct web browser access

# TODO check
t = api.Tado(token_file='/tmp/.libtado_refresh_token.json')
# OR: t = api.Tado(saved_refresh_token='my_refresh_token')

status = t.get_device_activation_status()

if status == "PENDING":
    url = t.get_device_verification_url()

    # to auto-open the browser (on a desktop device), un-comment the following line:
    # webbrowser.open_new_tab(url)

    t.device_activation()

    status = t.get_device_activation_status()

if status == "COMPLETED":
    print("Login successful")
else:
    print(f"Login status is {status}")


print(t.get_me())
print(t.get_home())
print(t.get_zones())
print(t.get_state(1))

The first time, the script will tell you to login to your Tado account.

It will show an output like:

Please visit the following URL in your Web browser to log in to your Tado account: https://login.tado.com/oauth2/device?user_code=1234567
Waiting for you to complete logging in. You have until yyyy-MM-dd hh:mm:ss
.

Complete your login before the time indicated.

Afterwards, the script should print the information from your Tado home.

If using the token_file, the next time you should not have to sign in.

Examples

An example script is provided in the repository as example.py. It shows you how to use the library and expose some structured responses. A more detailed example is available in libtado/__main__.py.

Supported version and deprecations

Python

Python version Supported versions
3.7 2.0.0 > 3.6.x
3.8 3.7.0 > latest
3.9 3.7.0 > latest
3.10 3.7.0 > latest
3.11 3.7.0 > latest
3.12 3.7.0 > latest

Contributing

We thank everyone for their help and contributions to the library.

You want to report a bug? Create an issue

You want to request a feature? Create an issue

You want to contribute to the library? Read the Contributing page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libtado-4.0.1.tar.gz (36.2 kB view details)

Uploaded Source

Built Distribution

libtado-4.0.1-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file libtado-4.0.1.tar.gz.

File metadata

  • Download URL: libtado-4.0.1.tar.gz
  • Upload date:
  • Size: 36.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.11 Linux/6.8.0-1021-azure

File hashes

Hashes for libtado-4.0.1.tar.gz
Algorithm Hash digest
SHA256 80e0042cde8def456275660b8f9dfbecc76b62ca2eb9529755e46eac0f02b720
MD5 0ed3aa3fcd8afbbe9575a20656b54666
BLAKE2b-256 b7d3252072c40534745a917c90f1857d6c46c6abee621123b9a356c7e714cb27

See more details on using hashes here.

File details

Details for the file libtado-4.0.1-py3-none-any.whl.

File metadata

  • Download URL: libtado-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.11.11 Linux/6.8.0-1021-azure

File hashes

Hashes for libtado-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4d931db61b53db04c382c1c003d37fcdec0551eef16554342910f5a707ad437
MD5 2ce3e76aaeba9780be012d92177219c3
BLAKE2b-256 a808a90f9a43313a6942579c83371ccf4873b56c7c95aee24b544ec3b4be387b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page