[OBSOLETE] Nuki smart lock device handler

volski · December 23, 2017, 8:18pm

I have created a device handler for the Nuki smart lock

controls the lock - and also updates the lock status if was changed from outside the Smartthings app - update interval is 1 minute.

ambres · February 19, 2018, 7:41am

Volski,

sorry to bother you but i am a newbie!!!
How do i sync your handler with my smartthings???
sorry for my total ignorance
Ambres

JDRoberts · February 19, 2018, 4:26pm

Basically you will copy the author’s code and paste it into your own account. The following FAQ describes the process (this is a clickable link)

[OBSOLETE] FAQ: An Overview of Using Custom Code in SmartThings (SmartThings Classic, Groovy Code) FAQ

The original FAQ information in this thread refers to the original smartthings architecture, which was in place through the end of 2022 and a little beyond. Custom code was written in the groovy programming language and ran in the smartthings cloud. As of May 2023, you can no longer add new Groovy DTH‘s or smartapps to your smartthings account. So if you came here because of a link in an old forum thread, or on another site, I’m afraid the Groovy information is no longer usable. All of this was replaced by a new architecture. Cloud to cloud integrations use the smartthings API. Hub connected devices, mostly Zigbee and zwave, now use “Edge Drivers,” written in the LUA programming language. Here’s the official announcement on those: The process for using a custom Edge Driver in the new …

Rita_El_Khoury · February 20, 2018, 9:40am

@volski I have a Nuki lock and I’m trying to set this up but I have no idea how to finish it. What I’ve done so far:

Copied the text from github under the “nukiWebApiHandler.groovy” commit, which seemed to be the most recent.
Created a new Device Handler for me in SmartThings with this code, but replaced “Enter you web API token here” with the API Token I generated here: https://web.nuki.io/en/#/admin/web-api (right column) and the “enter your NukiID” with my email for Nuki Web… seems like this is the ID to me.
Published it for myself, so now I see it under My Device Handlers.
Then I went to create a new Device in the dev interface, I gave it a name, Type simulated lock, version self published, location/hub/group done… but I have no idea what to put for the Device network ID.

Can you let me know if the steps I did were right and how I should continue?

Edit: well, that was easy. I just figured I’d try any Device Network ID, put in “nuki,” and it worked. I can see my lock’s state. I dare not unlock it now because I’m not home, but it’s cool to have it finally show up in SmartThings.

danielccm · March 4, 2018, 11:54pm

Out of all the files from your Github… which should we install? All of them?

jamesxheath · March 6, 2018, 12:47pm

Hi,

I’ve followed Rita’s (guessed but really useful) instructions, which has got me some of the way…
I started with the ID set to my email, but I get “waiting” in grey where Rita gets “locked” in red.
(I waited till the net day)

Reading in here:

suggests that the NukiId should be a numeric, and it implies it starts at 1 and goes up with the number of locks.
I only have one, so I’ve set that to “1”…

but I still get "waiting"
Anyone got any pointers?

(when creating the API token, I only gave it read privileges - might that be an issue?)

Cheers,

James

volski · March 6, 2018, 1:53pm

hi
first make sure you use the web api version:

github.com

volski/Smartthing-nuki/blob/master/nukiWebApiHandler.groovy

import groovy.json.JsonSlurper

metadata {
    // Automatically generated. Make future change here.
    definition (name: "Simulated Lock", namespace: "Volski", author: "Volski") {
        capability "Actuator"
        capability "Sensor"
        capability "Health Check"

        capability "Lock"
        capability "Battery"
        capability "Refresh"
        command "lockNgo"
        
    }
	preferences {
        input("api_token","string",title:"Api Web Token",description:"Enter your web API token",required:true ,displayDuringSetup: true)
        input("nukiId","string",title:"nukiId",description:"Enter your nukiId",required:true ,displayDuringSetup: true)
	}
    tiles {

This file has been truncated. show original

second:

log in to your account at web.nuki.io
enable the api - and copy the token
in the smartthings web console.
click on the device name you have created
and under Preferences click on edit
you have two fields first is the api token you copied from nuki website
and second is the device id the simplest way is this:
go to https://www.hurl.it select the GET method copy to the Destination url: https://api.nuki.io/smartlock
next add HEADERS - in the name field: Authorization and in the Value write: barer yourApiToken
and click on the Launch Request
if all is good you will get a json response with your locks
if you have more then one you will need to create a device handler for each one.
from the response json copy the value of smartlockId
this is the needed value for the second filed from the device handler
now click on save and you can control your lock!

volski · March 6, 2018, 5:54pm

only this one:

github.com

volski/Smartthing-nuki/blob/master/nukiWebApiHandler.groovy

import groovy.json.JsonSlurper

metadata {
    // Automatically generated. Make future change here.
    definition (name: "Simulated Lock", namespace: "Volski", author: "Volski") {
        capability "Actuator"
        capability "Sensor"
        capability "Health Check"

        capability "Lock"
        capability "Battery"
        capability "Refresh"
        command "lockNgo"
        
    }
	preferences {
        input("api_token","string",title:"Api Web Token",description:"Enter your web API token",required:true ,displayDuringSetup: true)
        input("nukiId","string",title:"nukiId",description:"Enter your nukiId",required:true ,displayDuringSetup: true)
	}
    tiles {

This file has been truncated. show original

danielccm · March 6, 2018, 6:43pm

Added! Just waiting for my Nuki to arrive to test it all out… Thanks!

Now… I feel like a newb with this Q but… what are the Owner, name and branch of the github for the integration?

volski · March 6, 2018, 9:45pm

where are you trying to fill this fields?
on the device handler you just need you api token and the nuki lock id

danielccm · March 6, 2018, 10:25pm

in the github integration page in the api…

Here:

Github%20integration

volski · March 6, 2018, 10:43pm

you already have the repo there
in my console I dont have the repo option so when I added it i just copy paste the code
added detailed instructions:

github.com

volski/Smartthing-nuki/blob/master/README.md

# Smartthing-nuki
nuki smart lock controller for Smartthings
steps to install the device handler:
1. Copy the code and login into the smartthings console https://graph.api.smartthings.com (EU Site https://graph-eu01-euwest1.api.smartthings.com)
2. At the top of the console click on "My Device Handlers"
3. Click on "Create New Device Handler"
4. Next on the top select "From Code"
5. Paste the code into the page and click on "Create" at the bottom of the page
6. After you get the "Device type published successfully" - click on "Publish" and select "For me"
7. Click on "My Devices" at the top
8. Click on "New Device"
9. In the "Name" fill -> Nuki (or anything else this will be the name of the Device)
10. In the "Device Network Id" fill -> Nuki (or anything else - must be unique).
11. In the "Type" select "Simulated Lock" (this is the device we have created in the steps before)
12. In the "Version" select "Self-Published"
13. In "Location" select your location
14. In "Hub" select the hub you want to control the nuki
15. Click on "Create"
16. DONT close the console open a new page and go to https://web.nuki.io
17. Login to your account click on the setting at the top and select API

This file has been truncated. show original

danielccm · March 6, 2018, 11:02pm

I was refering to the automatic sync between the ST API and Github… just for reference, here are the 3 things needed… I think… correct me if I’m wrong…

Owner: volski
Name: Smartthing-nuki
Branch: master

as for the DH itself… I can’t wait to have the lock in my hands… Thanks for your work!!! Awesome!

volski · March 6, 2018, 11:04pm

yes that is correct

M-TOWN · September 14, 2018, 4:44pm

Hey volski thanks for this incredible DH. But is there an way that the other states like lockngo i can see in the new ST app?? At the time i only see locked unlocked

yves_delvaux · December 19, 2018, 3:22pm

Hello, thanks for explanation but I can’t find a place to input the API Token generated?

do we have to input it in the code given by Volksi?
here ?
preferences {

    input("api_token","string",title:"Api Web Token",description:"Enter your web API token",required:true ,displayDuringSetup: true)

    input("nukiId","string",title:"nukiId",description:"Enter your nukiId",required:true ,displayDuringSetup: true)

Or is this something that appears afterwards?

yves_delvaux · December 19, 2018, 4:19pm

hello, athanks for this but I can’t find any “preferences” for the device name that I have created? Is this normal.
The Web Token API you have to input, is this a long string or the name you gave when creating the token?
where is this information to be filled in? re place the string indicated in bold in your code?

input(“api_token”,“string”,title:“Api Web Token”,description:“Enter your web API token”,required:true ,displayDuringSetup: true)

    input("nukiId","string",title:"nukiId",description:"Enter your nukiId",required:true ,displayDuringSetup: true)

Bdbest · March 25, 2019, 6:48pm

Hi I got the same problem

There is no where this “preferences” to add the API information… any solution you found?

Thanks!

Bdbest · March 26, 2019, 11:44am

okay i solved it - copy the code NOT from the Browser but download the git code first before pasting, then it works (syntax/ copy issue otherwise)!!

M-TOWN · July 17, 2019, 9:04am

I think the support of this DTH is dead!!!

[OBSOLETE] Nuki smart lock device handler

Customers

Developers

Download the SmartThings App