Warmup Homebridge Plugin

Introduction

Unofficial Homebridge plugin exposing Warmup smart thermostats to Apple's HomeKit. NB. Currently, only the 4iE is known to work. If you have another model, like perhaps the 6iE, please let me know.

Warmup Homebridge Plugin automatically discovers your Warmup thermostats.

• Using the plugin
  • Installation
• Temperature Control
• Mode Setting
• Developing
  • Clone and install dependencies
  • Testing
  • Building and publishing
  • Running Dockerised Homebridge for integration testing
• Credits

Using the plugin

You will need a MyWarmup account. All thermostats are retrieved from the my.warmup.com site, and are automatically created in the Home App.

You will also need a server running Homebridge.

Installation

Install the plugin by searching for "Warmup Homebridge Plugin" through the Homebridge Plugins UI or manually by:

sudo npm -g i homebridge-plugin-warmup

Use the plugin Config UI X to login to your account and all the thermostats you own will be added to Homebridge.

Temperature Control

Changes to the temperature create a temperature override for the current setting. Length of the override defaults to 60 Minutes ( or the duration setting).

Mode Setting

Any temperature change will cause a 60 minute override at that temperature. However, you can also adjust mode:

| Setting | Effect | | ------- | ------------------------------------------------------- | | Off | Turns off the thermostat | | Heat | Overrides the current target temperature for 60 minutes | | Auto | Resumes the current program's schedule and temperature |

Developing

Clone and install dependencies

git clone [email protected]:jondarrer/homebridge-plugin-warmup
cd homebridge-plugin-warmup
npm install

Testing

Run the tests with the usual command:

npm test

This will run the tests with a coverage report (requires 100% across the board to pass), which you can view with:

open coverage/lcov-report/index.html

Debug within VS Code by running the npm run local-homebridge task.

Building and publishing

npm run build
npm version patch -m "%s"
git push && git push --tags

Running Dockerised Homebridge for integration testing

NB. Requires docker-compose.

npm run containerised-homebridge

This will build the plugin and copy the necessary files to the appropriate places within container volume space (./volumes/homebridge). It will then start it, making it available at http://localhost:8581.

It is necessary to re-run this process on changes to the source code.

To stop the container, simply run docker-compose down.

Credits

Thanks to NorthernMan54 for his homebridge-warmup4ie plugin, which served as a basis for some of the logic in this one.

ASCII Art Archive was used to generate the ASCII art from Warmup's logo.