https://github.com/webmatze/tado_client
a Ruby client for the tado thermostat API
https://github.com/webmatze/tado_client
ruby-client tado tado-api
Last synced: 4 months ago
JSON representation
a Ruby client for the tado thermostat API
- Host: GitHub
- URL: https://github.com/webmatze/tado_client
- Owner: webmatze
- License: mit
- Created: 2022-12-06T16:52:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-06T22:56:12.000Z (over 2 years ago)
- Last Synced: 2025-01-09T10:28:02.935Z (5 months ago)
- Topics: ruby-client, tado, tado-api
- Language: Ruby
- Homepage:
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tado API client
a Ruby client for the tado thermostat API
## Current and Planned Features
- [x] OAuth Authentification
- [x] Get user (me) data
- [ ] Get/Set temperature of a room
## Installation
Bundler
```ruby
# add to your Gemfile
gem 'tado_client'
```
as Gem:
```bash
gem install tado_client
```
## Usage (WIP)
Get an access token:
```ruby
access_token = Tado::OAuth.access_token(
username: 'username',
password: '',
client_id: 'client-id',
client_secret: ''
)
```
Set temperature for a home zone:
```ruby
require 'tado_client'
# Replace with your tado access token
access_token = 'your_access_token'
# Replace with your desired temperature
target_temperature = 21.5
# Create a new Tado::Client
client = Tado::Client.new(access_token: access_token)
# Get the user's data
me_data = client.me
# Get the first home and zone
home = me_data.homes.first
zone = home.zones.first
# Set the target temperature for the zone
zone.set_temperature(target_temperature)
```
This API will change while developing this gem.