Skip to content

Latest commit

 

History

History
80 lines (61 loc) · 2.63 KB

README.md

File metadata and controls

80 lines (61 loc) · 2.63 KB
Raw

homebridge-web-switch

npm npm

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 switch.

Find script samples for the switch controller in the examples folder.

Installation

  1. Install homebridge
  2. Install this plugin: npm install -g homebridge-web-switch
  3. Update your config.json file

Configuration

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

Core

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

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:

  1. Return JSON information when it receives /status:
{
    "currentState": INT_VALUE
}
  1. Set the state when it receives:
/setState?value=INT_VALUE

Optional (if listener is enabled)

  1. Update state following a manual override by messaging the listen server:
/state?value=INT_VALUE