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

Uploaded Python 3

File details

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

File metadata

  • Download URL: clage_homeserver-0.1.14.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.14.tar.gz
Algorithm Hash digest
SHA256 a560bb349de12e752a9152bdcd520203d0a1bd325ad9e7f8bf6ec59a1be83676
MD5 ba8081da0f9e99dce4d7fec1d873ee60
BLAKE2b-256 d3ec25ea6f95972af404c8dab9473d4f22a5a1aacf7ae951dca9cd9ce2ab84fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for clage_homeserver-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 85f371ffee73843a757f4b9aa781d7ef39e21a1d4c852065a5213ae0b36fe567
MD5 52a8b4708899b923867fa1bfbc7a5cd8
BLAKE2b-256 93f9c74a9014401af4d128e5e31893ba1912c6607a88bd322b0c4cfb86249379

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