Tool for logging stats from the Honeywell international.mytotalconnectcomfort.com site
Project description
Honeywell IMTCC Poller
Tool for polling heating data from Honeywell International My Total Connect Comfort, combining it with the outside temperature from the OpenWeather API and presenting them as Prometheus metrics.
Installation
This is not yet packaged. To run, you will need to clone the repo with git
and install the required prerequisites:
- Python 3.10.4 or above
- Poetry 1.2.0 or above
You can then run poetry install
to install the required python libraries.
Usage
Create environment variables containing your Honeywell login credetials:
$ export HONEYWELL_EMAIL_ADDRESS="foo@example.com"
$ export HONEYWELL_PASSWORD="ThisIsNotARealPassword"
Create environment variables containing your OpenWeather API key and co-ordinates for where you want the outside temperature to reflect:
$ export OPENWEATHER_API_KEY="foo-openweather-api-key"
$ export OPENWEATHER_LATITUDE="51.476852"
$ export OPENWEATHER_LONGITUDE="0.0005"
You can then run the tool via poetry:
$ poetry run poll-honeywell
Kitchen: 20.0
Harrys Room: 20.5
Lounge: 19.5
Main Bedroom: 19.5
Hot Water: 48.0
Outside: 16.36
The tool will authenticate with the Honeywell API using the login credentials supplied. It will make the calls every 60 seconds in order to get location and zone data.
The Prometheus metrics are made available for scraping on https://localhost:8000
while the tool is running.
Limitations
- Assumes you have zero or one hot water systems
- Limited error handling
Developing
Running tests:
$ make test
License
This project is licensed under the terms of the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file honeywell-imtcc-poller-0.5.0.tar.gz
.
File metadata
- Download URL: honeywell-imtcc-poller-0.5.0.tar.gz
- Upload date:
- Size: 5.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.4.0-113-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8125fd39d10eb5b845104c5fb62c86fb00e2f581d9f043f248f049709970710 |
|
MD5 | 54f088e92e73d359a15f856b1376034f |
|
BLAKE2b-256 | 31162d4f546a4f715bd63175475df2bdd2a9e495235e57979b668bdc6d47e94f |
File details
Details for the file honeywell_imtcc_poller-0.5.0-py3-none-any.whl
.
File metadata
- Download URL: honeywell_imtcc_poller-0.5.0-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.4.0-113-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 72bcb721139d5e6b826782ba5f4a3b1e6cad2f6384f95f3056899343d82ba051 |
|
MD5 | 37c7bd55c1a76405507f2a8a95863424 |
|
BLAKE2b-256 | 5f12bcc91bf6fa0620026aaed471eff279cb143a9ec623d38bf55dcae5027dea |