Document Climate Services (#1194)

* Document Climate Services

Adds documentation for all the services exposed by the new Climate
platform.

Based on the cover platform documentation.

* Update climate.markdown

Fixed some formatting and spelling.
This commit is contained in:
Phil Hawthorne 2016-10-09 19:32:57 +11:00 committed by Fredrik Lindqvist
parent fe55a42c18
commit 80ef2275f7

View File

@ -20,3 +20,176 @@ climate:
platform: demo
```
## {% linkable_title Services %}
### {% linkable_title Climate control services %}
Available services: `climate.set_aux_heat`, `climate.set_away_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_operation_mode`, `climate.set_swing_mode`
<p class='note'>
Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **Services**.
</p>
### {% linkable_title Service `climate.set_aux_heat` %}
Turn auxiliary heater on/off for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `aux_heat` | no | New value of auxiliary heater.
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_aux_heat
data:
entity_id: climate.kitchen
aux_heat: true
```
### {% linkable_title Service `climate.set_away_mode` %}
Turn away mode on/off for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `away_mode` | no | New value of away mode.
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_away_mode
data:
entity_id: climate.kitchen
away_mode: true
```
### {% linkable_title Service `climate.set_temperature` %}
Set target temperature of climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `temperature` | no | New target temperature for hvac
| `target_temp_high` | yes | New target high temperature for hvac
| `target_temp_low` | yes | New target low temperature for hvac
| `operation_mode` | yes | Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_temperature
data:
entity_id: climate.kitchen
temperature: 24
operation_mode: Heat
```
### {% linkable_title Service `climate.set_humidity` %}
Set target humidity of climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `humidity` | no | New target humidity for climate device
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_humidity
data:
entity_id: climate.kitchen
humidity: 60
```
### {% linkable_title Service `climate.set_fan_mode` %}
Set fan operation for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `fan_mode` | no | New value of fan mode
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_fan_mode
data:
entity_id: climate.kitchen
fan_mode: 'On Low'
```
### {% linkable_title Service `climate.set_operation_mode` %}
Set operation mode for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `operation_mode` | no | New value of operation mode
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_operation_mode
data:
entity_id: climate.kitchen
operation_mode: Heat
```
### {% linkable_title Service `climate.set_swing_mode` %}
Set operation mode for climate device
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all.
| `swing_mode` | no | New value of swing mode
#### {% linkable_title Automation example %}
```yaml
automation:
trigger:
platform: time
after: "07:15:00"
action:
- service: climate.set_swing_mode
data:
entity_id: climate.kitchen
swing_mode: 1
```