Nuki Smartlock & Opener

Этот адаптер использует библиотеки Sentry для автоматического сообщения разработчикам об исключениях и ошибках в коде. Для получения более подробной информации и сведений о том, как отключить отправку сообщений об ошибках, см. Документация по плагину Sentry! Отправка сообщений Sentry используется начиная с js-controller 3.0.

Оглавление

5. Список изменений

Функции

• Поддержка Nuki Smartlock и Nuki Opener

• Поддержка как Nuki Bridge API, так и Nuki Web API.

• Поддержка хешированного токена на аппаратных мостах (см. https://developer.nuki.io/page/nuki-bridge-http-api-190/4#heading--token)

• В случае сбоя действий, выполняемых через API Nuki Bridge, например, из-за ошибки моста 503 (см. https://developer.nuki.io/t/random-http-503-unavailable/909/85?u=zefau), используется резервный вариант с Nuki Web API.

• Повторная попытка в случае сбоя действий, выполненных через API Nuki Bridge (если не используется Nuki Web API).

• Возможность регулярной синхронизации вместо использования обратного вызова API Bridge (который может быть с задержкой из-за аппаратного моста).

• Обновление всех состояний Nuki Web API при получении обратного вызова через Nuki Bridge API.

• Получение информации об авторизованных пользователях для Nuki Smartlock и Nuki Opener (см. ниже Каналы и штаты)

• Получить конфигурацию для Nuki Smartlock и Nuki Opener (см. ниже Каналы и состояния)

• Получить настройки уведомлений Nuki (см. ниже Каналы и состояния)

• Веб-интерфейс, отображающий последние события с вашего умного замка Nuki Smartlock и открывателя Nuki Opener:

  

Установка

API моста Nuki

Как получить токен аппаратного моста (не работает для программных мостов):

1. Вызовите http://<bridge_ip>:<bridge_port>/auth из любого браузера в вашей сети. Мост включит свой светодиод.
2. Нажмите кнопку моста в течение 30 секунд.
3. Результат вызова браузера должен выглядеть примерно так:

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

4. Используйте сгенерированный токен в адаптере nuki-extended.

Веб-API Nuki

Для использования веб-API Nuki выполните следующие действия:

1. Получите токен по адресу https://web.nuki.io/de/#/admin/web-api
2. Используйте этот токен в адаптере nuki-extended.
3. Убедитесь, что ваши устройства Nuki опубликованы в Nuki Web API (используйте приложение для смартфона через Настройки, выбрав «Активировать Nuki Web»).

Каналы и штаты

Если вам удастся успешно настроить ioBroker.nuki-extended, будут созданы следующие каналы и состояния:

Мосты (с использованием API Nuki Bridge)

Будет создан мост как устройство с именем по шаблону bridge__<name of bridge>. В каждом мосте будут созданы следующие каналы/состояния:

Общая информация

Умные замки и открыватели (с использованием API Nuki Bridge)

Будет создан замок как устройство с именем, заданным шаблоном door__<name of door>. В каждом замке (при использовании API Nuki Bridge) будут созданы следующие каналы/состояния:

Помеченные состояния будут обновляться в действии Nuki, если установлен обратный вызов.

Умные замки и открыватели (с использованием Nuki Web API)

Будет создан замок как устройство с именем, заданным шаблоном door__<name of door>. В каждом замке (при использовании Nuki Web API) будут созданы следующие каналы/состояния:

Информация

Состояние

Общая конфигурация

Расширенные настройки

Расширенные настройки открывателя

Пользователи

Интеграция умного дома и Alexa с использованием ioBroker.javascript

Несколько примеров возможной интеграции в вашу систему «умного дома».

Закройте дверь в 22:00.

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

Замените nuki-extended.0.door__home_door.status.lockState на значение lockState вашего замка!__ Вы также можете настроить сообщение с помощью msg.

Пусть Alexa сообщит вам об изменении настроек замка

Для этого требуется адаптер ioBroker ioBroker.alexa2 (https://github.com/Apollon77/ioBroker.alexa2).

Для использования голосового вывода Alexa мы определяем функцию say. Поместите следующую функцию в скрипт в папке "global" файла ioBroker.javascript. ВАЖНО: Замените #ВАШ ИДЕНТИФИКАТОР ALEXA# (также замените #) на ваш идентификатор Alexa. Вы можете найти идентификатор Alexa в дереве объектов 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);
    });
}

Вы можете использовать эту функцию в файле ioBroker.javascript, чтобы произнести фразу с помощью Alexa say('Hello World') или say('Hello World', ['#YOUR ALEXA ID 1#', '#YOUR ALEXA ID 2#']) для голосового вывода с нескольких устройств.

Создайте скрипт в папке "common" файла ioBroker.javascript и добавьте к нему следующий обработчик событий. ВАЖНО: Замените #LOCK STATE ID# (также замените #) на состояние, содержащее статус блокировки (например, 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] + '!')
});

Пусть Telegram информирует вас об изменениях в блокировке

Для этого требуется адаптер ioBroker ioBroker.telegram (https://github.com/iobroker-community-adapters/ioBroker.telegram).

Для использования вывода сообщений Telegram мы определяем функции msg и messenger. Поместите следующую функцию в скрипт в папке "global" файла 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);
}

Вы можете использовать эту функцию в файле ioBroker.javascript для отправки чего угодно в Telegram через msg('Hello World') (всем пользователям) или msg('Hello World', 'Zefau') (конкретным пользователям).

Создайте скрипт в папке "common" файла ioBroker.javascript и добавьте к нему следующий обработчик событий. ВАЖНО: Замените #LOCK STATE ID# (также замените #) на состояние, содержащее статус блокировки (например, 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] + '!')
});

ПРИМЕЧАНИЕ: Если вы используете скрипты Alexa и Telegram, вы можете определить только один слушатель для каждого действия:

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

Пусть Telegram и Alexa сообщат вам о звонке через функцию «Открыть».

Для этого необходимы адаптеры ioBroker ioBroker.telegram (https://github.com/iobroker-community-adapters/ioBroker.telegram) и 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.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.