homebridge-http-lock-plus

Description

This homebridge plugin exposes a web-based locking device to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to lock/unlock the device.

Installation

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

Configuration

"accessories": [
     {
       "accessory": "HTTPLock",
       "name": "Lock",
       "openURL": "http://myurl.com/open",
       "closeURL": "http://myurl.com/close"
     }
]

Core

| Key | Description | Default | | --- | --- | --- | | accessory | Must be HTTPLock | N/A | | name | Name to appear in the Home app | N/A | | openURL | URL to trigger unlock | N/A | | closeURL | URL to trigger lock | N/A |

Optional fields

| Key | Description | Default | | --- | --- | --- | | autoLock (optional) | Whether your lock should re-lock after being opened | false | | autoLockDelay (optional) | Time (in seconds) until your lock will auto lock if enabled | 10 |

Additional options

| Key | Description | Default | | --- | --- | --- | | timeout (optional) | Time (in milliseconds) until the accessory will be marked as Not Responding if it is unreachable | 3000 | | http_method (optional) | HTTP method used to communicate with the device | GET | | username (optional) | Username if HTTP authentication is enabled | N/A | | password (optional) | Password if HTTP authentication is enabled | N/A | | model (optional) | Appears under the Model field for the accessory | plugin | | serial (optional) | Appears under the Serial field for the accessory | version | | manufacturer (optional) | Appears under the Manufacturer field for the accessory | author | | firmware (optional) | Appears under the Firmware field for the accessory | version |