homebridge-web-lock v1.1.9

homebridge-web-lock

Description

This homebridge plugin exposes a web-based lock to Apple's HomeKit. Using HTTP requests, you can open/close the lock and update the plugin with the lock's current state. The plugin achieves this by setting up a listen server which listens for changes in state from your device and then feeds them real-time into HomeKit.

Installation

1. Install homebridge
2. Install this plugin: npm install -g homebridge-web-lock
3. Update your config.json

Configuration

"accessories": [
     {
       "accessory": "HTTPLock",
       "name": "Lock",
       "apiroute": "http://myurl.com"
     }
]

Core

Optional fields

Additional options

API Interfacing

Your API should be able to:

1. Return JSON information when it receives /status:

{
    "lockCurrentState": INT_VALUE,
    "lockTargetState": INT_VALUE
}

2. Lock or unlock the lock when it receives:

/setLockTargetState?value=INT_VALUE

3. Update lockCurrentState when it locks or unlocks by messaging the listen server:

/lockCurrentState?value=INT_VALUE

4. Update lockTargetState following a manual override by messaging the listen server:

/lockTargetState?value=INT_VALUE

LockState Key