home-assistant.io/source/_components/lock.wink.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class
page	Wink Lock	Instructions on how to setup the Wink locks within Home Assistant.	2015-11-20 12:00	true	false	true	true	wink.png	Lock	0.9	Cloud Polling

The Wink lock platform allows you to control your Wink locks.

The requirement is that you have setup Wink.

Supported lock devices

• Kwikset
• Schlage
• August (No Wink hub required) (August Connect required)
• Generic Z-wave

The following services have only been confirmed on Schlage locks.

{% 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_ids of locks.

Example:

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_ids of locks.

Example:

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_ids of locks.

Example:

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_ids of locks.

Example:

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_ids of locks.

Example:

script:
  enabled_vacation_mode_on_all_locks:
    sequence:
      - service: wink.wink_set_lock_vacation_mode
        data:
          enabled: false

{% linkable_title Service wink_add_new_lock_key_code %}

You can use the service wink/wink_add_new_lock_key_code to add a new user code to your Wink lock.

Service data attribute	Optional	Description
entity_id	no	String or list of strings that point at entity_ids of locks.
name	no	the name of the new key code
code	no	The new code. Must match length of existing codes.

Calling service wink/pull_newly_added_wink_devices will add the new key code to Home Assistant. The device will also show up on the next restart of Home Assistant.

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.