homeESS ist ein offenes Projekt und lebt von Rückmeldungen, Tests und Beiträgen aus der Praxis.

Mitmachen kann dabei viele Formen haben: Fehler melden, Funktionen vorschlagen, Adapter entwickeln, Dokumentation verbessern, Übersetzungen ergänzen oder direkt Code beitragen.

Fehler melden

Fehler können über die GitHub-Issues des Projekts gemeldet werden.

Hilfreich sind insbesondere:

• verwendete homeESS-Version
• betroffener Adapter oder Funktionsbereich
• genaue Beschreibung des Problems
• Schritte zur Reproduktion
• relevante Fehlermeldungen oder Logausgaben
• erwartetes Verhalten
• tatsächlich beobachtetes Verhalten

Je genauer ein Fehler beschrieben ist, desto leichter lässt sich seine Ursache nachvollziehen.

→ Fehler auf GitHub melden

Ideen und Verbesserungsvorschläge

Neue Funktionen entstehen häufig aus konkreten Anforderungen realer Installationen.

Ein guter Vorschlag beschreibt deshalb nicht nur eine gewünschte Funktion, sondern möglichst auch das zugrunde liegende Problem.

Hilfreich sind beispielsweise:

• aktueller Ablauf
• gewünschtes Verhalten
• konkreter Anwendungsfall
• bestehende Einschränkung
• mögliche Auswirkungen auf andere Funktionen

Adapter entwickeln

homeESS besitzt eine offene Adapterarchitektur.

Damit können weitere Hersteller, Geräteplattformen und Protokolle integriert werden, ohne den Kern von homeESS für jede Integration verändern zu müssen.

Interessant sind beispielsweise Adapter für:

• Smarthome-Hersteller
• Wechselrichter
• Batteriespeicher
• Stromzähler
• Wallboxen
• Heizungs- und Klimasysteme
• lokale APIs
• weitere Kommunikationsprotokolle

Neue Adapter sollten sich an die bestehende Adapter-API und die Beitragsrichtlinien des Projekts halten.

→ Beitragsrichtlinien lesen

Code beitragen

Änderungen am Kernsystem können über Pull Requests eingereicht werden.

Dazu gehören beispielsweise:

• Fehlerbehebungen
• neue Funktionen
• Optimierungen
• Verbesserungen der Benutzeroberfläche
• Erweiterungen vorhandener Module
• Tests

Vor größeren Änderungen sollte das Vorhaben möglichst zunächst über ein Issue abgestimmt werden.

So lässt sich vermeiden, dass parallel an unterschiedlichen Lösungen gearbeitet wird oder eine Änderung nicht zur bestehenden Architektur passt.

→ Quellcode auf GitHub ansehen
→ CONTRIBUTING.md lesen

homeESS unter realen Bedingungen testen

Tests in echten Installationen sind besonders wertvoll.

Dabei zeigen sich Probleme, die in kleinen Testsystemen oft nicht auftreten.

Interessant sind beispielsweise Erfahrungen mit:

• vielen Geräten und States
• mehreren Adaptern gleichzeitig
• umfangreichen Automationen
• Photovoltaikanlagen
• Batteriespeichern
• Wallboxen
• längeren Laufzeiten
• mobilen Endgeräten
• Netzwerkunterbrechungen
• Geräteausfällen

Auffälligkeiten können anschließend als Issue dokumentiert werden.

hDP testen und eigene Geräte bauen

Auch hDP – das homeESS Device Protocol kann aktiv getestet werden.

Eigene Geräte lassen sich beispielsweise mit:

• Sensoren
• digitalen Ein- und Ausgängen
• Relais
• Schaltern und Tastern
• ARGB-Anzeigen

aufbauen und mit homeESS verbinden.

Besonders hilfreich sind Tests rund um:

• Pairing
• erneute Kopplung
• Hardwarekonfiguration
• Netzwerkunterbrechungen
• OTA-Updates
• unterschiedliche Geräteprofile

→ hDP-Geräte selbst bauen
→ hDP-Dokumentation ansehen

Dokumentation verbessern

Auch die Dokumentation wird laufend weiterentwickelt.

Verbesserungen sind insbesondere dann sinnvoll, wenn:

• ein Schritt unklar beschrieben ist
• Informationen fehlen
• Beispiele nicht mehr aktuell sind
• technische Begriffe missverständlich verwendet werden
• ein Ablauf einfacher erklärt werden kann

Änderungen können über GitHub vorgeschlagen oder direkt eingereicht werden.

Übersetzungen beitragen

homeESS ist auf eine mehrsprachige Oberfläche ausgelegt.

Unterstützung ist beispielsweise möglich bei:

• fehlenden Übersetzungen
• unnatürlichen Formulierungen
• inkonsistenten Fachbegriffen
• neuen Sprachversionen

Erfahrungen aus realen Installationen teilen

Viele sinnvolle Erweiterungen entstehen erst durch reale Anwendungsfälle.

Interessant sind beispielsweise Fragen wie:

• Welche Geräte oder Hersteller fehlen?
• Welche Automationen lassen sich noch nicht sinnvoll umsetzen?
• Wo entstehen unnötige Arbeitsschritte?
• Welche Daten fehlen für eine bestimmte Energieentscheidung?
• Welche Funktionen verhalten sich in der Praxis anders als erwartet?

Solche Rückmeldungen helfen dabei, die weitere Entwicklung an tatsächlichen Anforderungen auszurichten.

Was zu homeESS passt

homeESS soll leistungsfähig bleiben, ohne zu einer Sammlung unverbundener Sonderlösungen zu werden.

Neue Beiträge sollten deshalb möglichst:

• einen nachvollziehbaren Anwendungsfall lösen
• auch für andere Nutzer sinnvoll sein
• zur bestehenden Architektur passen
• langfristig wartbar bleiben
• vorhandene Funktionen nicht unnötig duplizieren

Herstellerspezifische Integrationen gehören in der Regel in Adapter. Allgemein nutzbare Funktionen können dagegen Bestandteil des Kerns oder eines Moduls werden.

GitHub als zentrale Entwicklungsplattform

Die technische Entwicklung von homeESS findet auf GitHub statt.

Dort befinden sich:

• Quellcode
• Issues
• Pull Requests
• Beitragsrichtlinien
• Versionshistorie
• technische Diskussionen

→ homeESS auf GitHub
→ Beitragsrichtlinien lesen