0.0.6 • Published 7 years ago
homebridge-http-garage-sensor v0.0.6
homebridge-http-garage-sensor
Description
This homebridge plugin exposes a web-based garage opener to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to open/close the garage.
Installation
- Install homebridge
- Install this plugin:
npm install -g homebridge-http-garage-sensor - Update your
config.json
Configuration
"accessories": [
{
"accessory": "GarageDoorOpener",
"name": "Garage",
"openURL": "http://myurl.com/open",
"closeURL": "http://myurl.com/close",
"sensorURL": "http://myurl.com/sensor"
}
]Core
| Key | Description | Default |
|---|---|---|
accessory | Must be GarageDoorOpener | N/A |
name | Name to appear in the Home app | N/A |
openURL | URL to trigger the opening of your garage | N/A |
closeURL | URL to trigger the closing of your garage | N/A |
sensorURL | URL to trigger the closing of your garage | N/A |
Optional fields
| Key | Description | Default |
|---|---|---|
openTime (optional) | Time (in seconds) to simulate your garage opening | 5 |
closeTime (optional) | Time (in seconds) to simulate your garage closing | 5 |
autoLock (optional) | Whether your garage should auto-close after being opened | false |
autoLockDelay (optional) | Time (in seconds) until your garage will automatically close (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 | homebridge-http-garage-sensor |
serial (optional) | Appears under the Serial field for the accessory | N/A |
manufacturer (optional) | Appears under the Manufacturer field for the accessory | N/A |