1.0.0 • Published 9 months ago

@shahvo/homebridge-garage-remote-http v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

homebridge-garage-remote-http

npm npm

This work is forked from https://github.com/SenorFernando/homebridge-garage-remote-http.

Fixed a bug, hard coded "GET", logging to DEBUG only and statusURL body

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

  1. Install homebridge
  2. Install this plugin: npm install -g homebridge-garage-remote-http
  3. Update your config.json

Configuration

"accessories": [
     {
       "accessory": "GarageDoorOpener",
       "name": "Garage",
       "openURL": "http://myurl.com/open",
       "closeURL": "http://myurl.com/close",
       "openTime": "30",
       "closeTime": "30",
       "autoLock": "true",
       "autoLockDelay": "30",
       "switchOff": "true",
       "switchOffDelay": "5"
     }
]

Core

KeyDescriptionDefault
accessoryMust be GarageDoorOpenerN/A
nameName to appear in the Home appN/A
openURLURL to trigger the opening of your garageN/A
closeURLURL to trigger the closing of your garageN/A

Optional fields

KeyDescriptionDefault
openTimeTime (in seconds) to simulate your garage opening10
closeTimeTime (in seconds) to simulate your garage closing10
autoLockWhether your garage should auto-close after being openedfalse
autoLockDelayTime (in seconds) until your garage will automatically close (if enabled)20
switchOffCloses the garage immediately without animation. For IR remote control use.false
switchOffDelayTime (in seconds) until your garage will automatically close without animation (if enabled)2
pollingWhether the state should be polled at intervalsfalse
pollIntervalTime (in seconds) between device polls (if polling is enabled)120
statusURLURL to retrieve state on poll (should return 0 or 1)N/A
statusURLBodyAdditional information to pass along with status URL queryN/A

Additional options

KeyDescriptionDefault
timeoutTime (in milliseconds) until the accessory will be marked as Not Responding if it is unreachable3000
http_methodHTTP method used to communicate with the deviceGET
usernameUsername if HTTP authentication is enabledN/A
passwordPassword if HTTP authentication is enabledN/A
modelAppears under the Model field for the accessoryplugin
serialAppears under the Serial field for the accessoryversion
manufacturerAppears under the Manufacturer field for the accessoryauthor
firmwareAppears under the Firmware field for the accessoryversion

State key

StateDescription
0Open
1Closed