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

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.16.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.16-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clage_homeserver-0.1.16.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.16.tar.gz
Algorithm Hash digest
SHA256 1192f8c9aab4f736a70af82593d75be5cf5bb1b2e4dc6a3efccc89a7e88ad190
MD5 1993401fa70133458638768dc053e747
BLAKE2b-256 a9bf2ea1a34570515bb808cc66d7233a19bd3a8dcb519f084b5ad392f13af148

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for clage_homeserver-0.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 03247385e41a859e20860f5d511a8fc63d0043e255b04e54751d157980049324
MD5 39acb0b25da28c7b323739f55b1f7fb3
BLAKE2b-256 833da659e0f07c50fe66ed7ad18851f1a86ccf936814c841bcbf72e281ceb218

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