Doc for Wink lock services (#2609)

This commit is contained in:
William Scanlon 2017-05-18 04:34:13 -04:00 committed by Fredrik Lindqvist
parent 291f9c8254
commit f4da8b0ac5

View File

@ -24,6 +24,111 @@ The requirement is that you have setup [Wink](/components/wink/).
- Schlage - Schlage
- Generic Z-wave - Generic Z-wave
<p class='note'>
The following services have only been confirmed on Schlage locks.
</p>
### {% linkable_title Service `wink_set_lock_alarm_mode` %}
You can use the service wink/wink_set_lock_alarm_mode to set the alarm mode of your lock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `mode` | no | String one of tamper, activity, or forced_entry
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
```yaml
script:
set_locks_to_tamper:
sequence:
- service: wink.wink_set_lock_alarm_mode
data:
mode: "tamper"
```
### {% linkable_title Service `wink_set_lock_alarm_sensitivity` %}
You can use the service wink/wink_set_lock_alarm_sensitivity to set the alarm sensitivity of your lock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `sensitivity` | no | String one of low, medium_low, medium, medium_high, high
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
```yaml
script:
set_locks_to_high_sensitivity:
sequence:
- service: wink.wink_set_lock_alarm_sensitivity
data:
sensitivity: "high"
```
### {% linkable_title Service `wink_set_lock_alarm_state` %}
You can use the service wink/wink_set_lock_alarm_state to set the alarm state of your lock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `enabled` | no | Boolean enabled or disabled, true or false
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
```yaml
script:
disable_all_locks_alarm:
sequence:
- service: wink.wink_set_lock_alarm_state
data:
enabled: false
```
### {% linkable_title Service `wink_set_lock_beeper_state` %}
You can use the service wink/wink_set_lock_beeper_state to set the beeper state of your lock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `enabled` | no | Boolean enabled or disabled, true or false
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
```yaml
script:
disable_all_locks_beepers:
sequence:
- service: wink.wink_set_lock_beeper_state
data:
enabled: false
```
### {% linkable_title Service `wink_set_lock_vacation_mode` %}
You can use the service wink/wink_set_lock_vacation_mode to set the vacation mode of your lock.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `enabled` | no | Boolean enabled or disabled, true or false
| `entity_id` | yes | String or list of strings that point at `entity_id`s of locks.
Example:
```yaml
script:
enabled_vacation_mode_on_all_locks:
sequence:
- service: wink.wink_set_lock_vacation_mode
data:
enabled: false
```
<p class='note'> <p class='note'>
If supported by your lock, a binary sensor will be created for each user key code you have defined. These key codes will turn on when the code is entered and automatically turn off after a few seconds. If supported by your lock, a binary sensor will be created for each user key code you have defined. These key codes will turn on when the code is entered and automatically turn off after a few seconds.
</p> </p>