Nuki Smart Lock 2.0 - support all available API actions (i.e. add lock/unlock)

alexdelprete · May 20, 2021, 11:20am

Thanks Joerg.

dvbit · May 20, 2021, 5:59pm

So I enabled advanced API in Nuki WEB
Webhook calls are being correctly fired but on the HA end I receive no feedback.
Also in the nuki web interface I see a 404 code
I feel we are vey near to get this working.
Need some help on HA side.
Currently I just setup the webhook in an automation that toggles a light without parsing anyway the content.
But as you see on nuki side I receive a 404

drimpart · May 21, 2021, 7:03am

Hey! I got the webhooks working, it works without problems and quite quick. Maybe you forgot to activate the webhook? But I still try to find out how to get the payload of the webhook, tried {{ trigger.data.body.feature }} or {{ trigger.json.body.feature }} without success:

Error executing script. Error for call_service at pos 1: Error rendering data template: UndefinedError: 'dict object' has no attribute 'body'

could anybody get that working?

Friedrieck · May 21, 2021, 10:27am

What do you get when trying with {{ trigger.json }}? It should give you the full payload.

drimpart · May 21, 2021, 11:05am

yes! found the error, its without. body:

{{ trigger.json.smartlockLog.action }}

Friedrieck · May 21, 2021, 11:07am

Strangely enough, the official integration does not seem to use the local callback proposed by the NUKI bridge API. So, for those not satisfied with pooling:

Create a long-term token on your profile page
Register a callback on your bridge by running:
curl -X GET -H "Content-Type: application/json" 'http://your_nuki_bridge_IP:8080/callback/add?token=your_NUKI_API_token&url=http://your_HA_IP:8123/api/webhook/your_long-term_webhook_id'.
You should get a {"success": true} in response.
Optionnally, you can check it is correctly registered by running:
curl -X GET -H "Content-Type: application/json" 'http://your_nuki_bridge_IP:8080/callback/list?token=your_NUKI_API_token'
Once the state of the door or of the lock changes, the bridge will now call your HA instance with a payload like this:
{'deviceType': 0, 'nukiId': your_lock_id, 'mode': 2, 'state': 3, 'stateName': 'unlocked', 'batteryCritical': False, 'batteryCharging': False, 'batteryChargeState': 44, 'keypadBatteryCritical': False, 'doorsensorState': 2, 'doorsensorStateName': 'door closed'}
Based on this, you can now create a new trigger-based template sensor. Here is mine (sorry for the French):


- trigger:
    - platform: webhook
      webhook_id: your_webhook_id
  binary_sensor:
    - unique_id: porte_principale
      device_class: door
      state: >
        {{ trigger.json.doorsensorState == 3 }}
      availability: "{{ (trigger.json.doorsensorState == 3) or (trigger.json.doorsensorState == 2) }}"
      icon: >
        {% if trigger.json.doorsensorState == 3 %}
          mdi:door-open
        {% elif (trigger.json.doorsensorState == 2) and (trigger.json.state == 1) %}
          mdi:door-closed-lock
        {% elif trigger.json.doorsensorState == 2 %}
          mdi:door-closed
        {% else %}
          mdi:door
        {% endif %}      
      attributes:
        friendly_name: "Porte principale"
        batteries: "{{ trigger.json.batteryChargeState }}%"
        Problème_keypad: "{{ trigger.json.keypadBatteryCritical == True  }}" # if you have a keypad, obviously.
        porte: >
          {% set my_state = {0: 'indisponible', 1: 'désactivée', 2: 'porte fermée', 3: 'porte ouverte', 4: 'inconnu', 5: 'calibration'} -%}
          {{ my_state[trigger.json.doorsensorState] }}
        serrure: >
          {% set my_state = {0: 'non calibrée', 1: 'verrouillée', 2:'déverrouillage', 3: 'déverrouillée', 4: 'verrouillage', 5: 'ouverte', 6: "déverrouillée (lock 'n' go)", 7: 'ouverture', 254: 'moteur bloqué', 255: 'indéfini'} -%}
          {{ my_state[trigger.json.state] }}        
        màj: "{{ strptime(as_timestamp(now()) | timestamp_local, '%Y-%m-%d %H:%M:00') }}"

I wanted to translate the lock and door states in French, you can just replace the FR terms with those in your language, but if you are happy with EN, then you can simply use the stateName and doorsensorStateName from the callback payload.
I am personnaly satisfied with the battery info in an attribute, but you can create sensors for this in the same template if you want (see the doc.)

dvbit · May 21, 2021, 9:08pm

Do tou mean the procedure described in the api docs requiring to call with clientid etc!

What kind of webhook have you setup? Central or decentral?

dvbit · May 21, 2021, 9:52pm

Great . I was missing the registration doh. Merci

Joerg · May 22, 2021, 5:31pm

I might have missed it yesterday, I get a battery error:

alexdelprete · May 23, 2021, 10:03pm

Good catch, there was an error when batteries where in charging state. Are you using the new rechargable pack by Nuki?

I released v2.0 of the Nuki Card, with many changes that need to be tested (callback/webhook, and more sensors), let me know if it works for you.

Joerg · May 24, 2021, 10:47am

Hi Allessandro,

nope, I use Energizer Litium batteries.

Just configured it, it looks good and most does work, except for the door status.

Callback is defined and there is no entry in the log.
The door sensor (last entry) from the integration is working.

alexdelprete · May 24, 2021, 12:49pm

Sorry Joerge, I should have specified in the instructions that the first time you restart, the sensor is not initialized, so you have to trigger it opening/closing the door, so you have the first callback. I updated the instructions with a quick note about it.

Regarding the recharging state of the batteries, I have code in place that changes the icon of the battery (strike symbol) if the batteryCharging flag reported by Nuki is true. I see your battery like this:

That means batteryCharging is true, and Nuki docs say this about it:

So when that flag is true, I use a battery icon with the strike symbol, otherwise, a plain battery icon with the charging level.

Let me know if the door sensor works when you open it the first time.

Joerg · May 24, 2021, 3:21pm

Guess its my fault. I assumed I had to open/close it at least once, but I had trouble in the beginning, because I registered two different callback and the second callback two times.
So while testing I opened/closed door severall times, but after figuring out how to remove all callbacks and after starting from scratch, I forgot to do so.
It shows the door status now, thank you.

Regarding the batteries: yes, the api told they were charging, but as said, this are normal, but high capacity and long lasting, non-rechargeable batteries. I have no experience with them in the lock, but in a Blink cam they last one year.

I understand that the battery pack is only charged, when it falls under 75%.
Anyway, I changed the battery recognition settings in the app to Off and On again and now the charging state is false and the icon normal.

All good so far. Thanks again for your effort.

mahikeulbody · May 24, 2021, 4:27pm

Hi,
Thank you for the nice work (and all others who worked on it).

All is running fine, including Battery Level, except door status. It is because I created a callback with a wrong IP, something as http://192.168.0.10:8123 when my HA server is reachable as https://ha.mydomain (redirected by my router to https//192.168.0.10:8123). If I try to create (re-create ?) a callback with this last https address, I get a “HTTP 400 Bad Request”. May be I have to delete (how ?) the existing callback ?

I tried to configure http://192.168.0.10:8123 as an internal URL in HA but I cannot reach my HA server this way.

alexdelprete · May 24, 2021, 4:35pm

First, list command to show what you’ve done on the bridge:

http://192.168.1.50:8080/callback/list?token=123456

Second, delete all entries (id=0, id=1, etc.) with command delete:

http://192.168.1.50:8080/callback/remove?id=0&token=123456

Then add the correct callback:

curl -X GET -H "Content-Type: application/json" 'http://your_nuki_bridge_IP:8080/callback/add?token=your_NUKI_API_token&url=http://your_HA_IP:8123/api/webhook/your_long-term_webhook_id'

alexdelprete · May 24, 2021, 4:38pm

Glad it’s working also for you, enjoy it.

Did you have the setting “rechargable” forced on? That would explain it. If I’m not mistaken, there’s an Auto setting, so the Nuki detects if the batteries are normal or rechargable.

Anyway, good that is working too. You’re all set now.

mahikeulbody · May 24, 2021, 4:50pm

Thank for the help !
The first command run fine and shows one entry (id=0) but something is wrong with the second command, I get “HTTP 401 Unauthorized”. By the way, this “%26” seems a little bit strange to me.

alexdelprete · May 24, 2021, 4:51pm

%26 means &

http://192.168.1.50:8080/callback/remove?id=0&token=123456

If you follow instructions of the original post, you can add the callback again.

alexdelprete · May 24, 2021, 4:57pm

The problem is that Nuki Bridge doesn’t support HTTPS, only HTTP. You need to use the INTERNAL IP on HTTP. If you hardened HA’s config to only accept HTTPS, you can’t use callbacks from Nuki Bridge. It only works on HTTP.

mahikeulbody · May 24, 2021, 5:03pm

If you hardened HA’s config to only accept HTTPS […]

I configured an internal URL (http://192.168.0.10:8123) via the UI but I cannot connect to my HA server this way. What I have to do to “dis-hardened” my config ?