We’re working on a new version of the API specification. It adds one quite cool feature, that has been requested often: a lockActionEvent topic
The Nuki device publishes to this topic a comma separated list whenever a lock action is about to be executed, consisting of:
- LockAction
- Trigger
- Auth-ID
- Code-ID (Keypad) or 0 (if unknown)
- Auto-Unlock (0 or 1) or number of button presses (only button & fob actions) or keypad source (code, back key or fingerprint)
Only lock actions that are attempted to be executed are reported. E.g. unsuccessful keypad code entries or lock commands outside of a time window are not published.
Examples of what triggers that you can place on publishes from this topic:
- React when a specific user did lock/unlock
- React when a specific user comes home (i.e. auto-unlock was triggered)
- React when the house is left (i.e. Lock’n’go with the button was executed)
- Trigger something when the button on the Smart Lock was pressed (with or without lock action)
- Trigger something when a fob was pressed twice (with or without lock action)
- Trigger something when a specific keypad code was used
Here is the document as PDF:
20221027 MQTT API.pdf (102.7 KB)
Please have a look and let us know if you have any comments.