htheatpump 1.0.0

Introduction

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.

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.

import logging
logging.basicConfig(level=logging.DEBUG)

Disclaimer

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.