Skip to main content

Introduction

This is a library for communicating with a wifi-enabled home thermostat made by Warmup. At the time of writing, this only includes the warmup 4IE.

This code is inspired by a project for SmartThingsHub, see here. Many Thanks to alyc100 for the great work!

Warmup Plc was not involved in the creation of this software and has not sanctioned or endorsed it in any way.

License

This software is available under Apache license. Please see LICENSE.txt.

Usage

The library is primary intended to interface the 4IE with home assistant, but may also be used standalone.

Home Assistant

To setup this component, you need to register to warmup first. see https://my.warmup.com/login

Then copy the folder warmup_cc to your “custom_components” folder in your “config” dir.

Then add to your configuration.yaml:

climate:
  - platform: warmup_cc
    name: YOUR_DESCRIPTION
    username: YOUR_E_MAIL_ADDRESS
    password: YOUR_PASSWORD
    location: YOUR_LOCATION_NAME
    room: YOUR_ROOM_NAME
  • name (optional): the description of the device, as seen by the user in the front end

  • 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

  • location (required): the location name used in the warmup web site

  • room (required): the room name of the device used in the warmup web site

After restarting home assistant, the component will be loaded automatically.

Standalone

You may install the library via pip using

>>> pip install warmup4ie

After that, import the library, and away we go.

>>> import warmup4ie
>>> device = warmup4ie.Warmup4IEDevice('<e-mail>', '<password>',
'<location>', '<room>', <inital target temp>)
>>> device.get_current_temmperature()
{'raw': 21.0}

Device Versions

Supported models:

  • 4IE

Since I only have access to the 4IE, that is the model that the development has occured with.

Supported Features

At the moment the library supports reading current temperature and setting the target temperature, switching between manual, automatic and frost protection mode, and switching the device off.

Release Notes

0.1.0

  • inital release

0.1.1

  • bug fixes

0.1.2

  • bug fixes

0.1.3

  • changed http-request to use the new api.

  • adapted file names to comply with the new naming structure of HA introduced with 0.92

0.1.4

  • added functionality to allow configuration of Warmup4IE thermostat via HA UI Config entry.

0.1.5

  • added getter methods for location, location id, room name, room id and serial number

Metadata

Release files for warmup4ie 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for warmup4ie 0.1.5
File Size Uploaded Provenance Actions
warmup4ie-0.1.5.tar.gz 5.9 kB Without provenance Details for warmup4ie-0.1.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for warmup4ie 0.1.5
File Interpreter ABI Platform Actions
warmup4ie-0.1.5-py3-none-any.whl Python 3 none any Details for warmup4ie-0.1.5-py3-none-any.whl

Total release size: 16.3 kB

Release files / warmup4ie-0.1.5.tar.gz

Download URL warmup4ie-0.1.5.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
f12656223ef05722280550a1929c89c34e24664f89e0227001feb5888316d2ab
BLAKE2b-256 checksum
How to use checksums
abf84f1c0ed388a4853495d17f68a84cafa882008edcf3b0d32debeee6dc41ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/33.1.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.5.3

Release files / warmup4ie-0.1.5-py3-none-any.whl

Download URL warmup4ie-0.1.5-py3-none-any.whl
Size 10.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
325035fddfb9e7b448818a2d582222290bc0304dcb7d9a4eacc6e89acd8c720d
BLAKE2b-256 checksum
How to use checksums
257f2e5555d4a468b4b8786c3e78b3dc72bb3b1ea0dda6eb2a3bffb6053ea0bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/33.1.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.5.3

Security for warmup4ie 0.1.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page