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
The CLI uses subcommands. Common options (-u, -p, -v, etc.) go after the
subcommand.
Reading sensor data
# One-shot sensor reading (password prompted if not provided)
waterfurnace read -u user@example.com -p password
# Read specific sensors
waterfurnace read -u user@example.com -p password -s enteringwatertemp,leavingairtemp
# Read all available sensors
waterfurnace read -u user@example.com -p password -s all
# Continuous monitoring (reads every 15 seconds)
waterfurnace read -u user@example.com -p password --continuous
Energy data
# Get hourly energy data for a date range
waterfurnace read -u user@example.com -p password --energy \
--start 2024-01-01 --end 2024-01-31
# Daily energy data in a specific timezone
waterfurnace read -u user@example.com -p password --energy \
--start 2024-01-01 --end 2024-01-31 --freq 1D --timezone America/Chicago
# 15-minute resolution energy data
waterfurnace read -u user@example.com -p password --energy \
--start 2024-01-01 --end 2024-01-07 --freq 15min
Controlling the thermostat
# Set thermostat mode (off, auto, cool, heat, eheat)
waterfurnace set-mode -u user@example.com -p password auto
# Set cooling setpoint (60-90F)
waterfurnace set-cooling-temp -u user@example.com -p password 74
# Set heating setpoint (40-80F)
waterfurnace set-heating-temp -u user@example.com -p password 68
Multi-device and vendor options
# GeoStar systems (--vendor accepts "waterfurnace" or "geostar")
waterfurnace read -u user@example.com -p password --vendor geostar
# Select a specific device in a multi-device system (0-indexed)
waterfurnace read -u user@example.com -p password -D 1
# Select a specific location in a multi-location system (0-indexed)
waterfurnace read -u user@example.com -p password -l 1
Environment variables
# Set credentials via environment variables to avoid repeating them
export WF_USERNAME=user@example.com
export WF_PASSWORD=your_password
waterfurnace read
waterfurnace set-mode auto
# Reuse an existing session ID
export WF_SESSIONID=your_session_id
Development
Setting Up Development Environment
# Clone the repository
git clone https://github.com/sdague/waterfurnace.git
cd waterfurnace
# Install all dependencies (creates .venv automatically)
uv sync --extra dev
# Run tests
uv run pytest
# Run tests with coverage
uv run pytest --cov=waterfurnace --cov-report=term-missing
# Format and lint code
uv run ruff format waterfurnace tests
uv run ruff check waterfurnace tests
Building and Publishing
# Build package
uv build
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
1 maintainer
Metadata
1 maintainer
Release files for waterfurnace 1.9.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| waterfurnace-1.9.0.tar.gz | 28.9 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| waterfurnace-1.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 43.6 kB
Release files / waterfurnace-1.9.0.tar.gz
| Download URL | waterfurnace-1.9.0.tar.gz |
|---|---|
| Size | 28.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ea44ba2e2dbf8a8419753dd5c1b62382cb1ac99b502fdccd53492fe29cb5100f
|
|
BLAKE2b-256 checksum How to use checksums |
49901defe259724cf3f826ce4a51bb706a1d1543dfb78137ff524f62ded093ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logRelease files / waterfurnace-1.9.0-py3-none-any.whl
| Download URL | waterfurnace-1.9.0-py3-none-any.whl |
|---|---|
| Size | 14.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8feab7780f01d8dffa63fc67120cd7dbd35418e8483f673b044891c4fe09e191
|
|
BLAKE2b-256 checksum How to use checksums |
3fb4a65a69a76a3360b6505e05930de2967c5dcd47f47db67d883a219bafab1d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logSecurity for waterfurnace 1.9.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for waterfurnace-1.9.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
