home-assistant.io/source/_integrations/nuki.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain

title	description	ha_category	ha_release	ha_iot_class	ha_codeowners	ha_domain
Nuki	Instructions on how to integrate a Nuki Smart Lock devices.	Lock	0.38	Local Polling	@pvizeli	nuki

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 or iPhone app. Go to manage my devices, and select the bridge. Within the bridge configuration turn on the HTTP API and check the details in the screen. 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 %}

Services

Service 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.