From 4204af3b8535ca039f8f44ec986a9fea071c166c Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 10 Jul 2019 22:51:53 +0200 Subject: [PATCH] Updates climate platform docs for Climate 1.0 --- source/_components/climate.markdown | 65 +++++++++-------------------- 1 file changed, 20 insertions(+), 45 deletions(-) diff --git a/source/_components/climate.markdown b/source/_components/climate.markdown index 8b6bd73bc9a..8684a2f58c7 100644 --- a/source/_components/climate.markdown +++ b/source/_components/climate.markdown @@ -19,7 +19,8 @@ The `climate` integration is built for the controlling and monitoring of HVAC (h ## Services ### 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`, `climate.set_hold_mode`, `climate.turn_on`, `climate.turn_off` + +Available services: `climate.set_aux_heat`, `climate.set_preset_mode`, `climate.set_temperature`, `climate.set_humidity`, `climate.set_fan_mode`, `climate.set_hvac_mode`, `climate.set_swing_mode`, `climate.turn_on`, `climate.turn_off`

Not all climate services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking service developer tool icon **Services**. @@ -34,7 +35,7 @@ Turn auxiliary heater on/off for climate device | `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. -#### Automation example +#### Automation example ```yaml automation: @@ -48,18 +49,18 @@ automation: aux_heat: true ``` -### Service `climate.set_away_mode` +### Service `climate.set_preset_mode` -Set away mode for climate device. The away mode changes the target temperature permanently to a temperature +Set preset mode for climate device. The away mode changes the target temperature permanently to a temperature reflecting a situation where the climate device is set to save energy. This may be used to emulate a "vacation mode", for example. | 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. +| `preset_mode` | no | New value of preset mode. -#### Automation example +#### Automation example ```yaml automation: @@ -67,37 +68,10 @@ automation: platform: time at: "07:15:00" action: - - service: climate.set_away_mode + - service: climate.set_preset_mode data: entity_id: climate.kitchen - away_mode: 'on' -``` - - -### Service `climate.set_hold_mode` - -Set hold mode for climate device. The hold mode changes the target temperature of the client device temporarily to -a different temperature. Typical hold modes provided by a climate device are "away" or "home", where the hold temperature -is chosen depending on a predefined climate, or "temperature" hold, where a particular temperature is selected as the -temporary target temperature. The particular modes available depend on the 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. -| `hold_mode` | no | New value of hold mode. - -#### Automation example - -```yaml -automation: - trigger: - platform: time - at: "07:15:00" - action: - - service: climate.set_hold_mode - data: - entity_id: climate.kitchen - hold_mode: 'away' + preset_mode: 'eco' ``` ### Service `climate.set_temperature` @@ -112,7 +86,7 @@ Set target temperature of climate device | `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. -#### Automation example +#### Automation example ```yaml automation: @@ -136,7 +110,7 @@ Set target humidity of climate device | `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 -#### Automation example +#### Automation example ```yaml automation: @@ -159,7 +133,7 @@ Set fan operation for climate device | `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 -#### Automation example +#### Automation example ```yaml automation: @@ -173,16 +147,16 @@ automation: fan_mode: 'On Low' ``` -### Service `climate.set_operation_mode` +### Service `climate.set_hvac_mode` -Set operation mode for climate device +Set HVAC 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 +| `hvac_mode` | no | New value of HVAC mode -#### Automation example +#### Automation example ```yaml automation: @@ -190,10 +164,10 @@ automation: platform: time at: "07:15:00" action: - - service: climate.set_operation_mode + - service: climate.set_hvac_mode data: entity_id: climate.kitchen - operation_mode: Heat + operation_mode: heat ``` ### Service `climate.set_swing_mode` @@ -205,7 +179,7 @@ Set operation mode for climate device | `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 -#### Automation example +#### Automation example ```yaml automation: @@ -218,6 +192,7 @@ automation: entity_id: climate.kitchen swing_mode: 1 ``` + ### Service `climate.turn_on` Turn climate device on