Nuki Hub Save

About

The scope of Nuki Hub is to have an efficient way to integrate Nuki devices in a local Home Automation platform.

The Nuki Hub software runs on a ESP32 module and acts as a bridge between Nuki devices and a Home Automation platform.

It communicates with a Nuki Lock and/or Opener through Bluetooth (BLE) and uses MQTT to integrate with other systems.

It exposes the lock state (and much more) through MQTT and allows executing commands like locking and unlocking through MQTT.

Nuki Hub does not integrate with the Nuki mobile app, it can't register itself as a bridge in the official Nuki mobile app.

Feel free to join us on Discord: https://discord.gg/feB9FnMY

Supported devices

Supported ESP32 devices:

• All dual-core ESP32 models with WIFI and BLE which are supported by Arduino Core 2.0.15 should work. Tested builds are provided for the ESP32 and ESP32-S3.
• Single-core ESP32 models with WIFI and BLE which are supported by Arduino Core 2.0.15 might work. Untested builds are provided for the ESP32-C3 and ESP32-Solo1.
• The ESP32-S2 has no BLE and as such can't run Nuki Hub.
• The ESP32-C6 and ESP32-H2 are not supported by Arduino Core 2.0.15 as such can't run Nuki Hub (at this time).

Supported Nuki devices:

• Nuki Smart Lock 1.0
• Nuki Smart Lock 2.0
• Nuki Smart Lock 3.0
• Nuki Smart Lock 3.0 Pro (read FAQ below)
• Nuki Smart Lock 4.0
• Nuki Smart Lock 4.0 Pro (read FAQ below)
• Nuki Opener
• Nuki Keypad 1.0
• Nuki Keypad 2.0

Supported Ethernet devices:
As an alternative to Wi-Fi (which is available on any supported ESP32), the following ESP32 modules with wired ethernet are supported:

• Olimex ESP32-POE
• Olimex ESP32-POE-ISO
• WT32-ETH01
• M5Stack Atom POE
• M5Stack PoESP32 Unit
• LilyGO-T-ETH-POE

Note for users upgrading from Nuki Hub 8.21 or lower:
Please go to "MQTT and Network Configuration" and select "Wi-Fi only" as the network device (unless you use other network hardware).

Installation

Flash the firmware to an ESP32. The easiest way to install is to use the web installer using a compatible browser like Chrome/Opera/Edge:
https://technyon.github.io/nuki_hub/
NOTE: Webflash is not available for the ESP32-Solo1

Alternatively download the latest release for your ESP32 model from https://github.com/technyon/nuki_hub/releases
Unpack the 7z archive and read the included readme.txt for installation instructions for either "Espressif Flash Download Tools" or "esptool".

Initial setup (Network and MQTT)

Power up the ESP32 and a new Wi-Fi access point named "ESP32_(8 CHARACTER ALPHANUMERIC)" should appear.
Connect a client device to this access point and in a browser navigate to "http://192.168.4.1".
Use the web interface to connect the ESP to your preferred Wi-Fi network.

After configuring Wi-Fi, the ESP should automatically connect to your network.

To configure the connection to the MQTT broker first connect your client device to the same Wi-Fi network the ESP32 is connected to.
In a browser navigate to the IP address assigned to the ESP32 via DHCP (often found in the web interface of your internet router).

Next click on "Edit" below "MQTT and Network Configuration" and enter the address and port (usually 1883) of your MQTT broker and a username and a password if required by your MQTT broker.

The firmware supports SSL encryption for MQTT, however most people and especially home users don't use this.
In that case leave all fields starting with "MQTT SSL" blank. Otherwise see the "MQTT Encryption" section of this README.

Pairing with a Nuki Lock or Opener

Enable pairing mode on the Nuki Lock or Opener (press the button on the Nuki device for a few seconds) and power on the ESP32.
Pairing should be automatic.

When pairing is successful, the web interface should show "Paired: Yes" (it might be necessary to reload the page in your browser).
MQTT nodes like lock state and battery level should now reflect the reported values from the lock.

Note: It is possible to run Nuki Hub alongside a Nuki Bridge. This is not recommended and will lead to excessive battery drain and can lead to either device missing updates. Enable "Register as app" before pairing to allow this. Otherwise the Bridge will be unregistered when pairing the Nuki Hub.

Support

If you haven't ordered your Nuki product yet, you can support me by using my referrer code when placing your order:
REFNW2959GXR7
This will also give you a 10% discount on your order.

This project is free to use for everyone. However if you feel like donating, you can buy me a coffee at ko-fi.com:

Configuration

In a browser navigate to the IP address assigned to the ESP32.

MQTT and Network Configuration

Basic MQTT and Network Configuration

• Host name: Set the hostname for the Nuki Hub ESP
• MQTT Broker: Set to the IP address of the MQTT broker
• MQTT Broker port: Set to the Port of the MQTT broker (usually 1883)
• MQTT User: If using authentication on the MQTT broker set to a username with read/write rights on the MQTT broker, set to # to clear
• MQTT Password : If using authentication on the MQTT broker set to the password belonging to a username with read/write rights on the MQTT broker, set to # to clear

Advanced MQTT and Network Configuration

• Home Assistant discovery topic: Set to the Home Assistant auto discovery topic, leave empty to disable auto discovery. Usually "homeassistant" unless you manually changed this setting on the Home Assistant side.
• Home Assistant device configuration URL: When using Home Assistant discovery the link to the Nuki Hub Web Configuration will be published to Home Assistant. By default when this setting is left empty this will link to the current IP of the Nuki Hub. When using a reverse proxy to access the Web Configuration you can set a custom URL here.
• Set Nuki Opener Lock/Unlock action in Home Assistant to Continuous mode (Opener only): By default the lock entity in Home Assistant will enable Ring-to-Open (RTO) when unlocking and disable RTO when locking. By enabling this setting this behaviour will change and now unlocking will enable Continuous Mode and locking will disable Continuous Mode, for more information see the "Home Assistant Discovery" section of this README.
• MQTT SSL CA Certificate: Optionally set to the CA SSL certificate of the MQTT broker, see the "MQTT Encryption" section of this README.
• MQTT SSL Client Certificate: Optionally set to the Client SSL certificate of the MQTT broker, see the "MQTT Encryption" section of this README.
• MQTT SSL Client Key: Optionally set to the Client SSL key of the MQTT broker, see the "MQTT Encryption" section of this README.
• Network hardware: "Wi-Fi only" by default, set to one of the specified ethernet modules if available, see the "Supported Ethernet devices" and "Connecting via Ethernet" section of this README.
• Disable fallback to Wi-Fi / Wi-Fi config portal: By default the Nuki Hub will fallback to Wi-Fi and open the Wi-Fi configuration portal when the network connection fails. Enable this setting to disable this fallback.
• RSSI Publish interval: Set to a positive integer to set the amount of seconds between updates to the maintenance/wifiRssi MQTT topic with the current Wi-Fi RSSI, set to -1 to disable, default 60.
• Network Timeout until restart: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without an active connection to the MQTT broker, set to -1 to disable, default 60.
• Restart on disconnect: Enable to restart the Nuki Hub after 60 seconds without a connection to a network.
• Enable MQTT logging: Enable to fill the maintenance/log MQTT topic with debug log information.
• Check for Firmware Updates every 24h: Enable to allow the Nuki Hub to check the latest release of the Nuki Hub firmware on boot and every 24 hours. Requires the Nuki Hub to be able to connect to github.com. The latest version will be published to MQTT and will be visible on the main page of the Web Configurator.

IP Address assignment

• Enable DHCP: Enable to use DHCP for obtaining an IP address, disable to use the static IP settings below
• Static IP address: When DHCP is disabled set to the preferred static IP address for the Nuki Hub to use
• Subnet: When DHCP is disabled set to the preferred subnet for the Nuki Hub to use
• Default gateway: When DHCP is disabled set to the preferred gateway IP address for the Nuki Hub to use
• DNS Server: When DHCP is disabled set to the preferred DNS server IP address for the Nuki Hub to use

Nuki Configuration

Basic Nuki Configuration

• Nuki Smartlock enabled: Enable if you want Nuki Hub to connect to a Nuki Lock (1.0-4.0)
• MQTT Nuki Smartlock Path (Lock only): Set to the preferred MQTT root topic for the Nuki Lock, defaults to "nuki". Make sure this topic is not the same as the setting for the opener and is unique when using multiple Nuki Hub devices (when using multiple Nuki Locks)
• Nuki Opener enabled: Enable if you want Nuki Hub to connect to a Nuki Opener
• MQTT Nuki Opener Path (Opener only): Set to the preferred MQTT root topic for the Nuki Opener, defaults to "nukiopener". Make sure this topic is not the same as the setting for the lock and is unique when using multiple Nuki Hub devices (when using multiple Nuki Openers)

Advanced Nuki Configuration

• Query interval lock state: Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current lock state, default 1800.
• Query interval configuration: Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current configuration, default 3600.
• Query interval battery: Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current battery state, default 1800.
• Query interval keypad (Only available when a Keypad is detected): Set to a positive integer to set the maximum amount of seconds between actively querying the Nuki device for the current keypad state, default 1800.
• Number of retries if command failed: Set to a positive integer to define the amount of times the Nuki Hub retries sending commands to the Nuki Lock or Opener when commands are not acknowledged by the device, default 3.
• Delay between retries: Set to the amount of milliseconds the Nuki Hub waits between resending not acknowledged commands, default 100.
• Nuki Bridge is running alongside Nuki Hub: Enable to allow Nuki Hub to co-exist with a Nuki Bridge by registering Nuki Hub as an (smartphone) app instead of a bridge. Changing this setting will require re-pairing. Enabling this setting is strongly discouraged as described in the "Pairing with a Nuki Lock or Opener" section of this README
• Presence detection timeout: Set to a positive integer to set the amount of seconds between updates to the presence/devices MQTT topic with the list of detected bluetooth devices, set to -1 to disable presence detection, default 60.
• Restart if bluetooth beacons not received: Set to a positive integer to restart the Nuki Hub after the set amount of seconds has passed without receiving a bluetooth beacon from the Nuki device, set to -1 to disable, default 60. Because the bluetooth stack of the ESP32 can silently fail it is not recommended to disable this setting.

Access Level Configuration

Nuki General Access Control

• Change Lock/Opener configuration: Allows changing the Nuki Lock/Opener configuration through MQTT.
• Publish keypad codes information (Only available when a Keypad is detected): Enable to publish information about keypad codes through MQTT, see the "Keypad control" section of this README
• Add, modify and delete keypad codes (Only available when a Keypad is detected): Enable to allow configuration of keypad codes through MQTT, see the "Keypad control" section of this README
• Publish time control information: Enable to publish information about time control entries through MQTT, see the "Time control" section of this README
• Add, modify and delete time control entries: Enable to allow configuration of time control entries through MQTT, see the "Time control" section of this README
• Publish auth data: Enable to publish authorization data to the MQTT topic lock/log. Requires the Nuki security code / PIN to be set, see "Nuki Lock PIN / Nuki Opener PIN" below.

Nuki Lock/Opener Access Control

• Enable or disable executing each available lock action for the Nuki Lock and Nuki Opener through MQTT. Note: GPIO control is not restricted through this setting.

Credentials

Credentials

• User: Pick a username to enable HTTP Basic authentication for the Web Configuration, Set to "#" to disable authentication.
• Password/Retype password: Pick a password to enable HTTP Basic authentication for the Web Configuration.

Nuki Lock PIN / Nuki Opener PIN

• PIN Code: Fill with the Nuki Security Code of the Nuki Lock and/or Nuki Opener. Required for functions that require the security code to be sent to the lock/opener such as setting lock permissions/adding keypad codes, viewing the activity log or changing the Nuki device configuration. Set to "#" to remove the security code from the Nuki Hub configuration.

Unpair Nuki Lock / Unpair Nuki Opener

• Type [4 DIGIT CODE] to confirm unpair: Set to the shown randomly generated code to unpair the Nuki Lock or Opener from the Nuki Hub.

GPIO Configuration

• Gpio [2-33]: See the "GPIO lock control" section of this README.

Exposed MQTT Topics

Lock

• lock/action: Allows to execute lock actions. After receiving the action, the value is set to "ack". Possible actions: unlock, lock, unlatch, lockNgo, lockNgoUnlatch, fullLock, fobAction1, fobAction2, fobAction3.
• lock/state: Reports the current lock state as a string. Possible values are: uncalibrated, locked, unlocked, unlatched, unlockedLnga, unlatching, bootRun, motorBlocked.
• lock/hastate: Reports the current lock state as a string, specifically for use by Home Assistant. Possible values are: locking, locked, unlocking, unlocked, jammed.
• lock/json: Reports the lock state, last action trigger, last lock action, lock completion status, door sensor state, auth ID and auth name as JSON data.
• lock/binaryState: Reports the current lock state as a string, mostly for use by Home Assistant. Possible values are: locked, unlocked.
• lock/trigger: The trigger of the last action: autoLock, automatic, button, manual, system.
• lock/lastLockAction: Reports the last lock action as a string. Possible values are: Unlock, Lock, Unlatch, LockNgo, LockNgoUnlatch, FullLock, FobAction1, FobAction2, FobAction3, Unknown.
• lock/log: If "Publish auth data" is enabled in the web interface, this topic will be filled with the log of authorization data.
• lock/completionStatus: Status of the last action as reported by Nuki Lock: success, motorBlocked, canceled, tooRecent, busy, lowMotorVoltage, clutchFailure, motorPowerFailure, incompleteFailure, invalidCode, otherError, unknown.
• lock/authorizationId: If enabled in the web interface, this node returns the authorization id of the last lock action.
• lock/authorizationName: If enabled in the web interface, this node returns the authorization name of the last lock action.
• lock/commandResult: Result of the last action as reported by Nuki library: success, failed, timeOut, working, notPaired, error, undefined.
• lock/doorSensorState: State of the door sensor: unavailable, deactivated, doorClosed, doorOpened, doorStateUnknown, calibrating.
• lock/rssi: The signal strenght of the Nuki Lock as measured by the ESP32 and expressed by the RSSI Value in dBm.
• lock/address: The BLE address of the Nuki Lock.
• lock/retry: Reports the current number of retries for the current command. 0 when command is succesfull, "failed" if the number of retries is greater than the maximum configured number of retries.
  
  
• configuration/autoLock: enable or disable autoLock (0 = disabled; 1 = enabled). Maps to "Auto lock enabled" in the bluetooth API.
• configuration/autoUnlock: enable or disable autoLock in general (0 = disabled; 1 = enabled). Maps to "Auto unlock disabled" in the bluetooth API.
• configuration/buttonEnabled: enable or disable the button on the lock (0 = disabled; 1 = enabled).
• configuration/ledBrightness: Set the brightness of the LED on the lock (0=min; 5=max).
• configuration/ledEnabled: enable or disable the LED on the lock (0 = disabled; 1 = enabled).
• configuration/singleLock: configures wether to single- or double-lock the door (0 = double; 1 = single).

Opener

• lock/action: Allows to execute lock actions. After receiving the action, the value is set to "ack". Possible actions: activateRTO, deactivateRTO, electricStrikeActuation, activateCM, deactivateCM, fobAction1, fobAction2, fobAction3.
• lock/state: Reports the current lock state as a string. Possible values are: locked, RTOactive, open, opening, uncalibrated.
• lock/hastate: Reports the current lock state as a string, specifically for use by Home Assistant. Possible values are: locking, locked, unlocking, unlocked, jammed.
• lock/json: Reports the lock state, last action trigger, last lock action, lock completion status, door sensor state, auth ID and auth name as JSON data.
• lock/binaryState: Reports the current lock state as a string, mostly for use by Home Assistant. Possible values are: locked, unlocked.
• lock/continuousMode: Enable or disable continuous mode on the opener (0 = disabled; 1 = enabled).
• lock/ring: The string "ring" is published to this topic when a doorbell ring is detected while RTO or continuous mode is active or "ringlocked" when both are inactive.
• lock/binaryRing: The string "ring" is published to this topic when a doorbell ring is detected, the state will revert to "standby" after 2 seconds.
• lock/trigger: The trigger of the last action: autoLock, automatic, button, manual, system.
• lock/lastLockAction: Reports the last lock action as a string. Possible values are: ActivateRTO, DeactivateRTO, ElectricStrikeActuation, ActivateCM, DeactivateCM, FobAction1, FobAction2, FobAction3, Unknown.
• lock/log: If "Publish auth data" is enabled in the web interface, this topic will be filled with the log of authorization data.
• lock/completionStatus: Status of the last action as reported by Nuki Opener: success, motorBlocked, canceled, tooRecent, busy, lowMotorVoltage, clutchFailure, motorPowerFailure, incompleteFailure, invalidCode, otherError, unknown.
• lock/authorizationId: If enabled in the web interface, this topic is set to the authorization id of the last lock action.
• lock/authorizationName: If enabled in the web interface, this topic is set to the authorization name of the last lock action.
• lock/commandResult: Result of the last action as reported by Nuki library: success, failed, timeOut, working, notPaired, error, undefined.
• lock/doorSensorState: State of the door sensor: unavailable, deactivated, doorClosed, doorOpened, doorStateUnknown, calibrating.
• lock/rssi: The bluetooth signal strength of the Nuki Lock as measured by the ESP32 and expressed by the RSSI Value in dBm.
• lock/address: The BLE address of the Nuki Lock.
• lock/retry: Reports the current number of retries for the current command. 0 when command is succesfull, "failed" if the number of retries is greater than the maximum configured number of retries.
  
  
• configuration/buttonEnabled: enable or disable the button on the opener (0 = disabled; 1 = enabled).
• configuration/ledEnabled: enable or disable the LED on the opener (0 = disabled; 1 = enabled).
• configuration/soundLevel: configures the volume of sounds the opener plays back (0 = min; 255 = max).

Query

• lock/query/lockstate: Set to 1 to trigger query lockstate. Auto-resets to 0.
• lock/query/config: Set to 1 to trigger query config. Auto-resets to 0.
• lock/query/keypad: Set to 1 to trigger query keypad. Auto-resets to 0.
• lock/query/battery: Set to 1 to trigger query battery. Auto-resets to 0.
• lock/query/lockstateCommandResult: Set to 1 to trigger query lockstate command result. Auto-resets to 0.

Battery

• battery/level: Battery level in percent (Lock only).
• battery/critical: 1 if battery level is critical, otherwise 0.
• battery/charging: 1 if charging, otherwise 0 (Lock only).
• battery/voltage: Current Battery voltage (V).
• battery/drain: The drain of the last lock action in Milliwattseconds (mWs) (Lock only).
• battery/maxTurnCurrent: The highest current of the turn motor during the last lock action (A) (Lock only).
• battery/lockDistance: The total distance during the last lock action in centidegrees (Lock only).
• battery/keypadCritical: 1 if the battery level of a connected keypad is critical, otherwise 0.

Keypad

• See the "Keypad control" section of this README.

Time Control

• See the "Time control" section of this README.

Info

• info/nukiHubVersion: Set to the current version number of the Nuki Hub firmware.
• info/firmwareVersion: Set to the current version number of the Nuki Lock/Opener firmware.
• info/hardwareVersion: Set to the hardware version number of the Nuki Lock/Opener.
• info/nukiHubIp: Set to the IP of the Nuki Hub.
• info/nukiHubLatest: Set to the latest available Nuki Hub firmware version number (if update checking is enabled in the settings).

Maintanence

• maintenance/networkDevice: Set to the name of the network device that is used by the ESP. When using Wi-Fi will be set to "Built-in Wi-Fi". If using Ethernet will be set to "Wiznet W5500", "Olimex (LAN8720)", "WT32-ETH01", "M5STACK PoESP32 Unit" or "LilyGO T-ETH-POE".
• maintenance/reset: Set to 1 to trigger a reboot of the ESP. Auto-resets to 0.
• maintenance/mqttConnectionState: Last Will and Testament (LWT) topic. "online" when Nuki Hub is connected to the MQTT broker, "offline" if Nuki Hub is not connected to the MQTT broker.
• maintenance/uptime: Uptime in minutes.
• maintenance/wifiRssi: The Wi-Fi signal strength of the Wi-Fi Access Point as measured by the ESP32 and expressed by the RSSI Value in dBm.
• maintenance/log: If "Enable MQTT logging" is enabled in the web interface, this topic will be filled with debug log information.
• maintenance/freeHeap: Only available when debug mode is enabled. Set to the current size of free heap memory in bytes.
• maintenance/restartReasonNukiHub: Only available when debug mode is enabled. Set to the last reason Nuki Hub was restarted. See RestartReason.h for possible values
• maintenance/restartReasonNukiEsp: Only available when debug mode is enabled. Set to the last reason the ESP was restarted. See RestartReason.h for possible values

Misc

• presence/devices: List of detected bluetooth devices as CSV. Can be used for presence detection.

Over-the-air Update (OTA)

After the initial installation of the Nuki Hub firmware via serial connection, further updates can be deployed via OTA update from a browser.
In the configuration portal, scroll down to "Firmware update" and click "Open".
Then Click "Browse" and select the new "nuki_hub.bin" file and select "Upload file".
After about a minute the new firmware should be installed.

MQTT Encryption (optional; Wi-Fi and LAN8720 only)

The communication via MQTT can be SSL encrypted.
To enable SSL encryption, supply the necessary information in the MQTT Configuration page.

The following configurations are supported:
CA, CERT and KEY are empty -> No encryption
CA is filled but CERT and KEY are empty -> Encrypted MQTT
CA, CERT and KEY are filled -> Encrypted MQTT with client vaildation

Home Assistant Discovery (optional)

This software supports MQTT Discovery for integrating Nuki Hub with Home Assistant.
To enable autodiscovery, supply the discovery topic that is configured in your Home Assistant instance (If you have not changed this setting in Home Assistant the default is "homeassistant") in the MQTT Configuration page.
Once enabled, the Nuki Lock and/or Opener and related entities should automatically appear in your Home Assistant MQTT devices.

The following mapping between Home Assistant services and Nuki commands is setup when enabling autodiscovery:

	Smartlock	Opener (default)	Opener (alternative)
lock.lock	Lock	Disable Ring To Open	Disable Continuous Mode
lock.unlock	Unlock	Enable Ring To Open	Enable Continuous Mode
lock.open	Unlatch	Electric Strike Actuation	Electric Strike Actuation

NOTE: MQTT Discovery uses retained MQTT messages to store devices configurations. In order to avoid orphan configurations on your broker please disable autodiscovery first if you no longer want to use this SW. Retained messages are automatically cleared when unpairing and when changing/disabling autodiscovery topic in MQTT Configuration page.
NOTE2: Home Assistant can be setup manually using the MQTT Lock integration, but this is not recommended

Keypad control using JSON (optional)

If a keypad is connected to the lock, keypad codes can be added, updated and removed. This has to enabled first in the configuration portal. Check "Add, modify and delete keypad codes" under "Access Level Configuration" and save the configuration.

Information about current keypad codes is published as JSON data to the "keypad/json" MQTT topic.
This needs to be enabled separately by checking "Publish keypad codes information" under "Access Level Configuration" and saving the configuration. For security reasons, the code itself is not published.

To change Nuki Lock/Opener keypad settings set the keypad/actionJson topic to a JSON formatted value containing the following nodes.

Node	Delete	Add	Update	Usage	Possible values
action	Required	Required	Required	The action to execute	"delete", "add", "update"
codeId	Required	Not used	Required	The code ID of the existing code to delete or update	Integer
code	Not used	Required	Required	The code to create or update	6-digit Integer without zero's
enabled	Not used	Not used	Optional	Enable or disable the code, enabled if not set	1 = enabled, 0 = disabled
name	Not used	Required	Required	The name of the code to create or update	String, max 20 chars
timeLimited	Not used	Optional	Optional	If this authorization is restricted to access only at certain times, disabled if not set	1 = enabled, 0 = disabled
allowedFrom	Not used	Optional	Optional	The start timestamp from which access should be allowed (requires timeLimited = 1)	"YYYY-MM-DD HH:MM:SS"
allowedUntil	Not used	Optional	Optional	The end timestamp until access should be allowed (requires timeLimited = 1)	"YYYY-MM-DD HH:MM:SS"
allowedWeekdays	Not used	Optional	Optional	Allowed weekdays on which access should be allowed (requires timeLimited = 1)	Array of days: "mon", "tue", "wed", "thu" , "fri" "sat", "sun"
allowedFromTime	Not used	Optional	Optional	The start time per day from which access should be allowed (requires timeLimited = 1)	"HH:MM"
allowedUntilTime	Not used	Optional	Optional	The end time per day until access should be allowed (requires timeLimited = 1)	"HH:MM"

Example usage:
Examples:

• Delete: { "action": "delete", "codeId": "1234" }
• Add: { "action": "add", "code": "589472", "name": "Test", "timeLimited": "1", "allowedFrom": "2024-04-12 10:00:00", "allowedUntil": "2034-04-12 10:00:00", "allowedWeekdays": [ "wed", "thu", "fri" ], "allowedFromTime": "08:00", "allowedUntilTime": "16:00" }
• Update: { "action": "update", "codeId": "1234", "code": "589472", "enabled": "1", "name": "Test", "timeLimited": "1", "allowedFrom": "2024-04-12 10:00:00", "allowedUntil": "2034-04-12 10:00:00", "allowedWeekdays": [ "mon", "tue", "sat", "sun" ], "allowedFromTime": "08:00", "allowedUntilTime": "16:00" }

Result of attempted keypad code changes

The result of the last configuration change action will be published to the configuration/commandResultJson MQTT topic.
Possible values are "noPinSet", "keypadControlDisabled", "keypadNotAvailable", "keypadDisabled", "invalidConfig", "invalidJson", "noActionSet", "invalidAction", "noExistingCodeIdSet", "noNameSet", "noValidCodeSet", "noCodeSet", "invalidAllowedFrom", "invalidAllowedUntil", "invalidAllowedFromTime", "invalidAllowedUntilTime", "success", "failed", "timeOut", "working", "notPaired", "error" and "undefined".

Keypad control (alternative, optional)

If a keypad is connected to the lock, keypad codes can be added, updated and removed. This has to enabled first in the configuration portal. Check "Add, modify and delete keypad codes" under "Access Level Configuration" and save the configuration.

Information about codes is published under "keypad/code_x", x starting from 0 up the number of configured codes. This needs to be enabled separately by checking "Publish keypad codes information" under "Access Level Configuration" and saving the configuration. For security reasons, the code itself is not published. To modify keypad codes, a command structure is setup under keypad/command:

• keypad/command/id: The id of an existing code, found under keypad_code_x
• keypad/command/name: Display name of the code
• keypad/command/code: The actual 6-digit keypad code
• keypad/command/enabled: Set to 1 to enable the code, 0 to disable
• keypad/command/action: The action to execute. Possible values are add, delete and update

To modify keypad codes, the first four parameter nodes have to be set depending on the command:

• To add a code, set name, code, enabled **
• To delete a code, set id
• To update a code, set id, name, code, enabled

** Note: Rules for codes are:

• The code must be a 6 digit number
• The code can't contain 0
• The code can't start with 12

After setting the necessary parameters, write the action to be executed to the command node. For example, to add a code:

• write "John Doe" to name
• write 111222 to code
• write 1 to enabled
• write "add" to action

Time control using JSON (optional)

Time control entries can be added, updated and removed. This has to enabled first in the configuration portal. Check "Add, modify and delete time control entries" under "Access Level Configuration" and save the configuration.

Information about current time control entries is published as JSON data to the "timecontrol/json" MQTT topic.
This needs to be enabled separately by checking "Publish time control entries information" under "Access Level Configuration" and saving the configuration.

To change Nuki Lock/Opener time control settings set the timecontrol/actionJson topic to a JSON formatted value containing the following nodes.

Node	Delete	Add	Update	Usage	Possible values
action	Required	Required	Required	The action to execute	"delete", "add", "update"
entryId	Required	Not used	Required	The entry ID of the existing entry to delete or update	Integer
enabled	Not used	Not used	Optional	Enable or disable the entry, enabled if not set	1 = enabled, 0 = disabled
weekdays	Not used	Optional	Optional	Weekdays on which the chosen lock action should be exectued	Array of days: "mon", "tue", "wed", "thu" , "fri" "sat", "sun"
time	Not used	Required	Required	The time on which the chosen lock action should be executed	"HH:MM"
lockAction	Not used	Required	Required	The lock action that should be executed on the chosen weekdays at the chosen time	For the Nuki lock: "Unlock", "Lock", "Unlatch", "LockNgo", "LockNgoUnlatch", "FullLock". For the Nuki Opener: "ActivateRTO", "DeactivateRTO", "ElectricStrikeActuation", "ActivateCM", "DeactivateCM"

Example usage:
Examples:

• Delete: { "action": "delete", "entryId": "1234" }
• Add: { "action": "add", "weekdays": [ "wed", "thu", "fri" ], "time": "08:00", "lockAction": "Unlock" }
• Update: { "action": "update", "entryId": "1234", "enabled": "1", "weekdays": [ "mon", "tue", "sat", "sun" ], "time": "08:00", "lockAction": "Lock" }

GPIO lock control (optional)

The lock can be controlled via GPIO.

To enable GPIO control, go the the "GPIO Configuration" page where each GPIO can be configured for a specific role:

• Disabled: The GPIO is disabled
• Input: Lock: When connect to Ground, a lock command is sent to the lock
• Input: Unlock: When connect to Ground, an unlock command is sent to the lock
• Input: Unlatch: When connect to Ground, an unlatch command is sent to the lock
• Input: Lock n Go: When connect to Ground, a Lock n Go command is sent to the lock
• Input: Lock n Go and unlatch: When connect to Ground, a Lock n Go and unlatch command is sent to the lock
• Input: Electric strike actuation: When connect to Ground, an electric strike actuation command is sent to the opener (open door for configured amount of time)
• Input: Activate RTO: When connect to Ground, Ring-to-open is activated (opener)
• Input: Activate CM: When connect to Ground, Continuous mode is activated (opener)
• Input: Deactivate RTO/CM: Disable RTO or CM, depending on which is active (opener)
• Input: Dectivate RTO: When connect to Ground, Ring-to-open is deactivated (opener)
• Input: Dectivate CM: When connect to Ground, Continuous mode is deactivated (opener)
• Output: High when locked: Outputs a high signal when the door is locked
• Output: High when unlocked: Outputs a high signal when the door is unlocked
• Output: High when motor blocked: Outputs a high signal when the motor is blocked (lock)
• Output: High when RTO active: Outputs a high signal when ring-to-open is active (opener)
• Output: High when CM active: Outputs a high signal when continuous mode is active (opener)
• Output: High when RTO or CM active: Outputs a high signal when either ring-to-open or continuous mode is active (opener)
• General input (pull-down): The pin is configured in pull-down configuration and its state is published to the "gpio/pin_x/state" topic
• General input (pull-up): The pin is configured in pull-up configuration and its state is published to the "gpio/pin_x/state" topic
• Genral output: The pin is set to high or low depending on the "gpio/pin_x/state" topic

Note: The old setting "Enable control via GPIO" is removed. If you had enabled this setting before upgrading to 8.22, the PINs are automatically configured to be compatible with the previously hard-coded PINs.

Connecting via Ethernet (Optional)

If you prefer to connect to the MQTT Broker via Ethernet instead of Wi-Fi, you either use one of the supported ESP32 modules (see about section above), or wire a seperate Wiznet W5x00 Module (W5100, W5200, W5500 are supported). To use a supported module, flash the firmware, connect via Wi-Fi and select the correct network hardware in the MQTT and network settings section.

To wire an external W5x00 module to the ESP, use this wiring scheme:

• Connect W5x00 to ESP32 SPI0:
  
  • W5x00 SCK to GPIO18
    
  • W5x00 MISO to GPIO19
    
  • W5x00 MOSI to GPIO23
    
  • W5x00 CS/SS to GPIO5
    
• Optionally connect:
  
  • W5x00 reset to GPIO33
    

Now connect via Wi-Fi and change the network hardware to "Generic W5500".
If the W5500 hwardware isn't detected, Wi-Fi is used as a fallback.

Note: Encrypted MQTT is only available for Wi-Fi and LAN8720 modules, W5x00 modules don't support encryption
(that leaves Olimex, WT32-ETH01 and M5Stack PoESP32 Unit if encryption is desired).

If encryption is needed, Olimex is the easiest option, since it has USB for flashing onboard.

Troubleshooting

Random Wi-Fi disconnects

Unfortunately the ESP32 has problems with some access points and reconnecting fails.
As a workaround you can navigate to "MQTT and Network Configuration" and enable "Restart on disconnect".
This will reboot the ESP as soon as it gets disconnected from Wi-Fi.
Also, this reduces the config portal timeout to three minutes to prevent the ESP being stuck in config mode in case an access point is offline temporarily.
If this still doesn't fix the disconnects and the ESP becomes unreachable, the "Restart timer" option can be used as a last resort.
It will restart the ESP after a configured amount of time.

Pairing with the lock (or opener) doesn't work

First, make sure the firmware version of the Nuki device is up-to-date, older versions have issues pairing.
Next, try erasing the ESP32 flash and then (re-)flash the firmware.
To erase the flash, use the espressif download tool and click the "Erase" button.
Afterwards flash the firmware as described in the readme within the 7z file.

Also, there are reports that ESP32 "DEVKIT1" module don't work and pairing is not possible. The reason is unknown, but if you use such a module, try a different one.

Reported as working are:

• M5Stack ATOM Lite
• ESP32-WROOM-32D (DEVKIT V4)
• ESP32-WROOM-32E
• ESP32-S3-WROOM-1

For more information check the related issue: https://github.com/technyon/nuki_hub/issues/39

Also, check that pairing is allowed. In the Nuki smartphone app, go to "Settings" --> "Features & Configuration" --> "Button & LED" and make sure "Bluetooh Pairing" is enabled.

A note about the M5Stack PoESP32 Unit. Here the initial Bluetooth reception is very poor (range less than one meter). The reason is that the module does not have an antenna on the PCB, but only an IPEX connector. By retrofitting an external SMA antenna (IPEX, or other names U.FL, IPAX, IPX, AMC, MHF, UMCC), bluetooth/Wifi works over several meters.

In Home Assistant, the lock/opener is shown as unavailable

Make sure you are using at least version 2023.8.0 of Home Assistant.
The Home Assistant developers have made changes to MQTT auto discovery which break support for older version and Nuki Hub has adopted these changes.
This unfortunately means that older versions of Home Assistant are not supported by the Nuki Hub discovery implemenation anymore.

FAQ

Nuki Hub doesn't work when Wi-Fi on a Nuki Smartlock Pro (3.0 / 4.0) is turned on.

According to Nuki this is by design and part of the specification of the Pro lock.
You can use either the built-in Wi-Fi or a Bridge (which Nuki Hub registers as).
Using both at the same time is not supported.

Certain functionality doesn't work (e. g. changing configuration, setting keypad codes)

Some functionality is restricted by the Lock (or Opener) firmware and is only accessible when the PIN is provided.
When setting up the lock (or opener), you have to set a PIN in the Nuki smartphone app.
Navigate to the Nuki Hub Credentials page, enter this PIN and click save.

Authorization data isn't published

See the previous point, this functionality needs the correct PIN to be configured.

Using Home Assistant, it's only possible to lock or unlock the door, but not to unlatch it

Make sure "Access level" under "Advanced Nuki Configuration" is set to "Full".

Unlatching can be triggered using the lock.open service.

Alternatively an "Unlatch" button is exposed through Home Assistant discovery.
This button is disabled by default, but can be enabled in the Home Assistant UI.

When controlling two locks (or openers) connected to two ESPs, both devices react to the same command. When using Home Asistant, the same status is display for both locks.

When using multiple Nuki devices, different paths for each device have to be configured.
Navigate to "Nuki Configuration" and change the "MQTT Nuki Smartlock Path" or "MQTT Nuki Opener Path" under "Basic Nuki Configuration" for at least one of the devices.

The Nuki battery is draining quickly.

This often is a result of enabling "Register as app".
Doing so will cause Nuki Hub to constantly query the lock and as such cause excessive battery drain.
To prevent this behaviour, unpair Nuki Hub, disable "Register as app", and re-pair.

Never enable "Register as app" unless you intend to use a Nuki Bridge in addition to Nuki Hub!

Building from source

Docker (Preferred)
See the README in the Docker directory for instructions on building using Docker.

VMWare image (Not preferred, not using the latest Arduino ESP32 release at this time)
A virtual machine (VMWare image) that is setup to compile Nuki Hub is available for download at:
https://drive.google.com/file/d/1fUVYHDtxXAZOAfQ321iRNIwkqFwuDsBp/view?usp=share_link

User and password for the VM are both "nuki" and "nuki".
The source is checked out at ~/projects/nuki_hub, the cmake build directory is build.

To compile, run the following commands:

cd projects/nuki_hub/build
ninja

To upload the image via serial port, run:

ninja upload-nuki_hub

The serial device is defined in ~/.bashrc (Environment variable SERIAL_PORT), which you'll eventually have to adopt to your device.

Disclaimer

This is third party software for Nuki devices.
This project or any of it's authors are not associated with Nuki Home Solutions GmbH.
Please refer for official products and support to the Nuki official website:
https://nuki.io/

For further license details, check the included LICENSE file.