emerald_hws_py
Python package for controlling Emerald Heat Pump Hot Water Systems
Overview
This package provides an interface to control and monitor Emerald Heat Pump Hot Water Systems through their API and MQTT service.
Installation
pip install emerald_hws
Usage
from emerald_hws.emeraldhws import EmeraldHWS
# Basic usage with default connection settings
client = EmeraldHWS("your_email@example.com", "your_password")
client.connect()
# List all hot water systems
hws_list = client.listHWS()
print(f"Found {len(hws_list)} hot water systems")
# Get status of first HWS
hws_id = hws_list[0]
status = client.getFullStatus(hws_id)
print(f"Current temperature: {status['last_state'].get('temp_current')}")
# Turn on the hot water system
client.turnOn(hws_id)
Configuration Options
Connection Timeout
The module will automatically reconnect to the MQTT service periodically to prevent stale connections. You can configure this timeout:
# Set connection timeout to 6 hours (360 minutes)
client = EmeraldHWS("your_email@example.com", "your_password", connection_timeout_minutes=360)
Health Check
The module can proactively check for message activity and reconnect if no messages have been received for a specified period:
# Set health check to check every 30 minutes
client = EmeraldHWS("your_email@example.com", "your_password", health_check_minutes=30)
# Disable health check
client = EmeraldHWS("your_email@example.com", "your_password", health_check_minutes=0)
Callback for Updates
You can register a callback function to be notified when the state of any hot water system changes:
def my_callback():
print("Hot water system state updated!")
client = EmeraldHWS("your_email@example.com", "your_password", update_callback=my_callback)
1 maintainer
Metadata
1 maintainer
Release files for emerald-hws 0.1.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 | |
|---|---|---|---|
| emerald_hws-0.1.0.tar.gz | 56.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| emerald_hws-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 77.3 kB
Release files / emerald_hws-0.1.0.tar.gz
| Download URL | emerald_hws-0.1.0.tar.gz |
|---|---|
| Size | 56.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8701f5e6df1392608dcc5a7f6563f16a3df1b8babc74d36932cc7327b4e5784d
|
|
BLAKE2b-256 checksum How to use checksums |
7187bb852aef3eb25aeb60b20d22914559f817f3be7bfb19f22a08e7c031637b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.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 17, 2026.
Transparency logRelease files / emerald_hws-0.1.0-py3-none-any.whl
| Download URL | emerald_hws-0.1.0-py3-none-any.whl |
|---|---|
| Size | 20.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5476eb13587bca058a6258dfc05de664a67013658924d09edaf80fc246fbbdb0
|
|
BLAKE2b-256 checksum How to use checksums |
1bbb55e1a2911ae12f8711fca578413e5672e37d60fe95c9738eeb605d305ee1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.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 17, 2026.
Transparency log
