Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python interface for waterfurnace geothermal systems

Project description

============
waterfurnace
============


.. image:: https://img.shields.io/pypi/v/waterfurnace.svg
:target: https://pypi.python.org/pypi/waterfurnace

.. image:: https://img.shields.io/travis/sdague/waterfurnace.svg
:target: https://travis-ci.org/sdague/waterfurnace

.. image:: https://readthedocs.org/projects/waterfurnace/badge/?version=latest
:target: https://waterfurnace.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. image:: https://pyup.io/repos/github/sdague/waterfurnace/shield.svg
:target: https://pyup.io/repos/github/sdague/waterfurnace/
:alt: Updates


Python interface for waterfurnace geothermal systems.

This provides basic sensor readings for waterfurnace geothermal systems by
using the websocket interface that exists for the symphony website. This is not
a documented or stable interface, so don't use this for critical
systems. However, it is useful to record historical usage of your waterfurnace
system.

Usage
=====

.. code-block:: python

from waterfurnace.waterfurnace import WaterFurnace
wf = WaterFurnace(user, pass)
wf.login()
data = wf.read()

The waterfurnace symphony service websocket monitors it's usage, so you need to
do a data reading at least every 30 seconds otherwise the websocket is closed
on the server side for resource constraints. The symphony website does a poll
on the websocket every 5 seconds.

Known Issues / limitations
==========================

* The python websocket code goes into a blocked state after long periods of
usage (always takes days to get to this state). I've yet to discover
why. Help welcome.
* If you have multiple waterfurnace units on one account, this will only use
the first.


License
=======

* Free software: Apache Software License 2.0
.. * Documentation: https://waterfurnace.readthedocs.io.


Credits
=======

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

1.1.0 (2019-01-07)
------------------
* Fix retry logic

1.0.0 (2018-12-05)
------------------
* Detect unit automatically
* Add series 7 sensors

0.7.0 (2018-07-13)
------------------

* Add workaround timer to handle socket failures

0.6.0 (2018-02-21)
------------------

* Add timeout on socket

0.5.0 (2018-02-16)
------------------

* Update exception handling to be more Home Assistant friendly

0.4.0 (2018-02-05)
------------------

* More exceptions to distinguish errors we are expecting

0.3.0 (2018-01-23)
------------------

* Handle tid rollover

0.2.0 (2018-01-19)
------------------

* Library specific exceptions for login failures.

0.1.0 (2018-01-17)
------------------

* First release on PyPI.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for waterfurnace, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size waterfurnace-1.1.0-py2.py3-none-any.whl (7.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size waterfurnace-1.1.0.tar.gz (17.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page