Add docs for Nuki callbacks (#26289)

This commit is contained in:
Pascal Reeb 2023-03-28 11:41:40 +02:00 committed by GitHub
parent 1b3cf0eece
commit 9cb1c2d3d6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,7 +4,7 @@ description: Instructions on how to integrate a Nuki Smart Lock devices.
ha_category:
- Lock
ha_release: 0.38
ha_iot_class: Local Polling
ha_iot_class: Local Push
ha_codeowners:
- '@pschmitt'
- '@pvizeli'
@ -24,9 +24,19 @@ The Nuki integration allows you to control [Nuki Smart Locks](https://nuki.io/en
## 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](https://play.google.com/store/apps/details?id=io.nuki) or [iPhone app](https://apps.apple.com/app/nuki-smart-lock/id1044998081). 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.
For faster updates, the callback function of the Nuki bridge can be used. This requires your Home Assistant to be reachable via HTTP by the Nuki bridge, as HTTPS is not supported by the Nuki bridge.
{% include integrations/config_flow.md %}
{% configuration_basic %}
Host:
description: Hostname or IP address of your Nuki bridge, e.g., `192.168.1.25`.
Port:
description: Port of the Nuki bridge HTTP API, default is `8080`.
Token:
description: Token to authenticate against the Nuki bridge HTTP API.
{% endconfiguration_basic %}
## Services
### Service `nuki.lock_n_go`