Homebridge-http-door-ultimate NPM

homebridge-http-door-ultimate

Warning!

This plugin is still a work in progress and may not be fully functional, use at your own risk.

Description

This plugin is a fork of TheRealSimonMlr's homebridge-http-lock-ultimate.

This homebridge plugin exposes a web-based door device to Apple's HomeKit. Using simple HTTP requests with post, body and header support, the plugin allows you to open/close the device.

Installation

Install homebridge
Install this plugin: npm install -g homebridge-http-door-ultimate
Update your config.json file

Configuration examples

Configuration example for a device controlled via Get Requests in local network. Resets it's state to closed automatically after 60 Seconds

"accessories": [
     {
      "accessory": "HTTPDoorUltimate",
      "name": "Gate",
      "resetDoor": "true",
      "resetDoorTime": "60",
      "http_method": "GET",
      "openURL": "http://192.168.X.XX/open",
      "closeURL": "http://192.168.X.XX/close"
      }
]

Core

Key	Description	Default
`accessory`	Must be `HTTPDoorUltimate`	N/A
`name`	Name to appear in the Home app	N/A
`openURL`	URL to trigger open	N/A
`closeURL`	URL to trigger close	N/A

Optional fields

Key	Description	Default
`autoClose` (optional)	Whether your door should close after being opened (closeURL Request gets triggered)	`false`
`autoCloseDelay` (optional)	Time (in seconds) until your door will auto close if enabled	`60`
`resetDoor` (optional)	If your door is closing itself after opened, use this option to reset the state automatically (Will not call closeURL and is ignored when using autoClose)	`false`
`resetDoorTime` (optional)	Time (in seconds) until your door will be set to closed	`60`

Additional options

Key	Description	Default
`timeout` (optional)	Time (in seconds) until the accessory will be marked as Not Responding if it is unreachable	`5`
`http_method` (optional)	HTTP method used to communicate with the device	`GET`
`openHeader`	Request Header to send in open request	N/A
`openBody`	JSON Body to send on open	N/A
`closeHeader`	Request Header to send in close request	N/A
`closeBody`	JSON Body to send on close	N/A
`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

homebridge homebridge-plugin

2 years ago

2 years ago

2 years ago

2 years ago