So entwickelst du dein eigenes Plugin für die Homematic IP HCU-1 [Teil 4: Plugin veröffentlichen und langfristig pflegen]
In den ersten drei Teilen hast du dein Plugin-Projekt eingerichtet, die Grundlagen für die Entwicklung geschaffen und schließlich dein erstes Plugin geschrieben, getestet und exportiert. Aber wie können jetzt auch andere Nutzer dein Plugin verwenden und was musst du bei der Pflege beachten?
Jetzt solltest du dein Plugin für andere Nutzer vorbereiten, sauber dokumentieren und anschließend im HCU Plugins Community Store veröffentlichen.
In diesem letzten Teil geht es deshalb um die Schritte, die aus deinem funktionierenden Plugin ein gutes Community-Plugin machen.
Plugin vor der Veröffentlichung prüfen
Bevor du dein Plugin veröffentlichst, solltest du eine letzte Prüfung im Feldtest durchführen. Teste nicht nur, ob das Plugin grundsätzlich startet (das sollte die Grundvoraussetzung sein), sondern auch typische Alltagssituationen.
Teste insbesondere:
- Startet das Plugin nach einem Neustart der HCU-1 korrekt?
- Funktionieren alle wichtigen Funktionen?
- Werden Einstellungen korrekt übernommen (häufig sind auch Umlaute und Sonderzeichen ein Problem)?
- Was passiert, wenn die Verbindung zu einem externen Dienst kurzzeitig nicht verfügbar ist?
- Werden Fehler sinnvoll protokolliert?
- Bleiben gespeicherte Einstellungen und Daten nach einem Neustart der HCU-1 oder einem Update des Plugins erhalten?
- Werden sinnfreie Eingaben von Nutzern korrekt gefiltert und abgefangen?
Gerade Fehler bei Verbindungen oder Neustarts fallen häufig erst im normalen Betrieb auf. Aus diesem Grund kann es sinnvoll sein, dein Plugin nicht direkt nach Fertigstellung zu veröffentlichen, sondern erst einmal einige Tage bis Wochen selbst zu testen.
Fehlerbehandlung einbauen
Ein Plugin sollte nicht davon ausgehen, dass Netzwerkverbindungen oder externe Dienste jederzeit erreichbar sind.
Kann beispielsweise eine API nicht erreicht werden, sollte dein Plugin nicht einfach beendet werden oder sich Daten “ausdenken”. Sinnvoller ist es, den Fehler zu protokollieren und später erneut zu versuchen, die Verbindung herzustellen (Wichtig! Mit Timeouts).
Für wiederkehrende Verbindungsprobleme bietet sich beispielsweise ein Exponential Backoff an. Dabei werden die Abstände zwischen den erneuten Verbindungsversuchen schrittweise erhöht. Das spart auf lange Sicht Leistung ein (jeder Aufruf blockiert an der HCU-1 Ressourcen) und sorgt für eine zuverlässigere Neuverbindung, sobald die Gegenstelle wieder erreichbar ist.
Denk bitte immer daran, dass dein Plugin vermutlich nicht das einzige auf der HCU-1 des Nutzers sein wird. Also versuch durch clevere Fehlerbehandlung nicht unnötig viele Ressourcen zu blockieren. Ansonsten wird der Nutzer bald Leistungsprobleme bekommen.
Logging sinnvoll einsetzen
Logs sind während der Entwicklung unverzichtbar und auch im späteren Betrieb hilfreich.
Schreibe wichtige Ereignisse in die Logs, beispielsweise:
- erfolgreicher Verbindungsaufbau
- erkannte Geräte
- gestartete Synchronisationen
- Fehler bei API-Anfragen
- fehlgeschlagene Verbindungen
- Änderungen wichtiger Einstellungen
Vermeide allerdings unnötig umfangreiche Log-Ausgaben.
Noch wichtiger: Keine Zugangsdaten, Auth-Tokens oder andere vertrauliche Informationen in die Logs schreiben.
So kannst du Fehler später nachvollziehen, ohne sensible Daten preiszugeben. Hat einer deiner Nutzer beispielsweise ein Problem mit deinem Plugin, lass dir doch einfach mal die Logs schicken. Das kann oft schon Aufschluss über das Problem geben.

Einstellungen und Daten dauerhaft speichern
Wenn dein Plugin Konfigurationen oder Zustände speichert, sollten diese so abgelegt werden, dass sie einen Neustart und ein Plugin-Update überstehen.
Dafür steht dir das Datenverzeichnis /data des Plugins zur Verfügung.
Speichere dort beispielsweise:
- Konfigurationen
- Zuordnungen
- lokal ermittelte Geräteinformationen
- notwendige Zustände
Eben alles, was für den Betrieb deines Plugins wichtig ist und am besten auch den aktuellen Zustand von Geräten, die dein Plugin in die HCU geschrieben hat. Vermeide dagegen, solche Daten ausschließlich im Arbeitsspeicher abzulegen. Nach einem Neustart wären sie sonst verloren.
Datenschutz und Sicherheit beachten
Prüfe vor der Veröffentlichung, welche Daten dein Plugin verarbeitet.
Wenn dein Plugin mit externen Diensten kommuniziert, sollte in der Beschreibung nachvollziehbar sein:
- welche Daten übertragen werden,
- wohin sie übertragen werden,
- warum die Übertragung erforderlich ist,
- ob eine Cloud-Verbindung benötigt wird.
Speichere Zugangsdaten und Tokens niemals fest im Quellcode.
Auch Debugging-Code, Testzugänge oder persönliche Zugangsdaten gehören nicht in das veröffentlichte Plugin.
Plugin-Beschreibung erstellen
Bevor andere Nutzer dein Plugin installieren, möchten sie wissen, was es kann und ob es für ihren Anwendungsfall geeignet ist.
Eine gute Plugin-Beschreibung sollte deshalb mindestens folgende Fragen beantworten:
Was macht das Plugin?
Beschreibe kurz und verständlich den eigentlichen Zweck deines Plugins.
Welche Geräte oder Dienste werden unterstützt?
Nenne konkrete Modelle, Systeme, APIs oder Plattformen, sofern dein Plugin auf bestimmte Voraussetzungen angewiesen ist.
Was kann das Plugin?
Liste die wichtigsten Funktionen übersichtlich auf. Am besten ist immer eine Liste mit Stichpunkten.
Was wird benötigt?
Beschreibe notwendige Hardware, externe Konten, APIs oder andere Voraussetzungen.
Gibt es Einschränkungen?
Sei transparent. Wenn bestimmte Funktionen nicht unterstützt werden oder eine Verbindung zu einem externen Dienst erforderlich ist, solltest du das offen angeben.
Eine klare Beschreibung verhindert unnötige Fehlermeldungen und hilft Nutzern dabei, vor der Installation zu entscheiden, ob dein Plugin zu ihrem System passt.
All diese Infos kannst du ins Stammverzeichnis deines Plugins in die README.md packen. Die meisten Systeme können diese dann auslesen und entsprechend auch darstellen.
Dein Plugin für den HCU Plugin Store vorbereiten
Wenn dein Plugin fertig ist, brauchst du zunächst eine öffentliche Downloadquelle für dein Plugin-Archiv.
Das .tar.gz-Archiv wird nicht im HCU Plugins Community Store hochgeladen. Stattdessen stellst du dein Plugin auf einer geeigneten Plattform zur Verfügung, beispielsweise auf GitHub oder einer vergleichbaren Plattform.
Im HCU Plugins Community Store hinterlegst du anschließend den entsprechenden Link zu deinem Repository.
Der Store stellt damit die Informationen zu deinem Plugin zentral bereit und macht es für andere Nutzer auffindbar. Der eigentliche Download des Plugin-Archivs erfolgt über die von dir bereitgestellte externe Plattform.
Plugin im HCU Plugin Store eintragen
Für den Eintrag im HCU Plugins Community Store solltest du insbesondere folgende Informationen bereithalten:
- Plugin-Name
- deutsche Beschreibung
- Funktionsübersicht
- Voraussetzungen
- Installationshinweise
- bekannte Einschränkungen
- Git-Link zu deinem Repository
- Entwicklername (falls du noch kein Entwicklerkonto angelegt hast)
Achte darauf, dass der hinterlegte Repository-Link immer auf die Hauptseite deines Plugins verweist. Hier sollte nicht der Download-Link angegeben werden.
Plugin veröffentlichen
Sobald dein Plugin auf einer geeigneten Plattform bereitsteht, kannst du es im HCU Plugins Community Store eintragen und den entsprechenden Repository-Link hinterlegen.
Der Store dient dabei als zentrale Anlaufstelle, über die Nutzer Community-Plugins entdecken, Informationen dazu erhalten und die bereitgestellten Downloads erreichen können.
Der Download selbst erfolgt immer über die von dir angegebene externe Plattform.
Du behältst dabei selbstverständlich sämtliche Rechte an deinem Plugin. Der HCU Plugins Community Store beansprucht keine Rechte an deinen Plugins und verkauft oder vertreibt sie nicht selbst.
Updates veröffentlichen
Wenn du eine neue Version deines Plugins veröffentlichst, aktualisierst du zunächst dein externes Repository.
Anschließend solltest du prüfen, ob die im HCU Plugins Community Store hinterlegten Informationen, wie der Beschreibungstest aktuell sind.
Dokumentiere möglichst kurz, was sich geändert hat. Ein einfacher Changelog hilft Nutzern dabei, einzuschätzen, ob sich ein Update für sie lohnt.
Innerhalb von maximal 24 Stunden findet der HCU Plugin Store dein Update auf der Git-Plattform und aktualisiert die Versionsnummer. Nutzer, die dein Plugin im HCU Plugins Community Store auf ihrer Merkliste haben, werden in diesem Moment über neue Versionen informiert.
Auf Rückmeldungen reagieren
Community-Plugins profitieren besonders von Rückmeldungen ihrer Nutzer.
Nicht jeder Fehler tritt in deiner eigenen Umgebung auf. Unterschiedliche Geräte, Netzwerkkonfigurationen oder externe Dienste können zu Problemen führen, die du beim Entwickeln nicht reproduzieren konntest.
Lass dir Fehler möglichst nachvollziehbar beschreiben und bitte bei Bedarf um:
- Plugin-Version
- HCU-1-Version
- relevante Gerätemodelle
- Fehlermeldungen
- Log-Auszüge
Achte dabei darauf, dass Nutzer keine Zugangsdaten, Tokens oder andere sensible Informationen veröffentlichen.
Dein Plugin ist bereit
Du hast damit den kompletten Weg von der ersten Entwicklungsumgebung bis zum veröffentlichten Community-Plugin durchlaufen:
- Entwicklungsumgebung einrichten
- Connect API authentifizieren
- Projekt und Dockerfile vorbereiten
- Plugin programmieren
- Plugin lokal testen
- Docker-Image erstellen
.tar.gz-Archiv erzeugen- Plugin auf der HCU-1 installieren
- Fehler und Logs prüfen
- Plugin dokumentieren und veröffentlichen
- Updates bereitstellen und das Plugin weiterentwickeln
Damit hast du alle grundlegenden Werkzeuge, um eigene Plugins für die Homematic IP HCU-1 zu entwickeln.
Viel Spaß beim Programmieren und vielleicht findet dein Plugin schon bald seinen Platz im HCU Plugins Community Store!
HCU Plugins