2022-06-29 18:40:28 +02:00

2.8 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain, ha_platforms, ha_config_flow, ha_dhcp, ha_integration_type
title description ha_category ha_release ha_iot_class ha_codeowners ha_domain ha_platforms ha_config_flow ha_dhcp ha_integration_type
Nuki Instructions on how to integrate a Nuki Smart Lock devices.
Lock
0.38 Local Polling
@pschmitt
@pvizeli
@pree
nuki
binary_sensor
lock
true true integration

The Nuki integration allows you to control Nuki Smart Locks via a Nuki Bridge.

Prerequisites

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.

{% include integrations/config_flow.md %}

Services

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.

Service nuki.set_continuous_mode

This service allows you to enable or disable the "Continuous Mode" feature of Nuki Openers. This is similar to the Ring-to-Open feature that is mapped to "lock/unlock", except that it doesn't have a time limit - as long as this mode is enabled, the door will open when the buzzer button is pressed, similar to how it works at e.g. a doctor's office or other business during the day. On other Nuki products, this service is a no-op.

Service data attribute Optional Description
entity_id yes String or list of strings that point at entity_ids Nuki Locks.
enabled yes Boolean - Set to true to enable Continuous Mode, or false to disable.

Events

Event nuki_event

Events generated by Nuki are sent as events of type nuki_event with the following content:

Event data attribute Description
type The type of the event. Values: ring
entity_id The ID of the entity generating the event.