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.12.tar.gz (10.9 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.12-py3-none-any.whl (11.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: clage_homeserver-0.1.12.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for clage_homeserver-0.1.12.tar.gz
Algorithm Hash digest
SHA256 a06aa7711c188c6449b51420058e362545e1b2ced26d91f7a47f7b1f7bdd6743
MD5 ec334f4bbbc6f94905959d76c56fb961
BLAKE2b-256 21ff55b837144167299a94f14175ba7af9a54693a53165f21cca909a33d3ef62

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for clage_homeserver-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 4881f6cd99e192be9b9e7026ca721d2f6c20aa38960fa0702c7abba5a68e47ce
MD5 ead21577e07ef7874392f19808af1d57
BLAKE2b-256 77e898bdbf0d46692993699dd2aa210ae760d3255b0d03d51d795fa341814742

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