waterfurnace 1.6.3

Python interface for waterfurnace geothermal systems

waterfurnace

Python interface for WaterFurnace and GeoStar 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.

Installation

pip install waterfurnace

Quick Start

   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.

The software now supports a CLI. For details, use waterfurnace --help

CLI Usage

# Basic usage
waterfurnace -u [e-mail] -p password

# Continuous monitoring (reads every 15 seconds)
waterfurnace -u [e-mail] -p password --continuous

# Get energy data
waterfurnace -u [e-mail] -p password --energy \
  --start 2024-01-01 --end 2024-01-31 --freq 1H

# Use environment variable for password
export WF_PASSWORD=your_password
waterfurnace -u [e-mail]

# GeoStar systems
waterfurnace -u [e-mail] -p password --vendor geostar

Development

Setting Up Development Environment

# Clone the repository
git clone https://github.com/sdague/waterfurnace.git
cd waterfurnace

# Install in development mode with all dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=waterfurnace --cov-report=term-missing

# Format code
black waterfurnace tests

# Run all tests across Python versions
tox

Building and Publishing

# Build package
python -m build

# Check package
twine check dist/*

Known Issues / Limitations

• The python websocket code goes into a blocked state after long periods of usage (always takes at least days if not weeks or months to get to this state). I've yet to discover why. Help welcome.

License

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