Nuki integration development

Development
1

The project to date

Features

The service adds the ability to:

  • control Nuki-brand connected locks: lock, unlock
  • report certain information to Gladys (battery level, lock state)

Screenshot

nuki_dashboard_boxes
nuki_dashboard_boxes1840×928 73.7 KB

nuki_integration_devices
nuki_integration_devices1795×1209 139 KB

Integration

There are 2 possible integrations (choose one because doing both at the same time isn’t really useful)

NukiWeb API Key

Prerequisite: Gladys must have internet access at all times

  1. Activate and configure your Nuki Web account \[Nuki Web Configuration\]
    (https://help.nuki.io/hc/fr/articles/360016485718-Activer-et-désactiver-un-compte-Nuki-Web#:~:text=Activez%20Nuki%20Web%20dans%20l,dans%20l’App%20de%20Nuki.)

nukiweb
nukiweb3556×1438 250 KB

nukiweb_auth
nukiweb_auth1102×1011 40.2 KB

  1. Configure the Nuki service in Gladys by adding the API key and then performing an HTTP scan
    nuki_integration_configuration
    nuki_integration_configuration1831×1033 121 KB

nuki_integration_discover_http
nuki_integration_discover_http1822×1231 150 KB

MQTT

Prerequisite: Gladys’ MQTT is configured and functional

  1. Configure MQTT in the Nuki app (use the local IP of the MQTT, not the domain name) Nuki configuration with MQTT

    nukiapp_mqtt1
    nukiapp_mqtt1337×750 49.2 KB

    nukiapp_mqtt2
    nukiapp_mqtt21080×2400 173 KB

  2. Go directly to the MQTT discovery of the Nuki service in Gladys to see your devices there

nuki_integration_discover_mqtt
nuki_integration_discover_mqtt1780×1252 146 KB

Roadmap

  • Write the documentation (although this one isn’t too bad)
  • Integrate the notion of trigger (who or what opened the lock, e.g.: User1 opened the lock, the lock performed an auto-lock …)
  • Adapt the scene part to the lock button
  • Adjust the graphical part (display the states)

Installation

The test nukidev image is here.

For more information

RFTM :wink:

Call for testers and the community

I’m asking people who have this type of device and can run tests to send me their feedback.

I have a Nuki v3 (so not available with Matter)

I’m available for additional information.

2 Likes
2

Thanks for this development @ProtZ, it looks great :slight_smile:

For the documentation, you can make a PR on this repo :

The documentation is markdown files in this folder (for the article in English) :

And here for the article in French :

To write the documentation, I recommend taking your screenshots in English then in French in Gladys, then writing the documentation in French, and asking ChatGPT to translate the article for you.

3

For your information, I mentioned this topic in the newsletter that will go out tomorrow morning :slight_smile:

I hope we’ll have testers! If we don’t have anyone by next week, we can still move forward since you tested on your side.

1 Like
4

Great, I just opened the PR for the docs, but I don’t know how to test it :confused:

5

I think there’s a small issue with your PR, it modifies more than 1,300 files :smiley:

Try starting again from master and recreating your files.

Screenshot 2025-10-04 at 10.10.31
Screenshot 2025-10-04 at 10.10.311496×550 65.4 KB

To test locally afterwards, all the instructions are in the README: GitHub - GladysAssistant/v4-website: Gladys Assistant website

6

Sorry, I messed up.
I’ve just redone it properly. But it’s impossible to test locally without digging a bit deeper:


Error: Illegal return statement
  
  - dev.html.template.ejs:5 ./node_modules/html-webpack-plugin/lib/loader.js!./node_modules/@docusaurus/core/lib/webpack/templates/dev.html.template.ejs
    [v4-website]/[@docusaurus]/core/lib/webpack/templates/dev.html.template.ejs:5:1
7

What version of Node.js are you on? You need to use Node >= 18. I’m on Node 22

8

Same for v22.14.0 :frowning:

9

I’m on v22.18.0, though I don’t know if that changes much.

Did you run git clone then yarn and finally npm start?

I just re-ran the test from a clean repo to make sure everything was fine, and everything works :thinking:

10

I’m responding a bit late, but I have a Nuki series (if you still need to test…)

1 Like
11

Still looking for testers @StephaneB!

1 Like
12

Ok. But I didn’t quite understand from the thread of this discussion whether it was ready to test or whether we needed to wait for changes before being able to test…

2 Likes
13

@ProtZ can you share the Docker image tag with us so that @StephaneB can test?

The link you posted in your original post is a private link

14

Sorry, I hadn’t seen that the link was private:

https://hub.docker.com/r/ngeissel/gladys/tags

docker pull ngeissel/gladys:nukidev

thanks @StephaneB, keep me posted :slight_smile:

1 Like
15

Hi @ProtZ,

Would you be up for doing another review via video call with screen sharing like last time?

I’m available this afternoon, or every evening this week, or during the day on Friday.

I would have liked in-person testers, but oh well, we won’t wait forever :slight_smile: