External Monitoring API

Mål

För integratörer som kräver realtidsöversikt introducerar pollning av vår Telemetry API fördröjningar och medför belastning både hos integratören och hos Sofar.
För att lösa detta kan styrsystemet konfigureras att skicka telemetri till en angiven endpoint som tillhandahålls av integratören.
Denna "webhook-mekanism" möjliggör direkta dataströmmar med nära-noll latens, och kringgår begränsningarna med traditionell API-pollning.

Första konfiguration (Startpunkt för nya användare)

1. Kontrollera ditt nätverk

Se till att din Sofar EMS har en aktiv nätverksanslutning.

2. Lägg till dina enheter

Logga in på driftsättningsgränssnittet och verifiera att enheterna är tillagda till Sofar EMS.

3. Konfigurera webhook via "external data sources"

4. Ange parametrarna

1. URL och endpoint för API:et

2. Bearer-autorisationstoken som används för API-förfrågan. För att förhindra att ett komprometterat styrsystem används för att förfalska data från andra enheter rekommenderar vi starkt att unika tokens används per styrsystem och att varje token bindas till en specifik plats i din implementation.

3. Frekvensen för push av data (i sekunder, standard är 60 s)

4. Välj vilken data som ska pushas:

   • Enhetsnivå-data innehåller alla datafält som anges nedan, per individuell nod ansluten till Sofar EMS.
   • Enhetstypnivå innehåller aggregerad data på enhetstypnivå (t.ex. sol, lagring, fast)

Efteråt väljer du att inkludera alla enheter.

Endpoint-data

Endpoint ska acceptera en HTTP POST-förfrågan med följande data:

Om enhetstypnivå har valts:

{
    "time": "<Unix Timestamp>",
    "siteNodeId": "<Site NodeID>",
    "grid": "<Grid Fields>",
    "solar": "<Solar Fields>",
    "storage": "<Storage Fields>",
    "heat_pump": "<Heat Pump Fields>",
    "switched_load": "<Switched Load Fields>",
    "variable_power_load": "<Variable Power Load Fields>",
}

Om enhetsnivå har valts:

{
    "time": "<Unix Timestamp>",
    "siteNodeId": "<Site NodeID>",
    "nodeId1": "<Node Fields>",
    "nodeId2": "<Node Fields>",
    ...
}

Mer information om de individuella fälten finns här: Feedback Payload Structure.