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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clage_homeserver-0.1.17.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.17.tar.gz
Algorithm Hash digest
SHA256 3979ec9b614cdf1978a2734921c848d7ed64ad72bd9b87654b46c73120c0d377
MD5 c85cf2179884a3dd71db0b8a33680591
BLAKE2b-256 4b45b7a137a2867e6944b1830222259fb0b80085c1bb6aa5168fbadb261bd69b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for clage_homeserver-0.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 5d70ce09634e4bf36dc680872288923c4108081adeee75a4a55e8a8eec665bac
MD5 71db37efb99143d547561cc80ce01383
BLAKE2b-256 a38951cb93ac58755db2d0e429e49edc9fae68d0f65e594b19b3d8c3e99e86b1

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