Extern signal onboarding-flöde
Tips
Onboarding-riktlinjen är avsedd för nya integrationer som använder Eniris MQTT-protokollet.
En nackdel med MQTT-protokollet är att det inte finns någon avisering eller dataöverföring när en ny installation läggs till. Därför rekommenderas det att inkludera följande steg innan fullständig integration med Sofar EMS.
Uppställning
Följande krävs för att sätta upp ett onboarding-flöde
-
Extern API
- En publik API krävs
-
Minst två endpoints
- Onboarding-endpoint Onboarding-endpointen kan användas av Sofar EMS för att skicka en signal som indikerar att installationen är redo att kontrolleras. Ytterligare information kan inkludera kontraktsnummer inmatade av användare, installationsadress, enhetsinformation
- Offboarding-endpoint Offboarding-endpointen kan användas för att indikera att den externa kontrollsignalen har tagits bort från Sofar EMS, och kontroll inte längre är möjlig.
- Status-/hälsokontrollendpoint Hälsokontroll-endpointen kan regelbundet pollas av Sofar EMS för att ge en statusuppdatering av enheterna eller systemet som helhet.
Exempel
-
En ny användare lägger till den externa signalen i Sofar EMS. Onboarding-endpointen kommer att anropas för att indikera att Sofar EMS är redo att lyssna efter kommandon.
-
Sofar EMS har förlorat anslutning till batteriet. Hälsokontroll-endpointen kommer att innehålla ett felmeddelande.
-
Ett kontraktsnummer krävs för att koppla ett Sofar EMS serienummer till en kund. Ett kontraktsnummer kan inkluderas i onboarding-flödet, vilket minskar fram och tillbaka-kommunikation mellan externa signaler och slutanvändare.