Zum Hauptinhalt springen

Nuki Community-Integration, kostenlos und Open Source

Nuki-Integration für Gladys Assistant

Nuki Smart Lock, Opener und Smart Door: über Bridge, MQTT oder Nuki Web.

Steuern Sie Ihre Nuki-Geräte mit Gladys: Smart Lock (alle Generationen, 3.0 Pro, 4. Generation, Ultra), Smart Door und Opener — verriegeln, entriegeln, die Tür öffnen, Batterien, Türsensor und Keypad überwachen und in Szenen auf jeden Vorgang reagieren.

Wählen, wie Gladys mit Ihren Nuki-Geräten spricht​

Die Integration unterstützt drei Kanäle. Konfigurieren Sie mindestens einen; Sie können sie kombinieren.

KanalTypGeräteWas er bietet
Nuki BridgeLokal (HTTP)Alle Smart Locks, Smart Doors und OpenerFunktioniert ohne Internet, Klingelerkennung des Openers
MQTTLokal (Echtzeit)Smart Lock 3.0 Pro, 4. Generation, UltraSofortige Updates ohne Abfrage, wer/wie bei jedem Vorgang (Knopf, Keypad…)
Nuki WebCloudAlle mit Ihrem Nuki-Web-Konto verknüpften GeräteWer das Schloss bedient hat (Name, Keypad, Fingerabdruck), Aktivitätsprotokoll

Erreichen mehrere Kanäle ein Gerät, nutzt Gladys zuerst den lokalen (MQTT, dann die Bridge) und weicht bei einem Fehler auf den anderen aus. Deaktivieren Sie Lokale Verbindung bevorzugen in der Konfiguration, um zuerst Nuki Web zu nutzen. Das Abzeichen jedes Geräts zeigt den verwendeten Kanal: Lokal, Cloud oder Nicht erreichbar; ein orangefarbener Punkt bedeutet einen Ausweichbetrieb (z. B. Bridge offline, stattdessen Nuki Web).

Einrichtung​

Nuki Bridge (lokal)​

  1. Öffnen Sie in der Nuki-App Bridge verwalten und aktivieren Sie die HTTP-API.
  2. Öffnen Sie in Gladys die Konfiguration der Nuki-Integration und klicken Sie auf Meine Bridge finden: die IP-Adresse wird eingetragen (oder geben Sie sie ein, sie steht in der Nuki-App).
  3. Klicken Sie auf Bridge koppeln und drücken Sie dann innerhalb von 30 Sekunden den Knopf der Bridge: das API-Token wird automatisch gespeichert. Sie können auch das in der App angezeigte Token übernehmen.
  4. Lassen Sie Token gehasht senden aktiviert (Bridge-Firmware 1.13 oder neuer): das Token wird nie im Klartext übertragen.

Geben Sie der Bridge im Router eine feste IP-Adresse: ändert sie sich, starten Sie Meine Bridge finden erneut.

MQTT (lokal, Smart Lock 3.0 Pro / 4.0 / Ultra)​

  1. Sie benötigen einen MQTT-Broker (Mosquitto…). Der der Gladys-MQTT-Integration funktioniert.
  2. Öffnen Sie in der Nuki-App die Schloss-Einstellungen → Funktionen & Konfiguration → MQTT, aktivieren Sie es und tragen Sie IP-Adresse, Port, Benutzer und Passwort des Brokers ein.
  3. Geben Sie in Gladys die URL des MQTT-Brokers (z. B. mqtt://192.168.1.10:1883), Benutzer und Passwort ein. Die Schlösser erscheinen innerhalb von Sekunden.

Nuki Web (Cloud)​

  1. Aktivieren Sie Nuki Web für Ihre Geräte in der Nuki-App.
  2. Öffnen Sie auf web.nuki.io API und erzeugen Sie ein API-Token mit mindestens den Rechten Smartlock, Smartlock action und Smartlock log.
  3. Fügen Sie es in Nuki Web API-Token ein.

Geräte anlegen​

Öffnen Sie den Tab Erkennung der Integration und legen Sie die gewünschten Geräte an. Koppeln Sie später einen Türsensor oder ein Keypad, bietet der Tab an, das Gerät zu aktualisieren.

Optionen​

  • Aktualisierungsintervall: wie oft die Bridge abgefragt wird (mindestens 10 s, Standard 30 s). Nuki Web wird höchstens alle 30 Sekunden und nur bei Bedarf abgefragt. MQTT braucht keine Abfrage.
  • Wenn Gladys entriegelt: Nur entriegeln (Standard) oder Entriegeln und Tür öffnen.
  • Wenn Gladys verriegelt: Verriegeln (Standard) oder Doppelt verriegeln (zwei Umdrehungen, ab Smart Lock 3.0; bei älteren Modellen einfach verriegeln).

Geräte und Funktionen​

Smart Lock / Smart Door

FunktionBeschreibung
SchlossSchalter: 1 = verriegelt, 0 = entriegelt (steuerbar)
SchlosszustandVerriegelt / entriegelt / in Bewegung / Fehler
BatterieLadestand in %
Batterie schwachWarnung bei kritischer Batterie
LädtLaden des Power Packs (ab 3.0)
TürOffen / geschlossen (wenn ein Türsensor gekoppelt ist)
Türsensor-Batterie(wenn ein Türsensor gekoppelt ist)
Keypad-Batterie(wenn ein Keypad gekoppelt ist)

Opener: Schalter Ring to Open und Daueröffnung, Batterie schwach und Klingel (Klingelerkennung über die Bridge).

Szenen​

Auslöser​

  • Nuki-Schloss bedient — ein Schloss wurde ver-, entriegelt, geöffnet oder hat Lock 'n' Go genutzt. Filtern Sie nach Schloss, Vorgang, wie es bedient wurde (App, von Hand, Knopf, Keypad, Fingerabdruck, Auto-Lock, Nuki Web, HomeKit, MQTT, Gladys…) und nach dem Nuki-Benutzer (mit Nuki Web). Variablen: action, trigger, user, device_name. Beispiel: „wenn Alice die Haustür per Keypad entriegelt, Alarm ausschalten“.
  • Nuki Opener: es hat geklingelt — jemand hat an der Sprechanlage geklingelt (Opener mit Bridge).
  • Problem mit Nuki-Schloss — Motor blockiert, Schloss nicht kalibriert oder Befehl abgelehnt.
  • Nuki-Batterie kritisch — die Batterie eines Schlosses, Openers, Keypads oder Türsensors ist schwach.

Von Gladys selbst ausgelöste Vorgänge werden mit dem Auslöser gladys gemeldet: schließen Sie ihn im Filter aus, damit eine Szene nicht auf ihre eigenen Aktionen reagiert.

Aktionen​

  • Nuki-Schloss bedienen — verriegeln, entriegeln, Tür öffnen, Lock 'n' Go, doppelt verriegeln. Ausgabe: success.
  • Nuki Opener bedienen — Türsummer, Ring to Open ein/aus, Daueröffnung ein/aus. Ausgabe: success.
  • Nuki-Gerät auslesen — Ausgaben locked, state, door_open, battery, battery_critical, reachable für die folgenden Aktionen (z. B. Nachricht „die Tür ist noch entriegelt“).
  • Alle Nuki-Schlösser verriegeln — Ausgaben locked_count und failed_count.

Der Standard-Auslöser „Gerätezustand“ von Gladys funktioniert ebenfalls für jede Funktion (Tür geöffnet, Batterie unter 20 %…).

Dashboard-Widgets​

  • Nuki-Schloss — ein Schloss oder Opener: Zustand, Live-Batterie, Tür, Zubehör, Kanal, letzte Aktivität und Tasten Verriegeln / Entriegeln / Tür öffnen (das Öffnen verlangt eine Bestätigung). Beim Opener: Öffnen und Ring to Open.
  • Nuki-Übersicht — alle Nuki-Geräte auf einen Blick und eine Taste Alle verriegeln.
  • Nuki-Aktivität — die letzten Vorgänge: wer, wie und wann (aus Nuki Web, falls konfiguriert, sonst aus den Beobachtungen der Integration).

Fehlerbehebung​

  • „The Nuki Bridge refused the API token“: koppeln Sie die Bridge erneut oder deaktivieren Sie Token gehasht senden, wenn die Bridge-Firmware älter als 1.13 ist.
  • „Nuki Bridge unreachable“: prüfen Sie die IP-Adresse und ob die HTTP-API aktiviert ist. Die Bridge bearbeitet eine Anfrage nach der anderen: vermeiden Sie, dass andere Software sie zu oft abfragt.
  • MQTT: kein Schloss erscheint: prüfen Sie in der Nuki-App, dass MQTT verbunden ist, das Schloss die IP-Adresse des Brokers nutzt und Gladys denselben Broker verwendet.
  • Kein Benutzername in den Auslösern: die Namen kommen von Nuki Web; fügen Sie ein API-Token hinzu.
  • Die Taste Verbindung testen prüft jeden konfigurierten Kanal und zeigt, was funktioniert.

Datenschutz und Sicherheit​

Tokens und Passwörter werden von Gladys als Geheimnisse gespeichert und nie protokolliert. Das Bridge-Token wird standardmäßig gehasht gesendet. Nuki Web wird nur kontaktiert, wenn Sie ein API-Token konfigurieren. Der Aktivitätsverlauf liegt im eigenen Datenvolume der Integration.

Konfigurationseinstellungen​

Diese Einstellungen fragt Nuki in seinem Konfigurationsbildschirm in Gladys ab.

EinstellungTypPflichtfeldBeschreibung
Nuki-Geräte verbindensectionNeinFüllen Sie mindestens einen der drei Kanäle unten aus. Bridge und MQTT sind lokal (schnell, funktionieren ohne Internet); Nuki Web läuft über die Cloud und zeigt auch, wer das Schloss bedient hat. Sie können sie kombinieren: Gladys nutzt zuerst den lokalen Kanal und weicht bei Bedarf auf den anderen aus (siehe „Lokale Verbindung bevorzugen“).
Nuki Bridge (lokal)sectionNeinÖffnen Sie in der Nuki-App die Bridge-Einstellungen und aktivieren Sie die HTTP-API. Nutzen Sie dann unten „Meine Bridge finden“ und „Bridge koppeln“ (drücken Sie den Bridge-Knopf, wenn Sie dazu aufgefordert werden), oder übernehmen Sie IP-Adresse und API-Token aus der App.
IP-Adresse der BridgestringNein
Port der BridgenumberNein
API-Token der BridgesecretNeinWird von „Bridge koppeln“ automatisch ausgefüllt.
Token gehasht sendenbooleanNeinEmpfohlen: das Token wird nie im Klartext über Ihr Netzwerk übertragen. Nur für eine Bridge-Firmware älter als 1.13 deaktivieren.
MQTT (lokal, Echtzeit)sectionNeinFür Smart Lock 3.0 Pro, 4. Generation und Ultra: aktivieren Sie in der Nuki-App MQTT und tragen Sie Ihren Broker im Schloss ein (mit seiner IP-Adresse). Geben Sie hier denselben Broker ein. Änderungen kommen sofort an, ohne Abfrage.
URL des MQTT-BrokersstringNein
MQTT-BenutzernamestringNein
MQTT-PasswortsecretNein
Nuki Web (Cloud)sectionNeinAktivieren Sie Nuki Web in der Nuki-App, öffnen Sie dann auf web.nuki.io „API“ und erzeugen Sie ein API-Token mit den Rechten smartlock, smartlock action und log. Nuki Web zeigt außerdem, wer ver- oder entriegelt hat (Benutzer, Keypad, Fingerabdruck...).
Nuki Web API-TokensecretNein
OptionensectionNeinWie oft Bridge und Nuki Web abgefragt werden (MQTT braucht keine Abfrage) und was der Schloss-Schalter von Gladys tut.
Aktualisierungsintervall (s)numberNeinSekunden zwischen zwei Abfragen der Bridge (mindestens 10). Nuki Web wird höchstens alle 30 Sekunden abgefragt.
Wenn Gladys entriegeltselectNein
Wenn Gladys verriegeltselectNein

So installierst du Nuki in Gladys​

  1. Öffne in Gladys Integrationen: Nuki erscheint im Katalog neben den nativen Integrationen, mit einem Community-Badge.
  2. Klicke auf Installieren. Gladys lädt das Docker-Image (ghcr.io/gboulvin/gladys-nuki:1.0.1) herunter, startet es in einer vom Kern isolierten Sandbox und erzeugt die Oberfläche der Integration (Geräte, Erkennung und Konfiguration).
  3. Öffne den Bildschirm Konfiguration der Integration, fülle die Einstellungen aus und speichere.
  4. Du kannst sie auch direkt über die URL ihres Repositorys installieren: https://github.com/gboulvin/Gladys-Nuki.

Nuki benötigt Gladys >=5.1.0. Der Katalog in Gladys wird stündlich aktualisiert, eine neue Version ist also spätestens eine Stunde nach ihrer Veröffentlichung verfügbar.

Du nutzt Gladys noch nicht? Es ist kostenlos und Open Source: folge der Installationsanleitung, um loszulegen.

Über externe Integrationen​

Nuki ist eine externe Integration: eine Community-Integration, die als Docker-Container verpackt und auf GitHub veröffentlicht wird. Gladys installiert sie mit einem Klick und führt sie in einer vom Kern isolierten Sandbox aus. Sie wird von gboulvin veröffentlicht und gepflegt, nicht vom Gladys-Kernteam.

Abonniere den Newsletter von Gladys Assistant

Ein paar E-Mails im Monat zu neuen Releases und Neuigkeiten aus dem Projekt. Verschickt von Pierre-Gilles Leymarie, dem Gründer des Projekts. Jederzeit abbestellbar 🙂