tado-exporter

Tadoº exporter

tado-export exports Tadoº Smart Thermostat metrics to Prometheus.

⚠ Breaking change in v0.19.0

As of v0.19.0, tado-exporter only supports exporting metrics to Prometheus. The more advances functions (controlling the heating, the slack interface, etc.) have been moved to a separate proteus project.

⚠ Tadoº is lowering its rate limits

Tadoº has recently announced they will be lowering the rate limits for their API. As a result, tado-exporter may start to fail with a 429 error.

tado-exporter makes no effort to handle this or reduce the number of requests it makes. It is recommended to reduce the scrape interval in your Prometheus configuration.

Installation

Container images are available on ghcr.io.

Running

Command-line options

The following command-line arguments are supported:

Usage:
  -log.format string
        log format (default "text")
  -log.level string
        log level (default "info")
  -prom.addr string
        prometheus listen address (default ":9100")
  -prom.path string
        prometheus path (default "/metrics")
  -token.passphrase string
        passphrase to encrypt the token
  -token.path string
        path to store the (encrypted) token```

Prometheus

Adding tado as a target

Add tado as a target to let Prometheus scrape the metrics into its database. This highly depends on your particular Prometheus configuration. In its simplest form, add a new scrape target to prometheus.yml:

scrape_configs:
- job_name: tado
  static_configs:
  - targets: [ '<tado host>:<port>' ]

where port is the Prometheus listener port configured in exporter.addr.

Metrics

See METRICS.md for details.

Tadoº client implementation

tado uses the Tadoº Go Client found at GitHub. Feel free to reuse for your own projects.

Authors

• Christophe Lambin

Acknowledgements

• tado OpenAPI specification by Kristel.
• Max Rosin for his Python implementation of the Tado API
• vide/tado-exporter for some inspiration

License

This project is licensed under the MIT License - see the LICENSE.md file for details.