Add water heater set timer service info (#13689)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
jfearon 2020-07-05 13:20:17 +01:00 committed by GitHub
parent 8bcdb9ef92
commit 731b0e68b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -140,3 +140,28 @@ If the above method returns an unauthorized error. The `home_id` can also be fou
The `home_id` appears in the response for users as `"id":12345`
In this example `12345` is the `home_id` you'll need to configure.
## Services
### Service `tado.set_water_heater_timer`
You can use the service `tado.set_water_heater_timer` to set your water heater to switch on for a set time period.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | yes | String, Name of entity e.g., `climate.heating` |
| `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` |
| `temperature` | yes | String, The required target temperature e.g., `20.5` |
Examples:
```yaml
# Example script to set a timer for the water heater with no temperature specified
script:
boost_heating:
sequence:
- service: tado.set_water_heater_timer
data:
entity_id: "water_heater.hot_water"
time_period: "01:30:00"
```