[Request] Plugin for NUKI

---

Is anyone of the @developer’s interested in creating a plugin for the NUKI doorlock system?

At NUKI you will find further informations how it works and so on. The NUKI API can be found here.

I have found a developer who has written some code for javascript the access the API. Maybe this helps a little bit.

So, it would be cool if we can have such a device to lock, unlock the doorlock over pimatic

@kenci I have drafted a plugin which monitors the state of nuki smart locks. https://www.npmjs.com/package/pimatic-nuki

@mwittig many thanks. I will try it as soon as possible!

@mwittig i have tried your plugin but got some problems with it.
My config

{
 "host": "192.168.1.52",
 "token": "mytoken",
 "plugin": "nuki",
 "active": true,
 "debug": true,
 "port": 8080
}

Accessing the API over the browser at http://192.168.1.52:8080/list?token=mytoken i got
[{"nukiId": 87053113, "name": "Zuhause"}]

I am using the autodiscover function but no nuki device there.

@kenci said in [Request] Plugin for NUKI:

I am using the autodiscover function but no nuki device there.

Strange. Do you get error message in the log? Did you restart Pimatic after installing the plugin?

I restarted pimatic and got this error

Unhandled rejection RequestError: Error: connect EHOSTUNREACH 192.168.1.52:8080
    at new RequestError (/home/pi/pimatic-app/node_modules/pimatic-nuki/node_modules/nuki-bridge-api/node_modules/request-promise/node_modules/request-promise-core/lib/errors.js:14:15)
    at Request.plumbing.callback (/home/pi/pimatic-app/node_modules/pimatic-nuki/node_modules/nuki-bridge-api/node_modules/request-promise/node_modules/request-promise-core/lib/plumbing.js:87$
    at Request.RP$callback [as _callback] (/home/pi/pimatic-app/node_modules/pimatic-nuki/node_modules/nuki-bridge-api/node_modules/request-promise/node_modules/request-promise-core/lib/plumb$
    at self.callback (/home/pi/pimatic-app/node_modules/pimatic-nuki/node_modules/nuki-bridge-api/node_modules/request/request.js:187:22)
    at emitOne (events.js:77:13)
    at Request.emit (events.js:169:7)
    at Request.onRequestError (/home/pi/pimatic-app/node_modules/pimatic-nuki/node_modules/nuki-bridge-api/node_modules/request/request.js:813:8)
    at emitOne (events.js:77:13)
    at ClientRequest.emit (events.js:169:7)
    at Socket.socketErrorListener (_http_client.js:267:9)
    at emitOne (events.js:77:13)
    at Socket.emit (events.js:169:7)
    at Socket.emit (/home/pi/pimatic-app/node_modules/pimatic/startup.coffee:63:24)
    at emitErrorNT (net.js:1253:8)
    at nextTickCallbackWith2Args (node.js:442:9)
    at process._tickDomainCallback (node.js:397:17)

So i changed from IP address to host “nuki.lan” and now it discovered a new Nuki device.

I closed the door with NUKI over my smartphone but on pimatic it’s opened after minutes.

Is the plugin requsting once an update?

21:38:21.345 [pimatic] info: New device "Eingangstuer"...
21:38:21.705 [pimatic-nuki] debug: [Nuki#nuki-eingang] Requesting update

After that line i got nothing from pimatic-nuki

@kenci said in [Request] Plugin for NUKI:

So i changed from IP address to host “nuki.lan” and now it discovered a new Nuki device.

To which ip address does ‘nuki.lan’ resolve? Maybe you picked the wrong ip address before?

Is the plugin requsting once an update?

No it is requested periodically every 30 seconds, unless you changed the intervall property as part of the device configuration.

EDIT: Found a bug in the update handling code and published a plugin update

PING nuki.lan (192.168.1.52) 56(84) bytes of data.
64 bytes from nuki.lan (192.168.1.52): icmp_seq=1 ttl=128 time=20.4 ms
64 bytes from nuki.lan (192.168.1.52): icmp_seq=2 ttl=128 time=49.3 ms
64 bytes from nuki.lan (192.168.1.52): icmp_seq=3 ttl=128 time=65.3 ms

@kenci OK, but then it should also work if you set the “host” property to the IP address like you did before.
Maybe it was a temporary network problem?

Is it possible to integrate the lockActions into the plugin?
when i open a url in my browser, i can run lockActions
example http://192.168.X.XX:8080/lockAction?nukiId=12345678&action=1&token=abcdef
Or is it possible to open this url with shell-execute?
I tried cURL and HTTPie but it does not work.
Any idea?

@weini
could you pls open an issue for your request on github so the devs can take care when they have spare time
https://github.com/mwittig/pimatic-nuki/issues

Hi Weini,

I wrote a simple shell script. You can use it with shell execute from pimatic. Hope it helps:

#!/bin/bash

###############################################################
##This is written to read the state of nuki and handle the door
##USAGE
##
##nuki.sh OPEN|UNLOCK|LOCK ; you can also use it without an argument to get just the current state
##
##PLEASE ENTER BELOW THE NEEDED PARAMTERS FOR YOUR NUKI
##
URL="192.168.x.x"
PORT="8080"
TOKEN="abcdef"
NUKIID="12345656788"
LOGFILE="/home/pi/pimatic/logs/anylogfileyouwant" # For export of the current state (You can parse it with pimatic log-reader)
###############################################################
COMMAND="$1"


function ParseNukiResponse {
  i=0
  Response=$(curl -s "$1")
  Response=(${Response:1:${#Response}-2})

  for element in "${Response[@]}"
  do
    ((i++))
    if [ $i -lt ${#Response[@]} ]; then
      value=${Response[$i]//,}
    else
      value=""
    fi
    if [ "$element" == '"state":' ]; then
      STATE=$value
    fi
    if [ "$element" == '"stateName":' ]; then
      STATENAME=$value
    fi
    if [ "$element" == '"batteryCritical":' ]; then
      BATTERYCRIT=$value
    fi
    if [ "$element" == '"success":' ]; then
      SUCCESS=$value
    fi
  done
}

ParseNukiResponse "http://"$URL":"$PORT"/lockState?nukiId="$NUKIID"&token="$TOKEN""

if [ "$COMMAND" == "OPEN" ]; then
  ParseNukiResponse "http://"$URL":"$PORT"/lockAction?nukiId="$NUKIID"&token="$TOKEN"&action=3"
  if [ "$SUCCESS" == "true" ]; then
    STATE="3"
  fi
fi
if [ "$COMMAND" == "UNLOCK" ]; then
  ParseNukiResponse "http://"$URL":"$PORT"/lockAction?nukiId="$NUKIID"&token="$TOKEN"&action=1"
  if [ "$SUCCESS" == "true" ]; then
    STATE="3"
  fi
fi
if [ "$COMMAND" == "LOCK" ]; then
    if [ "$STATE" == "3" ]; then
      ParseNukiResponse "http://"$URL":"$PORT"/lockAction?nukiId="$NUKIID"&token="$TOKEN"&action=2"
      if [ "$SUCCESS" == "true" ]; then
        STATE="1"
      fi
    else
      echo "Door already locked"
   fi
fi

:> $LOGFILE
echo "STATE: $STATE" >> $LOGFILE
echo "STATENAME: $STATENAME" >>$LOGFILE
echo "BATT: $BATTERYCRIT" >>$LOGFILE
echo "SUCCESS: $SUCCESS" >> $LOGFILE

Thank you for the script, but it does not work. I get the following error:
pi@raspberrypi:~ $ sh pimatic-app/nuki.sh
pimatic-app/nuki.sh: 20: pimatic-app/nuki.sh: function: not found
pimatic-app/nuki.sh: 23: pimatic-app/nuki.sh: Syntax error: “(” unexpected

how did you create the file? via copy / paste into the nano editor on the pi or on windows via editor and ftp it over to the pi?
maybe something went wrong with the copy / paste. if using windows turn off the word wrap / line wrap and use the dos2unix command after you have saved and copied the file over to the pi to get clear line endings without spaces and hidden control characters.
if you don’t have dos2unix just get it with sudo apt-get install dos2unix and use it like that dos2unix filename that’s all

Hi,
which shell do you use? Bash? I found the following which may help you:

The standard construct to define a function is

run_backup () { … }
In ksh, bash and zsh, but not in other shells such as dash, you can define a function with

function run_backup { … }

Also it may help if you rund the script just with:

sudo ./nuki.sh (instead of using sh)

br
Mike

Note beyond, if a shell script is executed with the standard shell sh command, the dash shell will be used on a recent Ubuntu-/Debian-based system by default (dash = Debian Almquist Shell). https://en.wikipedia.org/wiki/Almquist_shell

crazy, when i use bash nuki.sh then it will work.
thankyou all for help me

This is not correct behavior of the system.
No matter which shell you are running (bash, dash, ksz, zsh, etc.) the shebang in the script determines the shell to use. That shebang (first line) clearly states #!/bin/bash.
The script must use the bash shell to execute.

@Harry-van-der-Wolf

That shebang (first line) clearly states … the script must use the bash shell to execute.

Not true! The shebang is only used if the shell script is executed!!! The other case is executing a shell to interpret the script - in this case the shebang is ignored.

pi@raspi3:~ $ ./test.sh
pi        4375  0.0  0.2   4612  2392 pts/0    S+   16:52   0:00 /bin/bash ./test.sh
pi        4377  0.0  0.1   4296  1816 pts/0    S+   16:52   0:00 grep test.sh
pi@raspi3:~ $ sh test.sh
pi        4380  0.0  0.0   1912   388 pts/0    S+   16:52   0:00 sh test.sh
pi        4382  0.0  0.2   4296  2008 pts/0    S+   16:52   0:00 grep test.sh

test.sh

#!/bin/bash
ps -u | grep "test.sh"

For portability reasons shell scripts should be written in a POSIX-compliant manner. Note, bash provides a --posix mode to enforce that. A checklist of POSIX mode limitations compared to normal bash mode can be found here: https://www.gnu.org/software/bash/manual/html_node/Bash-POSIX-Mode.html