mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-20 07:46:52 +00:00
🚜 Merges/Redirect Zwave component pages (#8804)
This commit is contained in:
Klaas Schoute
Franck Nijhof
parent
8d122d5229
commit
abf9b13708
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Binary Sensor"
|
|
||||||
description: "Instructions on how to setup the Z-Wave binary sensors within Home Assistant."
|
|
||||||
date: 2016-02-22 07:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Binary Sensor
|
|
||||||
ha_release: 0.14
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave binary sensors working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
@ -1,83 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Climate"
|
|
||||||
description: "Instructions on how to set up the Z-Wave thermostat or HVAC within Home Assistant."
|
|
||||||
date: 2016-04-03 9:52
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Climate
|
|
||||||
ha_release: 0.17
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
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/).
|
|
||||||
|
|
||||||
<p class='note'>
|
|
||||||
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 supports 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.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
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
|
|
||||||
at: "20:00:00"
|
|
||||||
action:
|
|
||||||
- service: climate.set_operation_mode
|
|
||||||
data:
|
|
||||||
entity_id: climate.remotec_zxt120_heating_1_id
|
|
||||||
operation_mode: Heat
|
|
||||||
- service: climate.set_temperature
|
|
||||||
data:
|
|
||||||
entity_id: climate.remotec_zxt120_heating_1_39
|
|
||||||
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
|
|
||||||
at: "21:00:00"
|
|
||||||
action:
|
|
||||||
- service: climate.set_operation_mode
|
|
||||||
data:
|
|
||||||
entity_id: climate.remotec_zxt120_heating_1_id
|
|
||||||
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 <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **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"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Cover"
|
|
||||||
description: "Instructions on how to setup the Z-Wave covers within Home Assistant."
|
|
||||||
date: 2016-12-18 19:41
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Cover
|
|
||||||
ha_release: 0.23
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
Z-Wave garage doors, blinds, and roller shutters are supported as cover in Home Assistant.
|
|
||||||
|
|
||||||
To get your Z-Wave covers working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
|
|
||||||
If you discover that you need to [invert the operation](/docs/z-wave/installation/#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
zwave:
|
|
||||||
device_config:
|
|
||||||
cover.my_cover:
|
|
||||||
invert_openclose_buttons: true
|
|
||||||
```
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Fan"
|
|
||||||
description: "Instructions on how to setup the Z-Wave Fans within Home Assistant."
|
|
||||||
date: 2017-05-25 17:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_release: 0.38
|
|
||||||
ha_category: Fan
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave fans working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Light"
|
|
||||||
description: "Instructions on how to setup the Z-Wave lights within Home Assistant."
|
|
||||||
date: 2015-11-11 13:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Light
|
|
||||||
ha_release: pre 0.7
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave lights working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
@ -1,24 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Lock"
|
|
||||||
description: "Instructions on how to setup the Z-Wave Locks within Home Assistant."
|
|
||||||
date: 2016-05-07 08:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Lock
|
|
||||||
ha_release: 0.19
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave locks working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
|
|
||||||
Z-Wave locks will expose three services under the lock domain to manage usercodes if the lock supports it:
|
|
||||||
|
|
||||||
| Service | Description |
|
|
||||||
| ------- | ----------- |
|
|
||||||
| clear_usercode | Clears a usercode at code_slot X. Valid code_slots are 1-254, but max is defined by the lock. |
|
|
||||||
| get_usercode | Get a usercode from the lock at code_slot. Valid code_slots are 1-254, but max is defined by the lock. |
|
|
||||||
| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. |
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Sensor"
|
|
||||||
description: "Instructions on how to setup the Z-Wave sensors within Home Assistant."
|
|
||||||
date: 2015-11-15 13:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Sensor
|
|
||||||
ha_release: pre 0.7
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave sensors working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "Z-Wave Switch"
|
|
||||||
description: "Instructions on how to setup the Z-Wave switches within Home Assistant."
|
|
||||||
date: 2015-11-15 13:00
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: z-wave.png
|
|
||||||
ha_category: Switch
|
|
||||||
ha_release: pre 0.7
|
|
||||||
ha_iot_class: "Local Push"
|
|
||||||
---
|
|
||||||
|
|
||||||
To get your Z-Wave switches working with Home Assistant, follow the instructions for the general [Z-Wave component](/components/zwave/).
|
|
||||||
@ -8,13 +8,42 @@ comments: false
|
|||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: z-wave.png
|
logo: z-wave.png
|
||||||
ha_category: Hub
|
ha_category:
|
||||||
|
- Hub
|
||||||
|
- Binary Sensor
|
||||||
|
- Climate
|
||||||
|
- Cover
|
||||||
|
- Fan
|
||||||
|
- Light
|
||||||
|
- Lock
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
featured: true
|
featured: true
|
||||||
ha_iot_class: "Local Push"
|
ha_iot_class: "Local Push"
|
||||||
|
redirect_from:
|
||||||
|
- /components/binary_sensor.zwave/
|
||||||
|
- /components/climate.zwave/
|
||||||
|
- /components/cover.zwave/
|
||||||
|
- /components/fan.zwave/
|
||||||
|
- /components/light.zwave/
|
||||||
|
- /components/lock.zwave/
|
||||||
|
- /components/sensor.zwave/
|
||||||
|
- /components/switch.zwave/
|
||||||
---
|
---
|
||||||
|
|
||||||
The [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component.
|
The [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Please see the [Z-Wave getting started section](/docs/z-wave/) for in-depth documentation on how to use and setup the Z-Wave component.
|
||||||
|
|
||||||
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
|
- Binary Sensor
|
||||||
|
- [Climate](#climate)
|
||||||
|
- [Cover](#cover)
|
||||||
|
- Fan
|
||||||
|
- Light
|
||||||
|
- [Lock](#lock)
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
## {% linkable_title Configuration %}
|
||||||
|
|
||||||
If you have setup the requirements, then add the following entry `configuration.yaml` file:
|
If you have setup the requirements, then add the following entry `configuration.yaml` file:
|
||||||
@ -23,3 +52,101 @@ If you have setup the requirements, then add the following entry `configuration.
|
|||||||
# Example configuration.yaml entry
|
# Example configuration.yaml entry
|
||||||
zwave:
|
zwave:
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Climate %}
|
||||||
|
|
||||||
|
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/).
|
||||||
|
|
||||||
|
<p class='note'>
|
||||||
|
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 supports 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.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
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
|
||||||
|
at: "20:00:00"
|
||||||
|
action:
|
||||||
|
- service: climate.set_operation_mode
|
||||||
|
data:
|
||||||
|
entity_id: climate.remotec_zxt120_heating_1_id
|
||||||
|
operation_mode: Heat
|
||||||
|
- service: climate.set_temperature
|
||||||
|
data:
|
||||||
|
entity_id: climate.remotec_zxt120_heating_1_39
|
||||||
|
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
|
||||||
|
at: "21:00:00"
|
||||||
|
action:
|
||||||
|
- service: climate.set_operation_mode
|
||||||
|
data:
|
||||||
|
entity_id: climate.remotec_zxt120_heating_1_id
|
||||||
|
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 <img src='/images/screenshots/developer-tool-services-icon.png' alt='service developer tool icon' class="no-shadow" height="38" /> **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"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Cover %}
|
||||||
|
|
||||||
|
Z-Wave garage doors, blinds, and roller shutters are supported as cover in Home Assistant.
|
||||||
|
|
||||||
|
To get your Z-Wave covers working with Home Assistant, follow the instructions for the general [Z-Wave component](#configuration).
|
||||||
|
|
||||||
|
If you discover that you need to [invert the operation](/docs/z-wave/installation/#invert_openclose_buttons) of open/close for a particular device, you may change this behavior in your Z-Wave section of your `configuration.yaml` file as follows:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
zwave:
|
||||||
|
device_config:
|
||||||
|
cover.my_cover:
|
||||||
|
invert_openclose_buttons: true
|
||||||
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Lock %}
|
||||||
|
|
||||||
|
To get your Z-Wave locks working with Home Assistant, follow the instructions for the general [Z-Wave component](#configuration).
|
||||||
|
|
||||||
|
Z-Wave locks will expose three services under the lock domain to manage usercodes if the lock supports it:
|
||||||
|
|
||||||
|
| Service | Description |
|
||||||
|
| ------- | ----------- |
|
||||||
|
| clear_usercode | Clears a usercode at code_slot X. Valid code_slots are 1-254, but max is defined by the lock. |
|
||||||
|
| get_usercode | Get a usercode from the lock at code_slot. Valid code_slots are 1-254, but max is defined by the lock. |
|
||||||
|
| set_usercode | Sets usercode to X at code_slot Y. Valid usercodes are at least 4 digits, and max defined by the lock. |
|
||||||
Loading…
x
Reference in New Issue
Block a user