homebridge-web-thermostat v1.4.3

homebridge-web-thermostat

Description

This homebridge plugin exposes a web-based thermostat to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to set the thermostat mode and control the target temperature.

Installation

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

Configuration

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

Core

Optional fields

Additional options

API Interfacing

Your API should be able to:

1. Return JSON information when it receives /status:

{
    "targetHeatingCoolingState": INT_VALUE,
    "targetTemperature": FLOAT_VALUE,
    "currentHeatingCoolingState": INT_VALUE,
    "currentTemperature": FLOAT_VALUE
}

Note: You must also include the following fields in /status if enabled in the config.json:

• currentRelativeHumidity
• coolingThresholdTemperature & heatingThresholdTemperature

2. Set targetHeatingCoolingState when it receives:

/targetHeatingCoolingState?value=INT_VALUE

3. Set targetTemperature when it receives:

/targetTemperature?value=FLOAT_VALUE

4. (if enabled) Set coolingThresholdTemperature when it receives:

/coolingThresholdTemperature?value=FLOAT_VALUE

5. (if enabled) heatingThresholdTemperature when it receives:

/heatingThresholdTemperature?value=FLOAT_VALUE

Optional (if listener is enabled)

1. Update targetHeatingCoolingState following a manual override by messaging the listen server:

/targetHeatingCoolingState?value=INT_VALUE

2. Update targetTemperature following a manual override by messaging the listen server:

/targetTemperature?value=FLOAT_VALUE

3. (if enabled) Update coolingThresholdTemperature following a manual override by messaging the listen server:

/coolingThresholdTemperature?value=FLOAT_VALUE

4. (if enabled) Update heatingThresholdTemperature following a manual override by messaging the listen server:

/heatingThresholdTemperature?value=FLOAT_VALUE

HeatingCoolingState Key