ioBroker.nuki

This ioBroker adapter allows to control and monitor the Nuki Smart Lock by using the API of the Nuki Bridge.

Requirements

• A Nuki (hardware or software) Bridge.
• A Nuki Smart Lock and/or a Nuki Opener.
• A running instance of ioBroker.

Usage

Each instance of the Nuki adapter represents a Nuki bridge. When creating an instance, simply enter IP address, port and token of your Nuki bridge. The name is optional and will be generated automatically if left empty. The checkbox "use callback" and the value "callback port in ioBroker" are optional and can be set in order to make use of the callback function of the Nuki. After saving an instance there will be created a bridge device with a channel for each Nuki lock that is connected to the specified Nuki bridge. The channels provide the current state of the Nuki lock as output parameters:

• batteryCritical: Indicator for low battery
• deviceType: Type of Nuki device (Smart Lock or Opener)
• mode: Operation mode of the Nuki device
• doorState: Current (numeric) doorsensor state (Nuki native)
• lockState: Indicator whether Nuki is locked (Nuki Smart Lock only)
• state: Current (numeric) lock state (Nuki native)
• timestamp: Last updated

Additionally, the channels provide input parameters which enable basic control of the Nuki lock:

• action: Numeric action code for setting the Nuki state (Nuki native)

Valid input values for locks are:

0 (no action)
1 (unlock)
2 (lock)
3 (unlatch)
4 (lock ‘n’ go)
5 (lock ‘n’ go with unlatch)

• lockAction: Switch for locking / unlocking the Nuki (true = unlock; false = lock)
• openAction: Button for unlatching the Nuki
• openLocknGoAction: Button for unlatching and after some seconds locking the Nuki
• unlockLocknGoAction: Button for unlocking and after some seconds locking the Nuki

Valid input values for openers are:

0 (no action)
1 (activate rto)
2 (deactivate rto)
3 (electric strike actuation)
4 (activate continuous mode)
5 (deactivate continuous mode)

• rtoAction: Switch for activating / deactivating the Ring to Open function (true = activate; false = deactivate)
• openAction: Button for electric strike actuation
• cmActiveAction: Button for activating the Continous Mode
• cmDeactiveAction: Button for deactivating the Continous Mode

Additional information

How to get your bridges token:

• Call http://< bridge_ip >:< bridge_port >/auth from any browser in your LAN -> bridge turns on its LED
• Press the button of the bridge within 30 seconds
• Result of the browser call should be something like this: { "token": “token123”, "success": true } Callback function:

If the callback function is being used, the adapter will try to automatically set the callback on the Nuki bridge when the instance is being saved. When the instance is unloaded the callback will be deleted again. All Nuki states will be kept up-to-date by the Nuki bridge while callback is activated. Callbacks can be set and removed from any browser with following urls:

Set:

• http://< bridge_ip >:< bridge_port >/callback/add?url=http%3A%2F%2F< host_ip >%3A< host_port >%2Fapi%2Fnuki&token=< bridgeToken >

Remove:

• http://< bridge_ip >:< bridge_port >/callback/remove?id=< callback_id >&token=< bridgeToken >

Update

When updating from 1.0.x to 1.1.0 or higher it is recommended to delete all instances of the old version before installing the new version. Please be aware that version changes bigger than on patch level (-> change of only the last digit) could always contain changes to data points e.g. 1.1.2 to 1.1.4

Changelog

2.0.0

• (simatec) jsonConfig added
• (simatec) dependency updated
• (simatec) devdependency updated
• (simatec) translate added
• (simatec) test and release added
• (simatec) Release Script added
• (simatec) Remove Travis

1.7.0

• (smaragdschlange) update: implementation of latest bridge API changes (battery charge state)

1.6.0

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

1.5.0

• (smaragdschlange) bug fix: compatibility with jscontroller 3.3.13

1.4.4

• (smaragdschlange) update: changes to comply with admin 5.x.x requirements

1.4.3

• (smaragdschlange) update: dependency axios to >=0.21.1

1.4.2

• (smaragdschlange) bug fix: common.dataSource type had an invalid type

1.4.1

• (smaragdschlange) bug fix: references fixed

1.4.0

• (smaragdschlange) improvement: support of keypad battery state
• (smaragdschlange) improvement: support of ring action states for opener

1.3.1

• (smaragdschlange) bug fix: some objects did not get updated

1.3.0

• (smaragdschlange) improvement: support of doorsensor states

1.2.3

• (smaragdschlange) bug fix: convert to template strings

1.2.2

• (smaragdschlange) bug fix: get device type by state name when not provided by bridge (software bridge)

1.2.0

• (smaragdschlange) improvement: support of hashed token (set to standard)
• (smaragdschlange) improvement: better use of delay before requests in order to prevent null messages

1.1.5

• (smaragdschlange) bug fix: clear all timeouts on unload

1.1.4

• (smaragdschlange) bug fix: object was not defined

1.1.3

• (smaragdschlange) bug fix: deviceType was undefined in case of Opener
• (smaragdschlange) bug fix: Opener action was not set

1.1.2

• (smaragdschlange) improvement: added bridge type as object
• (smaragdschlange) bug fix: force reset deviceType on adapter restart

1.1.1

• (smaragdschlange) bug fix: default to Nuki Lock when deviceType unknown

1.1.0

• (smaragdschlange) improvement: support for Nuki Opener

1.0.7

• (smaragdschlange) bug fix: impact on other Nuki-connected gateways

1.0.6

• (smaragdschlange) dependencies update

1.0.5

• (ldittmar81) add gulp auto translation
• (smaragdschlange) add license

1.0.4

• (smaragdschlange) improvement: added Support for Compact mode (js-Controller 2.0 Feature)

1.0.3

• (smaragdschlange) bug fix: action buttons were not working properly

1.0.1

• (smaragdschlange) version synch

1.0.0

• (smaragdschlange) initial release on npm

0.2.0

• (smaragdschlange) periodic state updates added
• (smaragdschlange) restructure objects

0.1.3

• (smaragdschlange) timestamp bug fixed

0.1.2

• (smaragdschlange) minor bugfixes
• (smaragdschlange) added delay before each Nuki request to avoid null responses

0.1.1

• (smaragdschlange) callback will be removed when instance is unloading

0.1.0

• (smaragdschlange) callback finally working
• (smaragdschlange) added another State

0.0.6

• (smaragdschlange) additional states/actions and improved compatibility (callback still not completely working)

0.0.5

• (smaragdschlange) added support for nuki bridge callback (web server still to be added)

0.0.4

• (smaragdschlange) added input parameter for lock actions

0.0.3

• (smaragdschlange) bug fixes and restructure

0.0.2

• (smaragdschlange) added input parameters

0.0.1

• (smaragdschlange) initial release

License

The MIT License (MIT)

Copyright (c) 2018-2024 Smaragdschlange [email protected]

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.