homebridge-web-boiler v1.6.3

homebridge-web-boiler

Description

This homebridge plugin exposes a web-based boiler to Apple's HomeKit. Using simple HTTP requests, the plugin allows you to control your central heating as well as your hot water (if enabled in the config.json).

See the examples folder for ready-to-use NodeMCU boiler control scripts, featuring both hysteresis and OpenTherm implementations. Hysteresis maintains the temperature within a set range, while OpenTherm controls temperature more precicely by modulating the boiler's output.

Installation

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

Configuration

"accessories": [
     {
       "accessory": "Boiler",
       "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 where relevant:

• currentRelativeHumidity (if currentRelativeHumidity is enabled)
• dhwTargetState (if dhw is enabled)
• dhwCurrentState (if dhw is enabled)
• dhwTargetTemperature (if dhw is enabled)
• dhwCurrentTemperature (if dhw is enabled)

2. Set targetHeatingCoolingState when it receives:

/targetHeatingCoolingState?value=INT_VALUE

3. Set targetTemperature when it receives:

/targetTemperature?value=FLOAT_VALUE

4. Set dhwTargetState when it receives: (if dhw is enabled)

/dhwTargetState?value=INT_VALUE

5. Set dhwTargetTemperature when it receives: (if dhw is enabled)

/dhwTargetTemperature?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. Update dhwTargetState following a manual override by messaging the listen server: (if dhw is enabled)

/dhwTargetState?value=INT_VALUE

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

/dhwTargetTemperature?value=FLOAT_VALUE