Nuki Hub: ESP32 open-source alternative for SmartLock-MQTT integration

Nuki APIs MQTT API
,
#1

Hi everybody,

If anyone is interested in an alternative open-source solution to the official MQTT API implementation for SL2/SL3, please check the Nuki Hub project by @technyon. With a $5-10 ESP32 device, you’ll be able to have total control and management of the Smart Lock. This is expecially useful for Nuki SL2 users, who don’t have an MQTT solution and are forced to upgrade to SL3 Pro with Bridge.

You will have total local control of the lock via MQTT and also automatic integration (auto-discovery) with Home Assistant. All LOCAL, no internet dependency. Nuki Hub acts as a bridge, communicating with the lock via BLE API and via wifi (or ethernet) for MQTT.

Supported devices:

  • NUKI Smart Lock 1.0
  • NUKI Smart Lock 2.0
  • NUKI Smart Lock 3.0
  • NUKI Smart Lock 3.0 Pro
  • NUKI Opener
  • NUKI Keypad 1.0
  • NUKI Keypad 2.0

Recommended ESP32 devices:

Wifi

PoE

Features:
For a list of features please refer to the github repository readme, it would be too long to duplicate it here.

Home Assistant integration:
For Home Assistant users: this is the device view in the MQTT integration, without configuring anything. NH leverages auto-discovery to configure the Smart Lock automatically in Home Assistant.

image
image648×713 41.4 KB

With other 3 people, we are actively helping the developer test and implement new functionalities. Please redirect all support issues to the github repo, this thread is mainly to inform all Nuki users about an alternative solution.

Thanks @Juergen for allowing us to inform users about this solution.

Cheers,

Alessandro

6 Likes
MQTT API Specification v1.4
#2

I love NUKI Hub. Decided to went that path for my SL3 and SL3 PRO.

Very happy meanwhile with it. Even today with the productive release of MQTT support in the official NUKI app I think „should I really switch (for the SL3 PRO)?“. I think I‘ll stay for now, even native MQTT might outperform (in terms of reaction times) the Bluetooth based NUKI Hub eventually.

Great work, I can really recommend it.

1 Like
#3

Thanks for the kind words.

Regarding the reaction times, you could do some benchmarks, I think you would be surprised. :wink:

#4

I have no comparison to be honest. Sometimes it takes a moment especially for entity status in HA to update when locally controlled via button (or completely manually). Might also be on HA side.

Only read something from native MQTT users today talking bout „milliseconds“ so that’s why I mentioned it.

#5

The difference comes from the different ways on how to feed the MQTT client.

The ESP module get’s a notification that there is something new, connects to the lock and fetches some infos (push & pull). The Nuki bridge works the same way. This can take some time (~1-2s) depending on the BLE connection state of the module when the event occurs.

The native MQTT API directly pushes events via MQTT when they happen in the firmware. Therefore it is almost instantenous and can send several events in short succession (e.g. transition states like “locking …”).

Whether you need this speed or not depends on the usecase. There is no general rule which thing is better, because there are other factors at play as well (e.g. WiFi draws more energy on the other hand SL3Ps WiFi also works as bridge for the Nuki App. The Nuki Hub has GPIOs …). Both have their right to exist. The Nuki Hub is certainly one of the best and most complete implementations of the Nuki BLE API out there and a fantastic piece of work.

6 Likes
#6

Great to read this acknowledgement. I still believe Nuki Hub is what the Nuki Bridge should’ve been since the beginning. I hope one day we’ll see a Nuki Bridge 2, with an ESP32 and native MQTT and Home Assistant auto-discovery integration, so that also Nuki SL2 customers could use it, not only SL3 ones.

Maybe some hardware tinkerer could think about retrofitting the Nuki Bridge with an ESP32 device. :slight_smile:

#7

Awesome!!
Thank you very much for this complement. It is much appreciated.

Great that you guys are open minded and have shared the API with very good documentation. Without this and your help on this forum I would not have been able to create the underlying library ( NukiBleEsp32) Nuki Hub uses.

Kudos to all who have worked on this…
Very nice to see efforts of different people coming together in a nice, practical and usable tool like Nuki Hub.

#8

Dumb question - can I also have my Nuki locks talking to the Bridge (as I currently have setup), so this Nuki Hub becomes an additional comms channel not a replacement?

I’d like to be able to use both!

#9

I have not tried it but in theory I think yes, it uses the same bt connection and api as the app and both app and bridge can also be used on the same lock.

But not exactly simultaniously as only 1 device can have the bt connection with the lock (i think). One of the nuki developers should be able to confirm this.

#10

You can read info on the repo:

image
image896×274 21.4 KB

#11

The Nuki Hub is certainly one of the best and most complete implementations of the Nuki BLE API out there and a fantastic piece of work.

Thanks for your appreciating words @Juergen and thanks to @i-connect for writing the library that enables NUKI Hub to work. I like the fact that the API is well documented, I wish more companies were open like this. There are users now across all kind of home automation platforms, Home Assistant being the biggest community I think (according to number of opened issues), but also iobroker, openhab, FHEM and probably more.

Thanks to supporters and the community we got NUKI Hub to stable state, which was a problem especially in the beginning, and we were able to add a lot of requested features. It’s not always easy to balance between user expectations, technical feasibility and scope of the project, but I’d like to think we did a pretty good job at that so far.

1 Like
#12

Hi,
I’m considering the Nuki to use with my Ultion locks in the UK, so I can still have the same key for other external locks. I would be looking to integrate into my Home Assistant setup, exposing the lock to HomeKit.

Looking at the recommended ESP32 devices, do the WiFi ones (Atom U/Lite) communicate with the Nuki lock via BLE? I can’t see this listed in their specs?

Do I need an SL3 or SL3Pro to work with the Atom U/Lite ESP32?

Thanks
Will

#13

All ESP32 based devices should have BLE support, IIRC.

The Atom devices are based on the ESP32-PICO-D4, here the specs from the datasheet:

image
image860×647 80.2 KB

Nuki Hub communicates with the Nuki Lock via BLE and uses its WiFi for LAN communications.

For Home Assistant integration, Nuki Hub natively supports MQTT Discovery, so once you configure the MQTT broker to be used, the device will automatically be picked up by Home Assistant with all the relevant entities. True Plug and Play. :slight_smile:

As stated on the project’s repo, here’s the list of supported locks:

image
image862×391 10.7 KB

#14

Thanks for the reply. I’m an absolute noob with regards to ESP32. This will be my first time using one with HA.

#15

Don’t worry Will, thanks to the work of @technyon and some advices from the support team (me included) you won’t have to care much about the hw details. Just flash the firmware and then you open NH webpage to configure things. And if you need help, use the GH repo or join the Nuki Hub Discord Server.

1 Like
#16

@Juergen - it would be great if the Door Sensor protocol could be documented. That would Nuki Hub to push the door state back to the lock by using any door sensing method the user desires (Nuki feature request and Nuki Hub feature request).

Do you think that would be possible? Alternatively, if the bridge/web API can be updated to allow pushing state another way, that would work, too.

Thanks!

#17

is it also possible to pair the bridge again after pairing the nuki hub?

#18

Interesting: the nuki bridge seems to already have a ESP-WROOM-02 chip for WIFI + Cypress CY8C4248LQI-BL483 chip for Bluetooth according to this teardown-article: (A peek inside the Nuki Smart Lock - The π Computer Club) maybe some day we see a open-source firmware like “ESPHome Nuki Lock” or “Nuki HUB” ported to the original Nuki Bridge HW :)))

1 Like