Easy-to-use Python communication module for Heliotherm heat pumps
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
This library provides a pure Python interface to access Heliotherm heat pumps over a serial connection. It’s compatible with Python version 3.4 and 3.5.
- 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
- check access right for writing parameters of the heat pump
- check passed values for writing parameters against the defined limits
- read and write the time programs of the heat pump
- add some (more) examples
- add some (more) unit tests
- cleanup/extend documentation
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
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.
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.
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!
- First release on PyPI.