iobroker.nuki-extended v2.7.0

ioBroker.nuki-extended

This ioBroker adapter (formerly ioBroker.Nuki2) allows to control and monitor the Nuki Smart Lock and / or the Nuki Opener by using both the Nuki Bridge API (v1.9.0, 06.05.2019) and the Nuki Web API (v1.2.0, 31.05.2019).

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

Table of contents 1. Features 2. Installation 1. Nuki Bridge API 2. Nuki Web API 3. Channels & States 4. Smart Home / Alexa integration using ioBroker.javascript 1. Lock door at 10pm in the evening 2. Let Alexa inform you about lock changes 3. Let Telegram inform you about lock changes 4. Let Alexa and Telegram inform you about somebody ringing via Opener 5. Changelog 6. Credits 7. Licence

Features

• Support for Nuki Smartlock and Nuki Opener
• Support for both Nuki Bridge API and Nuki Web API
• Support for hashed token on hardware bridges (see https://developer.nuki.io/page/nuki-bridge-http-api-190/4#heading--token)
• Fallback to Nuki Web API in case applied actions on Nuki Bridge API fail, e.g. due to bridge error 503 (see https://developer.nuki.io/t/random-http-503-unavailable/909/85?u=zefau)
• Retry in case applied actions on Nuki Bridge API fail (when Nuki Web API is not used)
• Option to regularly synchronise instead of using Bridge API callback (which may be delayed due to Hardware Bridge)
• Refreshing all states of Nuki Web API when callback is received via Nuki Bridge API
• Retrieve authorised users for Nuki Smartlock and Nuki Opener (see below Channels & States)
• Retrieve the configuration for Nuki Smartlock and Nuki Opener (see below Channels & States)
• Retrieve setup Nuki Notifications (see below Channels & States)
• Web Interface that shows the recent events from your Nuki Smartlock and Nuki Opener:

Installation

Nuki Bridge API

How to get your hardware bridge token (does not work for software bridges):

1. Call http://<bridge_ip>:<bridge_port>/auth from any browser in your network. The bridge turns on its LED.
2. Press the button of the bridge within 30 seconds.
3. Result of the browser call should be something like this:

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

4. Use the generated token in the nuki-extended adapter.

Nuki Web API

Do the following, to use the Nuki Web API:

1. Retrieve a token at https://web.nuki.io/de/#/admin/web-api
2. Use this token in the nuki-extended adapter
3. Make sure your nuki devices are published on the Nuki Web API (use the Smartphone App via Settings Activate Nuki Web)

Channels & States

If you successfully setup ioBroker.nuki-extended, the following channels and states are created:

Bridges (with Nuki Bridge API)

A bridge will be created as device with the name pattern bridge__<name of bridge>. The following channels / states will be created in each bridge:

General Information

Smartlocks and Opener (with Nuki Bridge API)

A lock will be created as device with the name pattern door__<name of door>. The following channels / states will be created in each lock (when using the Nuki Bridge API):

** marked states will be updated on a Nuki action if callback is set

Smartlocks and Opener (with Nuki Web API)

A lock will be created as device with the name pattern door__<name of door>. The following channels / states will be created in each lock (when using the Nuki Web API):

Information

State

General Config

Advanced Config

Opener Advanced Config

Users

Smart Home / Alexa integration using ioBroker.javascript

Some examples of a possible integration within your smart home.

Lock door at 10pm in the evening

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']});
});

Replace `nuki-extended.0.doorhome_door.status.lockStatewith the lockState of your lock!__ You may also customize the message viamsg`.

Let Alexa inform you about lock changes

This requires the ioBroker adapter ioBroker.alexa2 (https://github.com/Apollon77/ioBroker.alexa2).

In order to use the voice output of Alexa we define a function say. Place the following function in a script in the "global" folder of ioBroker.javascript. IMPORTANT: Replace #YOUR ALEXA ID# (also replace #) with your Alexa ID. You may find the Alexa ID in the Objects tree of ioBroker alexa2.0.Echo-Devices.

/**
 * 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);
    });
}

You can use this function within ioBroker.javascript to say a phrase using Alexa say('Hello World') or say('Hello World', ['#YOUR ALEXA ID 1#', '#YOUR ALEXA ID 2#']) for voice output from multiple devices.

Create a script in the "common" folder of ioBroker.javascript and add the following listener to it. IMPORTANT: Replace #LOCK STATE ID# (also replace #) with the state holding the lock status (e.g. 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] + '!')
});

Let Telegram inform you about lock changes

This requires the ioBroker adapter ioBroker.telegram (https://github.com/iobroker-community-adapters/ioBroker.telegram).

In order to use the message output of Telegram we define a function msg and messenger. Place the following function in a script in the "global" folder of ioBroker.javascript:

/**
 * 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);
}

You can use this function within ioBroker.javascript to send anything to Telegram via msg('Hello World') (to all users) or msg('Hello World', 'Zefau') (to specific users).

Create a script in the "common" folder of ioBroker.javascript and add the following listener to it. IMPORTANT: Replace #LOCK STATE ID# (also replace #) with the state holding the lock status (e.g. 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] + '!')
});

NOTE: If you are using both the Alexa and the Telegram script, you may only define one listener for both actions:

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] + '!')
    }
});

Let Telegram and Alexa inform you about somebody ringing via Opener

This requires the ioBroker adapter ioBroker.telegram (https://github.com/iobroker-community-adapters/ioBroker.telegram) and the ioBroker adapter ioBroker.alexa2 (https://github.com/Apollon77/ioBroker.alexa2).

/*
 * 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.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

2.6.4 (2022-06-16)

• (Apollon77) Fix some crash cases reported by Sentry

2.6.3 (2022-06-13)

• (theimo1221) Fix Web Api SetAction Call

2.6.2 (2022-06-13)

• (theimo1221) Fix Web Api Polling

2.6.1 (2022-06-09)

• (Apollon77) Fix Bridge functionality
• (simatec) Fix Admin display in dark mode

2.6.0 (2022-06-03)

• (Matze2010) Make additional refresh after callback configurable
• (theimo1221) Optimizations and fixes

2.5.0 (2022-05-27)

• (StrathCole) Allow web-api-only operation
• (Apollon77) Make compatible with Node.js 18.x
• (Apollon77) Add Sentry for crash reporting

2.4.0 (2021-12-13)

• (smaragdschlange) added support for Nuki Smart Door and Nuki Smart Lock 3.0 (Pro)

v2.3.1 (2021-07-20)

• (Apollon77) Optimize for js-controller 3.3 and warnings prevented

v2.3.0 (2020-08-10)

• (Zefau) added support for the door sensor of the Nuki Smartlock (introduced with Bridge firmware 2.6.0 / 1.16.0)
• (Zefau) added support for the ring bell action of the Nuki Opener (introduced with Bridge firmware 2.7.0 / 1.17.0)

v2.2.6 (2020-07-14)

• (Zefau) fixed Web API not refreshing correctly (see #59)
• (Zefau) updated dependencies

v2.2.5 (2020-03-19)

• (Zefau) fixed incorrect versioning

v2.2.4 (2020-03-18)

• (Zefau) fixed incorrect dates of version history (see #60)

v2.2.3 (2020-03-04)

• (Zefau) added refresh of configuration (via Nuki Web API) when any config item has been changed in ioBroker

v2.2.2 (2020-03-04)

• (Zefau) fixed incorrect error message Error triggering action via Nuki Bridge API: No Nuki Hex ID given!
• (Zefau) added new error message if too many callbacks are already attached to Nuki Bridge (Callback not attached because too many Callbacks attached to the Nuki Bridge already! Please delete a callback!)

v2.2.1 (2020-03-03)

• (Zefau) fixed incorrect state mapping of state openerAdvancedConfig.doorbellSuppression

  Note: Please delete the state openerAdvancedConfig.doorbellSuppression once manually and restart the adapter to take affect!

• (Zefau) updated dependencies

v2.2.0 (2020-02-16)

• (Zefau) added possibility to change configuration of Nuki Smartlock or Nuki Opener (when using Web API)
• (Zefau) updated dependencies

v2.1.0 (2020-02-03)

• (Zefau) added (optional) callback IP for Bridge API events (e.g. when ioBroker is run in docker; see #51)
• (Zefau) added dedicated buttons for each lock / opener action
• (Zefau) replaced state.timestamp with state.lastDataUpdate (indicates last data refresh from the APIs) and state.lastStateUpdate (indicates the last actual state change)

v2.0.3 (2019-10-31)

• (Zefau) reintroduced support for hashed token on hardware bridges (see https://developer.nuki.io/page/nuki-bridge-http-api-190/4#heading--token)

v2.0.2 (2019-10-31)

• (Zefau) added support for newly introduced nightmode (see https://nuki.io/de/blog/nuki-news-de/nuki-update-2019-der-winter-naht-sei-vorbereitet/)
• (Zefau) fixed incorrect behavior when bridges are defined insufficiently (no name, ip or token provided)

v2.0.1 (2019-10-26)

• (Zefau) fixed missing bridge_name

v2.0.0 (2019-10-24)

• (Zefau) added support for new Nuki Opener
• (Zefau) added support for hashed token on hardware bridges (see https://developer.nuki.io/page/nuki-bridge-http-api-190/4#heading--token)
• (Zefau) added fallback to Nuki Web API in case applied actions on Nuki Bridge API fail, e.g. due to bridge error 503 (see https://developer.nuki.io/t/random-http-503-unavailable/909/85?u=zefau)
• (Zefau) added retry in case applied actions on Nuki Bridge API fail (when Nuki Web API is not used)
• (Zefau) added option to regularly synchronise instead of using Bridge API callback
• (Zefau) added refreshing all states of Nuki Web API when callback is received via Nuki Bridge API
• (Zefau) added states for Nuki Notifications
• (Zefau) added support for multiple devices (including Nuki Opener) on adapter web interface
• (Zefau) added option to not retrieve all information (by deselecting config or users) via Nuki Web API

Credits

Thanks to @Mik13 for the Nuki Bridge API implementation.

Icons made by Smashicons (Essential Set) and Freepik (Doors) from www.flaticon.com is licensed by CC 3.0 BY

License

The MIT License (MIT)

Copyright (c) 2024 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.