home-assistant.github.io/components/lock.nuki/index.html
2017-04-08 23:38:08 +00:00

175 lines
8.9 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Nuki Smart Lock - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate a Nuki Smart Lock devices.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/lock.nuki/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Nuki Smart Lock">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/lock.nuki/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate a Nuki Smart Lock devices.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Nuki Smart Lock">
<meta name="twitter:description" content="Instructions on how to integrate a Nuki Smart Lock devices.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/docs/">Docs</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Nuki Smart Lock
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">nuki</code> platform allows you to control <a href="https://nuki.io/en/smart-lock/">Nuki Smart Locks</a> via either a <a href="https://play.google.com/store/apps/details?id=io.nuki.bridge">software bridge</a> or a <a href="https://nuki.io/en/bridge/">physical bridge</a>.</p>
<p>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 <a href="https://play.google.com/store/apps/details?id=io.nuki">Android app</a>. 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 <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">lock</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">nuki</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.120</span>
<span class="s">token</span><span class="pi">:</span> <span class="s">fe2345ef</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>host</strong> (<em>Required</em>): The IP or hostname of the Nuki bridge.</li>
<li><strong>port</strong> (<em>Optional</em>): The port on which the Nuki bridge is listening on. Defaults to <code class="highlighter-rouge">8080</code>.</li>
<li><strong>token</strong> (<em>Optional</em>): The token that was defined when setting up the bridge.</li>
</ul>
<h2><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h2>
<p>Heres a full configuration example for a Nuki bridge:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">lock</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">nuki</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">192.168.1.120</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">8080</span>
<span class="s">token</span><span class="pi">:</span> <span class="s">fe2345ef</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/lock.nuki.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/nuki.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.38
</div>
<div class='section'>
This is a platform for
<a href='/components/lock/'>the Locks component</a>.
</div>
<div class='section'>
<h1 class="title delta">Category Lock</h1>
<ul class='divided'>
<li>
<a href='/components/lock.isy994/'>ISY994 Lock</a>
</li>
<li>
<a href='/components/lock.lockitron/'>Lockitron Lock</a>
</li>
<li>
<a href='/components/lock.mqtt/'>MQTT Lock</a>
</li>
<li>
Nuki Smart Lock
</li>
<li>
<a href='/components/lock.vera/'>Vera Lock</a>
</li>
<li>
<a href='/components/lock.verisure/'>Verisure Lock</a>
</li>
<li>
<a href='/components/lock.wink/'>Wink Lock</a>
</li>
<li>
<a href='/components/lock.zwave/'>Z-Wave Lock</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>