CLI Reference¶

tado¶

Example¶

This script provides a command line client for the Tado API.

You can use the environment variables TADO_USERNAME, TADO_PASSWORD and TADO_CLIENT_SECRET instead of the command line options.

Call 'tado COMMAND --help' to see available options for subcommands.

Usage:

tado [OPTIONS] COMMAND [ARGS]...

Options:

  -u, --username TEXT       Tado username  [required]
  -p, --password TEXT       Tado password  [required]
  -c, --client-secret TEXT  Tado client secret  [required]
  --help                    Show this message and exit.

Subcommands

capabilities: Display the capabilities of a zone.
devices: Display all devices.
early-start: Display or change the early start feature of a zone.
end-manual-control: End manual control of a zone.
energy-consumption: Get the energy consumption of your home.
energy-savings: Get the energy savings of your home.
heating-running-times: Display heating system running times of your home.
heating-system: Display heating systems status of your home..
home: Display information about your home.
mobile: Display all mobile devices.
schedule-block-day-type: Get the day type schedule block of a zone.
schedule-blocks: Get the schedule blocks of a zone.
set-temperature: Set the desired temperature of a zone.
status: Show current status.
users: Display all users of your home.
whoami: Tell me who the Tado API thinks I am.
zone: Get the current state of a zone.
zone-states: Get the states of a zone.
zones: Get configuration information about all zones.

tado capabilities¶

Display the capabilities of a zone.

Usage:

tado capabilities [OPTIONS]

Options:

  -z, --zone INTEGER  Zone ID  [required]
  --help              Show this message and exit.

tado devices¶

Display all devices. If you have unsupported devices it will show you the JSON output.

Usage:

tado devices [OPTIONS]

Options:

  --help  Show this message and exit.

tado early-start¶

Display the current early start configuration of a zone or change it.

Usage:

tado early-start [OPTIONS]

Options:

  -z, --zone INTEGER  Zone ID  [required]
  -s, --set [on|off]
  --help              Show this message and exit.

tado end-manual-control¶

End manual control of a zone.

Usage:

tado end-manual-control [OPTIONS]

Options:

  -z, --zone INTEGER  Zone ID  [required]
  --help              Show this message and exit.

tado energy-consumption¶

Get the energy consumption of your home.

Usage:

tado energy-consumption [OPTIONS]

Options:

  -df, --from-date TEXT       From date  [required]
  -dt, --to-date TEXT         To date  [required]
  -c, --country TEXT          Country code  [required]
  -ng, --ngsw-bypass BOOLEAN  NGSW Bypass
  --help                      Show this message and exit.

tado energy-savings¶

Get the energy savings of your home.

Usage:

tado energy-savings [OPTIONS]

Options:

  -d, --month-date TEXT       Month year (i.e. 2022-09)  [required]
  -c, --country TEXT          Country code  [required]
  -ng, --ngsw-bypass BOOLEAN  NGSW Bypass
  --help                      Show this message and exit.

tado heating-running-times¶

Display heating system running times of your home.

Usage:

tado heating-running-times [OPTIONS]

Options:

  -d, --from-date TEXT  From date
  --help                Show this message and exit.

tado heating-system¶

Display heating systems status of your home..

Usage:

tado heating-system [OPTIONS]

Options:

  --help  Show this message and exit.

tado home¶

Display information about your home.

Usage:

tado home [OPTIONS]

Options:

  --help  Show this message and exit.

tado mobile¶

Display all mobile devices.

Usage:

tado mobile [OPTIONS]

Options:

  --help  Show this message and exit.

tado schedule-block-day-type¶

Get the day type schedule block of a zone.

Usage:

tado schedule-block-day-type [OPTIONS]

Options:

  -z, --zone INTEGER      Zone ID  [required]
  -s, --schedule INTEGER  Schedule ID  [required]
  -d, --day-type TEXT     Day type  [required]
  --help                  Show this message and exit.

tado schedule-blocks¶

Get the schedule blocks of a zone.

Usage:

tado schedule-blocks [OPTIONS]

Options:

  -z, --zone INTEGER      Zone ID  [required]
  -s, --schedule INTEGER  Schedule ID  [required]
  --help                  Show this message and exit.

tado set-temperature¶

Set the desired temperature of a zone.

Usage:

tado set-temperature [OPTIONS]

Options:

  -z, --zone INTEGER         Zone ID  [required]
  -t, --temperature INTEGER  Temperature  [required]
  -x, --termination TEXT     Termination settings
  --help                     Show this message and exit.

tado status¶

Show the current home status in a list form

Usage:

tado status [OPTIONS]

Options:

  --help  Show this message and exit.

tado users¶

Display all users of your home.

Usage:

tado users [OPTIONS]

Options:

  --help  Show this message and exit.

tado whoami¶

This command authenticates against the Tado API and asks for details about the account you used to login. It is helpful to verify if your credentials work.

Usage:

tado whoami [OPTIONS]

Options:

  --help  Show this message and exit.

tado zone¶

Get the current state of a zone. Including temperature, humidity and heating power.

Usage:

tado zone [OPTIONS]

Options:

  -z, --zone INTEGER  Zone ID  [required]
  --help              Show this message and exit.

tado zone-states¶

Get the states of a zone.

Usage:

tado zone-states [OPTIONS]

Options:

  --help  Show this message and exit.

tado zones¶

Get configuration information about all zones.

Usage:

tado zones [OPTIONS]

Options:

  --help  Show this message and exit.