Easy-to-use Python communication module for Heliotherm heat pumps
Project description
HtHeatpump
Easy-to-use Python communication module for Heliotherm heat pumps.
GitHub repo: https://github.com/dstrigl/htheatpump
Documentation: https://htheatpump.readthedocs.io
Free software: GNU General Public License v3
Introduction
This library provides a pure Python interface to access Heliotherm heat pumps over a serial connection. It’s compatible with Python version 3.5, 3.6 and 3.7.
Features
read the manufacturer’s serial number of the heat pump
read the software version of the heat pump
read and write the current date and time of the heat pump
read the fault list of the heat pump
query whether the heat pump is malfunctioning
query for several parameters of the heat pump
change parameter values of the heat pump
fast query of MP data points / parameters (“Web-Online”)
read and write the time programs of the heat pump
Tested with [*]
Heliotherm HP08S10W-WEB, SW 3.0.20
Heliotherm HP10S12W-WEB, SW 3.0.8
Heliotherm HP08E-K-BC, SW 3.0.7B
Heliotherm HP05S07W-WEB, SW 3.0.17 and SW 3.0.37
Heliotherm HP12L-M-BC, SW 3.0.21
Installing
You can install or upgrade htheatpump with:
$ pip install htheatpump --upgrade
Or you can install from source with:
$ git clone https://github.com/dstrigl/htheatpump.git
$ cd htheatpump
$ python setup.py install
Getting started
To use htheatpump in a project take a look on the following example. After establishing a connection with the Heliotherm heat pump one can interact with it by different functions like reading or writing parameters.
from htheatpump.htheatpump import HtHeatpump
hp = HtHeatpump("/dev/ttyUSB0", baudrate=9600)
try:
hp.open_connection()
hp.login()
# query for the outdoor temperature
temp = hp.get_param("Temp. Aussen")
print(temp)
# ...
finally:
hp.logout() # try to logout for an ordinary cancellation (if possible)
hp.close_connection()
A full list of supported functions can be found in the htheatpump documentation at readthedocs.io.
Logging
This library uses the logging module. To set up logging to standard output, put
import logging
logging.basicConfig(level=logging.DEBUG)
at the beginning of your script.
Disclaimer
Warning
Please note that any incorrect or careless usage of this module as well as errors in the implementation can damage your heat pump!
Therefore, the author does not provide any guarantee or warranty concerning to correctness, functionality or performance and does not accept any liability for damage caused by this module, examples or mentioned information.
Thus, use it on your own risk!
Contributing
Contributions are always welcome. Please review the contribution guidelines to get started. You can also help by reporting bugs.
Credits
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
History
1.2.0 (2019-06-10)
added support for Python’s “with” statement for the HtHeatpump class
added some more unit-tests (especially for the time program functions)
extended the sample scripts hthttp.py to query for time programs of the heat pump
added new sample samples/httimeprog.py to read the time programs of the heat pump
added new functions to write/change time program entries of the heat pump (see HtHeatpump.set_time_prog...)
added new functions to read the time program of the heat pump (see HtHeatpump.get_time_prog...)
added type annotations and hints for static type checking (using mypy)
splitted up property HtHeatpump.verify_param to HtHeatpump.verify_param_action and HtHeatpump.verify_param_error
renamed exception ParamVerificationException to VerificationException
added support for Python 3.7
dropped support for Python 3.4
added some more heat pump parameters (data points) in htparams.csv
1.1.0 (2019-02-23)
added some more heat pump parameters (data points) in htparams.csv
extended sample script htfaultlist.py by the possibility to write a JSON/CSV file
added new sample scripts hthttp.py and htfastquery.py
fixed some formatting (flake8) errors
some improvement for the reconnect in the login() method of class HtHeatpump
changed return type of HtHeatpump.get_fault_list() from dict to list
added support for Python 3.6
added support for a user specific parameter definition file under ~/.htheatpump/htparams.csv
extended sample htbackup.py to store also the limits (MIN and MAX) of each data point
added method to verify the parameter definitions in htparams.csv during a HtHeatpump.get_param(), HtHeatpump.set_param() or HtHeatpump.query(); this is just for safety to be sure that the parameter definitions in HtParams are correct (deactivated by default, but can be activated by setting the property HtHeatpump.verify_param to True)
added new method HtHeatpump.fast_query() to retrieve “MP” data point values in a faster way (“Web-Online”)
extended the HtHeatpump.login() method to perform an update of the parameter limits if desired
1.0.0 (2018-01-12)
First release on PyPI.
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.