This software is a Custom Component to integrate Warmup devices into Home Assistant.
Warmup manufacture underfloor heating and control systems and their wifi-enabled home thermostat, warmup 4IE, has an API. This software enables communication via this API, and allows Home Assistant to read and control the device (currently just this one model).
For instructions on how to install this component please keep reading below.
There is more detailed documentation on the API and the information returned from the device on the documentation wiki. If you have issues using this software then please check our Issue list and if someone else has not already, then do raise a new issue. If you wish you become more involved with the project then please see our guide to contributing.
This code is derived from some great work by @alex0103 to create a Home Assistant Custom Component and Python Package. This has been improved by a number of coders, notably @foxy82 and the code was origianlly inspired by @alyc100's project for SmartThingsHub here. Many Thanks to all the contributors who helped us get here.!
Warmup Plc was not involved in the creation of this software and has not sanctioned or endorsed it in any way. 4IE is a registered trademark of Warmup Plc.
This software is published under Apache 2.0 license. Please see LICENSE.md.
The library is primary intended to interface the 4IE with home assistant, but may also be used standalone.
This is a Custom Component for manual inclusion in a Home Assistant Core installation (manual using Python virtual environment). Note that it is not a Custom repository for Home Assistant Operating System (HAOS) or Home Assistant Container deployments.
To setup this component, you need to register to warmup first. see https://my.warmup.com/login
Then copy the contents of the warmup subfolder into
custom_components in your HA config folder, e.g.:
cd path/to/your/config
git clone https://github.com/ha-warmup/warmup.git /tmp/warmup
# remove any previous version
rm -r ./custom_components/warmup 2>/dev/null
mkdir -p ./custom_components/warmup
cp -r /tmp/warmup/warmup/* ./custom_components/warmup
# clean up
rm -rf /tmp/warmup/NB: the component folder has been renamed from warmup_cc to simply warmup, in line with recommendations from the HA
project.
Note that once you have successfully deployed the custom component and restarted you Home Assistant, you should see the following warning in the logs:
WARNING [homeassistant.loader]
We found a custom integration warmup which has not been tested by Home Assistant.
This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant
This is a positive sign, as it means the custom component has been successfully loaded. Great! - now carry on.
Then add to your configuration.yaml:
climate:
- platform: warmup
username: YOUR_E_MAIL_ADDRESS
password: YOUR_PASSWORD- username (required): the username used to login to the warmup web site
- password (required): the password used to login to the warmup web site; may be moved to the secrets.yaml file. See secrets
After restarting home assistant, the component will be loaded automatically.
Our wiki has some ideas on how to configure warmup devices in your Home Assistant instance.
You may install the library via pip using
>>> pip install warmup4ieAfter that, import the library, and away we go.
>>> import warmup4ie
>>> warmup = warmup = warmup4ie.Warmup4IE('<e-mail>', '<password>',
>>> warmup.get_all_devices()
>>> device = warmup.get_device_by_name(\"Underfloor\")
>>> device.get_current_temperature()Supported models:
- 4IE
This is currently the only model that developers and testers have available to work on.
At the moment the library supports reading current temperature, target temperature plus other values from the thermostat and setting the target temperature, switching between manual, automatic and frost protection mode, switching the device off. and setting a temporary override.
For further information on versions please see the CHANGELOG