Git Product home page Git Product logo

node-red-contrib-nuki's Introduction

node-red-contrib-nuki

Greenkeeper badge

This node can control Nuki Smart Locks with the help of Nuki Bridges. Also Nuki Bridges can be handled by the node. It uses nuki-bridge-api based on the Nuki Bridge API documentation.

It enables you to connecto to your Nuki Smart Lock over a Nuki Bridge and control it directly from node-red. It also enables you to monitor the states and control the bridge itself.

Nodes

Bridge

Configure a Nuki Bridge connection used by other nodes

Control In

Send commands and queries to a Nuki Smart Lock. At the moment 2 actions are available which can be set as topic

lockStatus

query the lockStatus of the current lock. Possible states can be reviewd at state of nuki-bridge-api. Those are at the moment

UNCALIBRATED
LOCKED
UNLOCKING
UNLOCKED
LOCKING
UNLATCHED
UNLOCKED_LOCK_N_GO
UNLATCHING
MOTOR_BLOCKED
UNDEFINED

lockAction

Performs an action on the current lock. Actions are not validated within the node if they are valid - e.g. the lock is already unlocked and you send an unlock again. In this case the bridge itself manages this and does not try to unlock again. Available actions are directly mapped to the actions of nuki-bridge-api. At the moment those actions are:

UNLOCK
LOCK
UNLATCH
LOCK_N_GO
LOCK_N_GO_WITH_UNLATCH

Bridge Control

Send commands and queries to a Nuki Bridge.

The nuki bridge supports various commands. At the moment the responses are directly forwarded as output payload and are not parsed. They are only enriched with the original topic and bridge information ( host and port ).

reboot

Of course this action reboots the bridge itself

fwupdate

Update the firmware of the nuki bridge. It is not possible right now if there is an update available!

info

Retrieve information about the bridge. The payload looks like following example

{"topic":"info","bridge":"192.168.1.100:8080","payload":{"bridgeType":1,"ids":{"hardwareId":234189529,"serverId":291317518},"versions":{"firmwareVersion":"1.12.6","wifiFirmwareVersion":"1.2.0"},"uptime":75492,"currentTime":"2019-05-09T08:09:20+00:00","serverConnected":true,"scanResults":[]},"_msgid":"e3cab797.caec98"}

log

Retrieve the current log from the bridge. Right now only the last 100 lines are reported even the api is available to page through the available logs

clearlog

Clear all logs on the bridge

Todo

  • Support of callack provided by nuki-bridge-api to get events of Nuki Smart Lock actions
  • Paging of Nuki Bridge logs
  • Nuki Smart Lock Door sensor support ( missing in nuki-bridge-api )
  • More testing in the wild

Caveats

At the moment the door sensor is not support within nuki-bridge-api. I hope to get into this topic by the next time.

node-red-contrib-nuki's People

Contributors

mabunixda avatar phalynx avatar greenkeeper[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.