Weheat backend client
This is a client for the Weheat backend. It is automatically generated from the OpenAPI specification.
Requirements.
Python 3.7+
Installation & Usage
You can install directly using:
pip install weheat
Then import the package:
import weheat
Getting Started
After installation, you can now use the client to interact with the Weheat backend. Note that all methods are async as of version 2025.1.15.
import asyncio
from keycloak import KeycloakOpenID # install with pip install python-keycloak
from weheat.abstractions.heat_pump import HeatPump
# connection information
auth_url = 'https://auth.weheat.nl/auth/'
api_url = 'https://api.weheat.nl/third_party'
realm_name = 'Weheat'
# client ID and secret provided by Weheat
client_id = ''
client_secret = ''
# username and password used for the online portal
username = ''
password = ''
# your heat pump UUID
my_heat_pump_id = ''
async def demo():
# login into keycloak and get an access token
keycloak_open_id = KeycloakOpenID(server_url=auth_url,
client_id=client_id,
realm_name=realm_name,
client_secret_key=client_secret)
token_response = keycloak_open_id.token(username, password)
# The access token is valid for its lifetime even after logging out
keycloak_open_id.logout(token_response['refresh_token'])
# construct the heat pump object and fetch its data
hp = HeatPump(api_url=api_url, uuid=my_heat_pump_id)
await hp.async_get_status(token_response['access_token'])
# Print some of the information, look in the files for all available properties
print(f'Heat pump status: {hp.heat_pump_state}')
print(f'Heat pump RPM: {hp.compressor_percentage}%')
print(f'Total produced central heating energy: {hp.energy_out_heating} kWh')
asyncio.run(demo())
Ports to other lanuages
- Golang by @joshp123
2 maintainers
Metadata
2 maintainers
Release files for weheat 2026.9.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| weheat-2026.9.3.tar.gz | 64.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| weheat-2026.9.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 143.4 kB
Release files / weheat-2026.9.3.tar.gz
| Download URL | weheat-2026.9.3.tar.gz |
|---|---|
| Size | 64.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
766668f51f04513c16aa509d33adf5182d4b08b96df12ac8c11b0e9fedd953c3
|
|
BLAKE2b-256 checksum How to use checksums |
1a4fbe1629ed6c87accb73e224c8afdc321d83a1cd971abca1278072c47e552b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
Release files / weheat-2026.9.3-py3-none-any.whl
| Download URL | weheat-2026.9.3-py3-none-any.whl |
|---|---|
| Size | 79.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8c9308b4d02557504dd5a95604d057d6f1ff57dad586847efabf363fcc7ed0ba
|
|
BLAKE2b-256 checksum How to use checksums |
6cef52b479c026cfb5fa1498af11244d6588a938b3273f09dfb85171e7992b63
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.16
|
