Nuki Smartlock & Opener

Dieser ioBroker-Adapter (ehemals ioBroker.Nuki2) ermöglicht die Steuerung und Überwachung des Nuki Smart Lock und/oder des Nuki Opener sowohl über die Nuki Bridge API (v1.9.0, 06.05.2019) als auch über die Nuki Web API (v1.2.0, 31.05.2019) .

Dieser Adapter nutzt die Sentry-Bibliotheken, um Ausnahmen und Codefehler automatisch an die Entwickler zu melden. Weitere Details und Informationen zum Deaktivieren der Fehlerberichterstattung finden Sie in der Sentry-Plugin-Dokumentation ! Die Sentry-Berichterstattung wird ab js-controller 3.0 verwendet.

Inhaltsverzeichnis

2. Installation
   1. Nuki Bridge API
   2. Nuki Web-API
3. Änderungsprotokoll
4. Lizenz

Merkmale

• Unterstützung für Nuki Smartlock und Nuki Opener
• Unterstützung sowohl für die Nuki Bridge API als auch für die Nuki Web API
• Unterstützung für gehashte Token auf Hardware-Bridges (siehe https://developer.nuki.io/page/nuki-bridge-http-api-190/4#heading--token )
• Falls Aktionen, die auf der Nuki Bridge API angewendet werden, fehlschlagen, z. B. aufgrund eines Bridge-Fehlers 503 (siehe https://developer.nuki.io/t/random-http-503-unavailable/909/85?u=zefau )
• Wiederholungsversuche, falls die auf die Nuki Bridge API angewendeten Aktionen fehlschlagen (wenn die Nuki Web API nicht verwendet wird).
• Option zur regelmäßigen Synchronisierung anstelle der Verwendung des Bridge-API-Callbacks (der sich aufgrund der Hardware-Bridge verzögern kann)
• Aktualisierung aller Zustände der Nuki Web API beim Empfang eines Callbacks über die Nuki Bridge API
• Autorisierte Benutzer für Nuki Smartlock und Nuki Opener abrufen (siehe unten Kanäle & Status )
• Rufen Sie die Konfiguration für Nuki Smartlock und Nuki Opener ab (siehe unten Kanäle & Zustände ).
• Nuki-Benachrichtigungen einrichten (siehe unten Kanäle & Status )
• Web-Oberfläche, die die letzten Ereignisse Ihres Nuki Smartlock und Nuki Openers anzeigt:

Installation

Nuki Bridge API

So erhalten Sie Ihr Hardware-Bridge-Token (funktioniert nicht für Software-Bridges):

1. Anrufhttp://<bridge_ip>:<bridge_port>/auth Von jedem Browser in Ihrem Netzwerk aus. Die LED der Bridge schaltet sich ein.
2. Drücken Sie den Knopf der Brücke innerhalb von 30 Sekunden.
3. Das Ergebnis des Browseraufrufs sollte etwa so aussehen:

   {
      "token":"token123",
      "success":true
   }
   

4. Verwenden Sie das generierte Token im nuki-extended Adapter.

Nuki Web-API

Gehen Sie wie folgt vor, um die Nuki Web API zu verwenden:

1. Ein Token kann unter https://web.nuki.io/de/#/admin/web-api abgerufen werden.
2. Verwenden Sie dieses Token im nuki-extended Adapter
3. Stellen Sie sicher, dass Ihre Nuki-Geräte in der Nuki Web API veröffentlicht sind (verwenden Sie dazu die Smartphone-App über die Einstellungen).Activate Nuki Web )

Kanäle und Staaten

Wenn Sie ioBroker.nuki-extended erfolgreich eingerichtet haben, werden die folgenden Kanäle und Zustände erstellt:

Brücken (mit Nuki Bridge API)

Es wird eine Brücke als Gerät mit dem Namensmuster erstellt.bridge__<name of bridge> In jeder Bridge werden die folgenden Kanäle/Zustände erstellt:

Allgemeine Informationen

Smartlocks und Öffner (mit Nuki Bridge API)

Es wird ein Schloss als Gerät mit dem Namensmuster erstellt.door__<name of door> Die folgenden Kanäle/Zustände werden in jedem Lock erstellt (bei Verwendung der Nuki Bridge API):

** Markierte Zustände werden bei einer Nuki-Aktion aktualisiert, wenn ein Callback festgelegt ist.

Smartlocks und Öffner (mit Nuki Web API)

Es wird ein Schloss als Gerät mit dem Namensmuster erstellt.door__<name of door> Die folgenden Kanäle/Zustände werden in jedem Lock erstellt (bei Verwendung der Nuki Web API):

Information

Zustand

Allgemeine Konfiguration

Erweiterte Konfiguration

Opener Erweiterte Konfiguration

Benutzer

Smart-Home-/Alexa-Integration mit ioBroker.javascript

Einige Beispiele für eine mögliche Integration in Ihr Smart Home.

Schließe die Tür um 22 Uhr ab.

var states = {
    "0": "uncalibrated",
    "1": "locked",
    "2": "unlocking",
    "3": "unlocked",
    "4": "locking",
    "5": "unlatched",
    "6": "unlocked (lock n go)",
    "7": "unlatching",
    "254": "motor blocked",
    "255": "undefined"
};

schedule('0 22 * * *', function()
{
    var status = (getState('nuki-extended.0.smartlocks.home_door.state.lockState').val);
    var msg = 'Main Door door is ' + (states[status]) + '. ';

    if (status == '3')
    {
        setState('nuki-extended.0.smartlocks.home_door._ACTION', 2);
        msg += 'Locking door..'
    }
    else
        msg += 'No action taken.'

    log(msg, {m: 'Nuki', o: ['msg']});
});

Ersetzennuki-extended.0.door__home_door.status.lockState mit dem Sperrstatus Ihres Schlosses! Sie können die Nachricht auch anpassen übermsg Die

Lassen Sie sich von Alexa über Schlossänderungen informieren.

Hierfür wird der ioBroker-Adapter ioBroker.alexa2 ( https://github.com/Apollon77/ioBroker.alexa2 ) benötigt.

Um die Sprachausgabe von Alexa zu nutzen, definieren wir eine Funktionsay Fügen Sie die folgende Funktion in ein Skript im Ordner „global“ von ioBroker.javascript ein. WICHTIG: Ersetzen Sie #IHRE ALEXA-ID# (und auch #) durch Ihre Alexa-ID. Sie finden die Alexa-ID in der Objektstruktur von ioBroker.alexa2.0.Echo-Devices Die

/**
 * Say something with Alexa.
 * 
 * @param       {string}        message         Message to say
 * @param       {string|array}  alexas          Alexa Device to say the voice message
 * @return      void
 * 
 */
function say(message, alexas = '#YOUR ALEXA ID#') // use alexas = ['#YOUR ALEXA ID 1#', '#YOUR ALEXA ID 2#'] for default voice output from multiple devices (also replace #)
{
    alexas = typeof alexas === 'string' ? [alexas] : alexas;
    alexas.forEach(function(alexa)
    {
        setState('alexa2.0.Echo-Devices.' + alexa + '.Commands.speak', message);
    });
}

Sie können diese Funktion in ioBroker.javascript verwenden, um mit Alexa einen Satz zu sagen.say('Hello World') odersay('Hello World', ['#YOUR ALEXA ID 1#', '#YOUR ALEXA ID 2#']) zur Sprachausgabe von mehreren Geräten.

Erstellen Sie im Ordner „common“ der Datei ioBroker.javascript ein Skript und fügen Sie den folgenden Listener hinzu. WICHTIG: Ersetzen Sie #LOCK STATE ID# (und auch #) durch den Status, der den Sperrstatus enthält (z. B.nuki-extended.0.door__home_door.status.lockState ):

const DOOR_STATES = {
    "0": "uncalibrated",
    "1": "locked",
    "2": "unlocking",
    "3": "unlocked",
    "4": "locking",
    "5": "unlatched",
    "6": "unlocked (lock n go)",
    "7": "unlatching",
    "254": "motor blocked",
    "255": "undefined"
};

/*
 * LISTEN TO CHANGES TO LOCK STATE
 * 
 */
on({id: 'nuki-extended.0.smartlocks.home_door.state.lockState', change: 'any'}, function(obj)
{
    if (obj !== undefined && obj.state !== undefined)
      say('Door is ' + DOOR_STATES[obj.state.val] + '!')
});

Lassen Sie sich von Telegram über Sperränderungen informieren.

Hierfür wird der ioBroker-Adapter ioBroker.telegram ( https://github.com/iobroker-community-adapters/ioBroker.telegram ) benötigt.

Um die Nachrichtenausgabe von Telegram zu nutzen, definieren wir eine Funktionmsg Undmessenger Fügen Sie die folgende Funktion in ein Skript im Ordner „global“ von ioBroker.javascript ein:

/**
 * Send something via telegram.
 * 
 * @param       {string}        message         Message to print
 * @param       {string|array}  receiver        Users to send the message to
 * @return      void
 * 
 */
function msg(message, receiver = 'ALL')
{
    if (receiver == 'ALL')
        messenger(message);
    
    else
    {
        receiver = typeof receiver == 'string' ? [receiver] : receiver;
        receiver.forEach(function(user)
        {
            messenger(message, user);
        });
    }
}

/**
 * Sends a message / text.
 * 
 * @param   {string}            content         Message to send
 * @param   {string}            user            (optional) Specific user to send the message to (defaults to all registered users)
 * @return  void
 * 
 */
function messenger(content, user = '')
{
    var config = {
        text: content,
        parse_mode: 'HTML',
        reply_markup: {
            resize_keyboard: true,
            one_time_keyboard: false
        }
    };
    
    sendTo('telegram', user ? Object.assign({user: user}, config) : config);
}

Sie können diese Funktion in ioBroker.javascript verwenden, um beliebige Inhalte über Telegram zu senden.msg('Hello World') (an alle Benutzer) odermsg('Hello World', 'Zefau') (an bestimmte Nutzer).

Erstellen Sie im Ordner „common“ der Datei ioBroker.javascript ein Skript und fügen Sie den folgenden Listener hinzu. WICHTIG: Ersetzen Sie #LOCK STATE ID# (und auch #) durch den Status, der den Sperrstatus enthält (z. B.nuki-extended.0.door__home_door.status.lockState ):

const DOOR_STATES = {
    "0": "uncalibrated",
    "1": "locked",
    "2": "unlocking",
    "3": "unlocked",
    "4": "locking",
    "5": "unlatched",
    "6": "unlocked (lock n go)",
    "7": "unlatching",
    "254": "motor blocked",
    "255": "undefined"
};

/*
 * LISTEN TO CHANGES TO LOCK STATE
 * 
 */
on({id: 'nuki-extended.0.smartlocks.home_door.state.lockState', change: 'any'}, function(obj)
{
    if (obj !== undefined && obj.state !== undefined)
      msg('Door is ' + DOOR_STATES[obj.state.val] + '!')
});

HINWEIS: Wenn Sie sowohl das Alexa- als auch das Telegram-Skript verwenden, dürfen Sie nur einen Listener für beide Aktionen definieren:

const DOOR_STATES = {
    "0": "uncalibrated",
    "1": "locked",
    "2": "unlocking",
    "3": "unlocked",
    "4": "locking",
    "5": "unlatched",
    "6": "unlocked (lock n go)",
    "7": "unlatching",
    "254": "motor blocked",
    "255": "undefined"
};

/*
 * LISTEN TO CHANGES TO LOCK STATE
 * 
 */
on({id: 'nuki-extended.0.smartlocks.home_door.state.lockState', change: 'any'}, function(obj)
{
    if (obj !== undefined && obj.state !== undefined)
    {
      say('Door is ' + DOOR_STATES[obj.state.val] + '!')
      msg('Door is ' + DOOR_STATES[obj.state.val] + '!')
    }
});

Lassen Sie sich von Telegram und Alexa über Anrufe per Opener benachrichtigen.

Hierfür werden der ioBroker-Adapter ioBroker.telegram ( https://github.com/iobroker-community-adapters/ioBroker.telegram ) und der ioBroker-Adapter ioBroker.alexa2 ( https://github.com/Apollon77/ioBroker.alexa2 ) benötigt.

/*
 * Alexa and Telegram to notify on Opener Ringing state
 *
 */
let phrase = 'Somebody is ringing the doorbell.'; // Es hat an der Tür geklingelt
on({id: 'nuki-extended.0.openers.opener.state.ringStateUpdate', change: "any", ack: true}, function (s) {
  let state= s && s.state;

  if (state.val === true) {
    setState("alexa2.0.Echo-Devices.#YOUR ALEXA ID#.Commands.speak"/*speak*/, phrase);
    sendTo("telegram", "send", { text: phrase });
  }
});

Changelog

Please see release page for changelog and detailed information.

2.8.2 (2026-05-14)

• (mcm1957) Missing translations have been added.
• (mcm1957) Dependencies have been updated

2.8.1 (2026-05-13)

• (copilot) Migrated linting setup to ESLint 9 with the shared @iobroker/eslint-config.
• (copilot) Resolved ESLint error findings in adapter core files and aligned linting ignores for legacy frontend scripts.

2.8.0 (2026-05-13)

• (copilot) Adapter requires node.js >= 22 now
• (copilot) Adapter requires admin >= 7.7.22 now
• (copilot) Adapter requires js-controller >= 6.0.11 now
• (VierlingMt) Adding Nuki Smartlock 4.X and Pro Support, "toLowerCase" error fixed
• (sbormann) Added deviceType 5 and fixed empty type variable
• (mcm1957) Dependencies have been updated

2.7.0 (2024-04-21)

• (mcm1957) Adapter requires node.js 18 and js-controller >= 5 now
• (mcm1957) Dependencies have been updated

2.6.5 (2022-06-17)

• (Apollon77) Fix some crash cases reported by Sentry

License

The MIT License (MIT)

Copyright (c) 2024-2026 iobroker-community-adapters iobroker-community-adapters@gmx.de
Copyright (c) 2019-2022 Zefau zefau@mailbox.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.