Homebridge-web-door NPM

homebridge-web-door

This homebridge plugin exposes a web-based valve to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to open and close the door.

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

Key	Description	Default
`autoReset`	Whether obstruction detection should automatically change the state back to `0` after being triggered	`false`
`autoResetDelay`	Time (in seconds) until the obstruction detection will automatically reset (if enabled)	`5`

Key	Description	Default
`pollInterval`	Time (in seconds) between device polls	`300`
`timeout`	Time (in milliseconds) until the accessory will be marked as Not Responding if it is unreachable	`3000`
`port`	Port for your HTTP listener (only one listener per port)	`2000`
`http_method`	HTTP method used to communicate with the device	`GET`
`username`	Username if HTTP authentication is enabled	N/A
`password`	Password if HTTP authentication is enabled	N/A
`model`	Appears under the Model field for the accessory	plugin
`serial`	Appears under the Serial field for the accessory	apiroute
`manufacturer`	Appears under the Manufacturer field for the accessory	author
`firmware`	Appears under the Firmware field for the accessory	version

Your API should be able to:

{
    "positionState": INT_VALUE,
    "currentPosition": INT_VALUE,
    "targetPosition": INT_VALUE
}

/targetPosition?value=INT_VALUE_0_TO_100

/currentPosition?value=INT_VALUE_0_TO_100

/positionState?value=INT_VALUE_0_TO_2

Update targetPosition following a manual override by messaging the listen server:

/targetPosition?value=INT_VALUE_0_TO_100

Update obstructionDetected when an obstruction is detected by messaging the listen server (should notify 0 after obstruction moves unless autoReset is enabled):

/obstructionDetected?value=INT_VALUE_0_TO_1

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

6 years ago