From e559cddbc8d988fcf176693e59395e924c1f207a Mon Sep 17 00:00:00 2001 From: Phil Hawthorne Date: Sun, 9 Oct 2016 19:55:33 +1100 Subject: [PATCH] Improve Z-wave climate documentation (#1196) * Change link to Z-wave Getting Started Page Changes the link from the Z-wave component page, to the Z-wave getting started page. The component page directs users to the getting started page, and does not have any information for the user. This should save users a link click. * Add more information about Z-Wave climate control Add examples to the Z-wave climate page to show users how they can automate their Z-wave climate control. --- source/_components/climate.zwave.markdown | 66 ++++++++++++++++++++++- 1 file changed, 64 insertions(+), 2 deletions(-) diff --git a/source/_components/climate.zwave.markdown b/source/_components/climate.zwave.markdown index 6d20fdc01e3..c751b170941 100644 --- a/source/_components/climate.zwave.markdown +++ b/source/_components/climate.zwave.markdown @@ -13,10 +13,72 @@ ha_release: 0.17 --- -To get your Z-Wave thermostat or HVAC unit working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/). +To get your Z-Wave thermostat or HVAC unit working with Home Assistant, follow the instructions for the general [Z-Wave component](/getting-started/z-wave/).

Thermostats with support for fan modes or different operating modes, will be handled like a HVAC device and will also be detected as one. -If the thermostat support different operationg modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file. +If the thermostat support different operating modes, you will get one thermostat entity for each mode. These can be hidden with settings using the customize setting in the `configuration.yaml` file.

+ +To enable the climate component for your Z-Wave network, add the following to your `configuration.yaml` file. + +```yaml +climate: + platform: zwave +``` + +Once enabled, any Z-Wave climate devices will be available to Home Assistant. Multiple entities may be created. The following entities are created for a Remotec ZXT-120. + +- **climate.remotec_zxt120_heating_1_id** Allows you to control the connected device. See below for examples. +- **sensor.remotec_zxt120_temperature_38** A sensor which returns the current temperature set on the attached device. + +### {% linkable_title Automating Z-Wave Climate Devices %} + +The following examples will instruct a Remotec ZXT-120 to turn the attached device mode to Heating, and set the temperature at 24 degrees after 8pm. Add it to `automation.yaml`. + +```yaml +automation: + - alias: Turn on Heater at 8pm + trigger: + - platform: time + after: "20:00:00" + action: + - service: climate.set_operation_mode + entity_id: climate.remotec_zxt120_heating_1_id + data: + operation_mode: Heat + - service: climate.set_temperature + entity_id: climate.remotec_zxt120_heating_1_39 + data: + temperature: 24 +``` + +Generally in Home Assistant you can use the `homeassistant/turn_off` service to turn devices off. For the Remotec ZXT-120, you must instead make a service call like the following. + +```yaml +automation: + - alias: Turn off Heater at 9pm + trigger: + - platform: time + after: "21:00:00" + action: + - service: climate.set_operation_mode + entity_id: climate.remotec_zxt120_heating_1_id + data: + operation_mode: 'Off' +``` + +**Note:** In the example above, the word `Off` is encased in single quotes to be valid YAML. + +### {% linkable_title Test if it works %} + +A simple way to test if your Z-Wave climate device is working is to use service developer tool icon **Services** from the **Developer Tools**. Choose the applicable Climate service from the list of **Available services:** and enter something like the sample below into the **Service Data** field and then press **CALL SERVICE**. + +```json +{ + "entity_id": "climate.remotec_zxt120_heating_1_id", + "operation_mode": "Heat" +} +``` +