home-assistant.io/source/_components/lock.nuki.markdown
2017-02-24 22:40:40 +01:00

48 lines
1.5 KiB
Markdown

---
layout: page
title: "Nuki Smart Lock"
description: "Instructions on how to integrate a Nuki Smart Lock devices."
date: 2017-02-02 09:35
sidebar: true
comments: false
sharing: true
footer: true
logo: nuki.png
ha_category: Lock
featured: false
ha_release: 0.38
ha_iot_class: "Local Polling"
---
The `nuki` platform allows you to control [Nuki Smart Locks](https://nuki.io/en/smart-lock/) via either a [software bridge](https://play.google.com/store/apps/details?id=io.nuki.bridge) or a [physical bridge](https://nuki.io/en/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](https://play.google.com/store/apps/details?id=io.nuki). 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:
```yaml
# Example configuration.yaml entry
lock:
- platform: nuki
host: 192.168.1.120
token: fe2345ef
```
Configuration variables:
- **host** (*Required*): The IP or hostname of the Nuki bridge.
- **port** (*Optional*): The port on which the Nuki bridge is listening on. Defaults to `8080`.
- **token** (*Optional*): The token that was defined when setting up the bridge.
## {% linkable_title Full configuration %}
Here's a full configuration example for a Nuki bridge:
```yaml
# Example configuration.yaml entry
lock:
- platform: nuki
host: 192.168.1.120
port: 8080
token: fe2345ef
```