Hier findest du Anleitungen, technische Informationen und Referenzen rund um Installation, Einrichtung, Geräteintegration, Automationen, Energiemanagement und Erweiterungen von homeESS.

Die Dokumentation richtet sich sowohl an Anwender, die homeESS einfach installieren und einrichten möchten, als auch an Entwickler, die eigene Adapter oder hDP-Geräte integrieren wollen.

Installation & erste Schritte

Der Einstieg in homeESS beginnt mit einer möglichst einfachen Installation auf einem geeigneten Debian-System.

In diesem Bereich findest du unter anderem:

• Systemvoraussetzungen
• Installation von homeESS
• erster Start
• Grundkonfiguration
• Benutzer und Zugänge
• erste Geräteintegration
• grundlegende Systemeinstellungen

→ Installationsanleitung (README_de.md)

Geräte & Adapter

homeESS bindet Geräte und externe Systeme über Adapter ein.

Die Dokumentation beschreibt die Einrichtung und Verwendung der mitgelieferten Integrationen sowie die allgemeinen Grundlagen der Adapterstruktur.

Dazu gehören unter anderem:

• MQTT
• Modbus
• Shelly
• Tasmota
• Homematic RPC
• weitere unterstützte Systeme

→ Geräte und Adapter

Automationen

Mit Automationen lassen sich States, Zeitpläne, Bedingungen und Aktionen miteinander verknüpfen.

Die Dokumentation erklärt unter anderem:

• Trigger
• Bedingungen
• State-Vergleiche
• Zeitpläne
• Aktionen
• Berechnungen
• Else-Zweige
• typische Automationsbeispiele

Energiemanagement

Das Energiemanagement verbindet aktuelle Messwerte mit Prognosen, Batteriespeicher, Verbrauchsmodellen und steuerbaren Verbrauchern.

Hier findest du Informationen zu:

• Photovoltaikanlagen
• PV-Ertragsprognosen
• Clear-Sky-Modell
• Hausakku
• Energieprognose
• Laststeuerung
• Verbraucherpriorisierung
• Wallboxen
• Energieautomationen

hDP – homeESS Device Protocol

Mit hDP können eigene Geräte direkt mit homeESS verbunden werden.

Die hDP-Dokumentation behandelt unter anderem:

• Geräteerkennung
• Pairing
• Geräteidentität
• Hardwarekonfiguration
• Runtime-Profile
• States
• WebSocket-Kommunikation
• OTA-Updates
• Firmwareinstallation

Für Entwickler steht zusätzlich die vollständige normative Protokollspezifikation zur Verfügung.

→ hDP-Dokumentation
→ hDP-Protokollspezifikation

Adapter entwickeln

Adapter laufen als eigenständige Anwendungen und kommunizieren über die dokumentierte Adapter-API mit homeESS.

Dieser Bereich richtet sich an Entwickler, die:

• neue Hersteller integrieren
• eigene Protokolle anbinden
• externe Dienste mit homeESS verbinden
• eigene Adapter veröffentlichen

möchten.

Neben der technischen API-Dokumentation gelten hierfür die jeweiligen Adapterrichtlinien.

→ Adapter-Richtlinien und API

Entwicklerdokumentation

Für Änderungen am homeESS-Kern stehen zusätzliche technische Dokumentationen zur Verfügung.

Dazu gehören unter anderem:

• Projektstruktur
• interne Schnittstellen
• Datenmodelle
• Entwicklungsumgebung
• Beitragsrichtlinien
• Quellcode und Versionshistorie

→ Entwicklerdokumentation
→ Beitragsrichtlinien

Fehlerbehebung

Wenn eine Installation, ein Adapter oder ein Gerät nicht wie erwartet funktioniert, helfen Hinweise zu typischen Fehlerquellen und Diagnosemöglichkeiten weiter.

Dazu gehören beispielsweise:

• Verbindungsprobleme
• Adapterfehler
• nicht erreichbare Geräte
• Updateprobleme
• Logausgaben
• bekannte Einschränkungen

→ Fehlerbehebung

Dokumentation direkt aus dem Projekt

Technische Dokumentationen werden soweit sinnvoll direkt aus den zum Projekt gehörenden Markdown-Dateien bereitgestellt.

Dadurch bleiben Dokumentation und tatsächlicher Entwicklungsstand möglichst nah beieinander und Änderungen können zusammen mit dem jeweiligen Quellcode gepflegt werden.

Noch etwas unklar?

Wenn eine Anleitung fehlt, unverständlich ist oder nicht mehr zum aktuellen Verhalten von homeESS passt, kannst du das über das Projekt melden.

Auch Verbesserungen an der Dokumentation sind ausdrücklich willkommen.

→ Bei homeESS mitmachen
→ GitHub & Quellcode