Externer Signal-Onboarding-Ablauf
Tipp
Die Onboarding-Richtlinie ist für neue Integrationen vorgesehen, die das Eniris MQTT-Protokoll verwenden.
Ein Nachteil des MQTT-Protokolls ist, dass keine Benachrichtigung oder Datenübertragung erfolgt, wenn eine neue Installation hinzugefügt wird. Daher wird empfohlen, die folgenden Schritte vor der vollständigen Integration mit dem Sofar EMS durchzuführen.
Einrichtung
Für die Einrichtung eines Onboarding-Ablaufs werden die folgenden Punkte benötigt:
-
Externe API
- Eine öffentliche API ist erforderlich
-
Mindestens zwei Endpunkte
- Onboarding-Endpunkt Der Onboarding-Endpunkt kann vom Sofar EMS verwendet werden, um ein Signal zu senden, das anzeigt, dass die Installation zur Steuerung bereit ist. Zusätzliche Informationen können Vertragsnummern, eingetragen von Nutzern, Installationsadresse, Geräteinformationen umfassen.
- Offboarding-Endpunkt Der Offboarding-Endpunkt kann verwendet werden, um anzuzeigen, dass das externe Steuersignal vom Sofar EMS entfernt wurde und eine Steuerung nicht mehr möglich ist.
- Status-/Healthcheck-Endpunkt Der Healthcheck-Endpunkt kann regelmäßig vom Sofar EMS abgefragt werden, um eine Statusaktualisierung der Geräte oder des Systems insgesamt bereitzustellen.
Beispiel
-
Ein neuer Nutzer fügt das externe Signal in dem Sofar EMS hinzu. Der Onboarding-Endpunkt wird aufgerufen, um anzuzeigen, dass das Sofar EMS bereit ist, Befehle zu empfangen.
-
Das Sofar EMS hat die Verbindung zur Batterie verloren. Der Healthcheck-Endpunkt enthält eine Fehlermeldung.
-
Eine Vertragsnummer wird benötigt, um eine Sofar EMS Seriennummer mit einem Kunden zu verknüpfen. Eine Vertragsnummer kann im Onboarding-Ablauf mit aufgenommen werden, um die Kommunikation zwischen externen Signalen und Endkunden zu reduzieren.