Skip to main content

A Python API for accessing and managing an electrical CLAGE continuous waterheater (e.g. DSX Touch) via the CLAGE Homeserver REST API

Project description

Python application PyPI

clage_homeserver (WIP)

Python client for accessing the Clage Waterheater via the local https-Rest-API-Endpoint of the clage Homeserver

Tested with the "Clage DSX Touch" with an integrated Homeserver.

Based on the API documentation version 1.3.4.

Warning: WIP - Breaking changes possible

This is the first version of the API so there are still breaking chnages possible eg. output parameter names or values.

Links

Project Homepage

PyPi Package

Openapi Document

Product Homepage

All rights of CLAGE GmbH remain unaffected.

Features

  • Query the status of the homeserver & water heater
  • Query the setup values of the homeserver & water heater
  • Query the consumption values for water (Liter) and energy (kWh)
  • Set the setpoint temperature for the heater

Install

pip install clage_homeserver

Example

from clage_homeserver import ClageHomeServer
clageHomeServer = ClageHomeServer('192.168.0.78','Your Homeserver ID','Your Heater ID') 
 
 # Request the status of the homeserver/heater
print (clageHomeServer.requestStatus())

 # Request the setup values of the homeserver/heater
print (clageHomeServer.requestSetup())

 # Request the consupmtion values of the homeserver/heater
print (clageHomeServer.GetConsumptionTotals())

# Set the temperature to 45.6 °C (setpoint)
clageHomeServer.setTemperature(45.6)

Project details


Download files

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

Source Distribution

clage_homeserver-0.1.15.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clage_homeserver-0.1.15-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file clage_homeserver-0.1.15.tar.gz.

File metadata

  • Download URL: clage_homeserver-0.1.15.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for clage_homeserver-0.1.15.tar.gz
Algorithm Hash digest
SHA256 73270e302dd0c713032fc43a083ee7ab76f3e188a3b560b524e68d5ca648ef3d
MD5 63bfe1919c5f880faa7023e191e6262b
BLAKE2b-256 845608dec6a07ca0e8dcafc9ed5bb5b5c01b9f7a99246960a184f20edf5e41f1

See more details on using hashes here.

File details

Details for the file clage_homeserver-0.1.15-py3-none-any.whl.

File metadata

File hashes

Hashes for clage_homeserver-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 276a6ef026985c60860a54adf53e00efed53a4374ae9b5b3a1691cbe44475585
MD5 a938fbcc2256cec0f7ebd32b2e34dc3b
BLAKE2b-256 8443687679dcd3db644f14fb5b07a1e09df930b395d60ce821756d06c9d92adb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page