homebridge-web-fan's Introduction

homebridge-web-fan

Description

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.

Installation

Install homebridge
Install this plugin: npm install -g homebridge-web-fan
Update your config.json file

Configuration

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

Core

Key	Description	Default
`accessory`	Must be `WebFan`	N/A
`name`	Name to appear in the Home app	N/A
`apiroute`	Root URL of your device	N/A

Optional fields

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

Additional options

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

API Interfacing

Your API should be able to:

Return JSON information when it receives /status:

{
    "currentState": INT_VALUE
}

Set the state when it receives:

/setState?value=INT_VALUE

Optional (if listener is enabled)

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

/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

homebridge-web-fan's People

Contributors

Stargazers

Watchers

homebridge-web-fan's Issues

Basic fan control

Is there a way to have rotation as an on/off, not rotation. And, is there a way to have fan speed as set speeds (i.e. 0, 1, 2, 3) as my fan only has 3 speeds (a bit like thermostats, below)

Thanks in advance!

rotationSpeed is 0 on service restart

Hey!
Thanks for sharing this great plugin. I noticed that when rotationSpeed is set to true homekit show 0% on first boot of accessory, e.g. after power loss. I'm using it for my ventilation system and after power loss it recovers to the previous rotation speed so I think this plugin could consume that value to show it correctly in homekit - what do you think?

{
    "currentState": INT_VALUE,
    "rotationSpeed": INT_VALUE     <--- to add
}

Recommend Projects

phenotypic / homebridge-web-fan Goto Github PK