Skip to main content

Module to read from controme API Endpoint

Project description

Controme API Python Wrapper

Dieses Repository enthält einen Python-Wrapper für die Controme-API, der es ermöglicht, auf einfache Weise Abfragen und Befehle an die Controme-Smart-Home-Heizungssteuerung zu senden.

Features

  • Einfache Python-Schnittstelle für die Controme-API

  • Abfrage von Informationen wie Abweichungen, Fußbodenheizungsparametern (FPS) und Heizprogrammen

  • Einstellung von Sollwerten, Zielwerten, Temperaturszenen, Standarddauern, Raum- und Haus-Offsets

Installation

Um dieses Modul zu verwenden, installieren Sie es über pip

pip install controme

oder

python3 -m pip install controme

Beispiel

Ein Beispiel, wie Sie dieses Modul verwenden können:

from controme import ContromeAPI

base_url = "http://miniserver_ip"
haus_id = 1
user = "your.email@example.com"
password = "your-password"

api = ContromeAPI(base_url, haus_id, user, password)
deviation = api.get_deviation()
print(json.dumps(deviation, indent=2))

Bitte ersetzen Sie your.email@example.com und your-password durch Ihre eigenen Zugangsdaten.

Dokumentation

Die Klasse ContromeAPI stellt die folgenden Methoden zur Verfügung:

  • get_deviation(raum_id=None)
  • get_fps(raum_id=None)
  • get_heizprogramm()
  • set_soll(raum_id, soll)
  • set_ziel(raum_id, ziel, duration)
  • set_temperaturszenen(szene_id, duration=None)
  • set_default_duration(duration)
  • set_roomoffset(raum_id, offset, offset_name)
  • set_houseoffset(offset, offset_name)

Bitte beachten Sie die Dokumentation in der Klasse für weitere Informationen zu den einzelnen Methoden und ihren Parametern.

Lizenz

Dieses Projekt steht unter der MIT-Lizenz. Weitere Informationen finden Sie in der Datei LICENSE.

Haftungsausschluss

Bitte beachten Sie, dass dieses Projekt nicht von Controme oder einem ihrer Partner unterstützt oder offiziell unterstützt wird. Die Nutzung dieses Moduls erfolgt auf eigenes Risiko, und die Autoren übernehmen keine Verantwortung für mögliche Schäden oder Verluste im Zusammenhang mit der Nutzung dieses Codes.

Beitrag

Fühlen Sie sich frei, Pull-Requests zu erstellen oder Probleme zu melden, um dieses Projekt zu verbessern.

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

controme-0.1.2.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

controme-0.1.2-py3-none-any.whl (4.5 kB view hashes)

Uploaded Python 3

Supported by

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