home-assistant.io/source/_components/lock.nuki.markdown
Markus Nigbur ccd5340b9c Updated nuki component configuration section (#6745)
* Updated nuki component configuration section

Related to #6385.

* Changed port type to integer
2018-10-13 14:44:27 +02:00

2.3 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, featured, ha_release, ha_iot_class
layout title description date sidebar comments sharing footer logo ha_category featured ha_release ha_iot_class
page Nuki Smart Lock Instructions on how to integrate a Nuki Smart Lock devices. 2017-02-02 09:35 true false true true nuki.png Lock false 0.38 Local Polling

The nuki platform allows you to control Nuki Smart Locks via either a software bridge or a physical bridge.

To add a Nuki bridge to your installation, you need to enable developer mode on your bridge and define a port and an access token. This can be achieved using the Android app. Please note that the API token should be 6-20 characters long, even though the app allows you to set a longer one. Then add the following to your configuration.yaml file:

# Example configuration.yaml entry
lock:
  - platform: nuki
    host: 192.168.1.120
    token: fe2345ef

{% configuration %} host: description: The IP or hostname of the Nuki bridge. required: true type: string port: description: The port on which the Nuki bridge is listening on. required: false default: 8080 type: integer token: description: The token that was defined when setting up the bridge. required: true type: string {% endconfiguration %}

{% linkable_title Services %}

{% linkable_title Service nuki_unlatch %}

This will unlatch the door, ie. open it (provided this works with your type of door).

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_ids Nuki Locks.

{% linkable_title Service nuki_lock_n_go %}

This will first unlock, wait a few seconds (20 by default) then re-lock. The wait period can be customized through the app. See the Nuki Website for more details about this feature.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_ids Nuki Locks.
unlatch yes Boolean - Whether to unlatch the door when first opening it.