Homebridge-web-fan2-dti NPM

homebridge-web-fan

This homebridge plugin exposes a web-based valve to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to turn on/off the fan.

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

Key	Description	Default
`rotationSpeed`	Whether to expose rotation speed as a characteristic	`false`
`rotationDirection`	Whether to expose rotation direction as a characteristic	`false`

Key	Description	Default
`pollInterval`	Time (in seconds) between device polls	`300`
`listener`	Whether to start a listener to get real-time changes from the device	`false`
`timeout`	Time (in milliseconds) until the accessory will be marked as Not Responding if it is unreachable	`3000`
`port`	Port for your HTTP listener (if enabled)	`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:

{
    "currentState": INT_VALUE
}

/setState?value=INT_VALUE

/state?value=INT_VALUE

If rotationSpeed is enabled, update rotationSpeed following a manual override by messaging the listen server:

/rotationSpeed?value=INT_VALUE_0_TO_100

If rotationDirection is enabled, update rotationDirection following a manual override by messaging the listen server:

/rotationDirection?value=INT_VALUE_0_TO_1

4 years ago

4 years ago