Onboarding-Ablauf für externe Signale
Tipp
Die Onboarding-Richtlinie ist für neue Integrationen mit dem Eniris-MQTT-Protokoll vorgesehen.
Ein Nachteil des MQTT-Protokolls besteht darin, dass keine Benachrichtigung oder Datenübertragung erfolgt, wenn eine neue Installation hinzugefügt wird. Daher wird empfohlen, die folgenden Schritte auszuführen, bevor Sie die Integration mit dem a-TroniX Controller vollständig abschließen.
Einrichtung
Für die Einrichtung eines Onboarding-Ablaufs ist Folgendes erforderlich
-
Externe API
- Eine öffentliche API ist erforderlich
-
Mindestens zwei Endpunkte
- Onboarding-Endpunkt Der Onboarding-Endpunkt kann vom a-TroniX Controller verwendet werden, um ein Signal zu senden, das angibt, dass die Installation bereit zur Steuerung ist. Zusätzliche Informationen können von Benutzern eingegebene Vertragsnummern, die Installationsadresse und Geräteinformationen umfassen.
- Offboarding-Endpunkt Der Offboarding-Endpunkt kann verwendet werden, um anzugeben, dass das externe Steuersignal vom a-TroniX Controller entfernt wurde und eine Steuerung nicht mehr möglich ist.
- Status-/Healthcheck-Endpunkt Der Healthcheck-Endpunkt kann regelmäßig vom a-TroniX Controller abgefragt werden, um eine Statusaktualisierung der Geräte oder des gesamten Systems bereitzustellen.
Beispiel
-
Ein neuer Benutzer fügt das externe Signal im a-TroniX Controller hinzu. Der Onboarding-Endpunkt wird aufgerufen, um anzugeben, dass der a-TroniX Controller bereit ist, auf Befehle zu warten.
-
Der a-TroniX Controller hat die Verbindung zur Batterie verloren. Der Healthcheck-Endpunkt enthält eine Fehlermeldung.
-
Eine Vertragsnummer ist erforderlich, um die Seriennummer eines a-TroniX Controller einem Kunden zuzuordnen. Eine Vertragsnummer kann in den Onboarding-Ablauf aufgenommen werden, wodurch die Kommunikation zwischen externen Signalen und Endkunden reduziert wird.
