Gegevens doorsturen naar een MQTT-broker

✓ EnergieID voor bedrijven

Met MQTT-gegevensdoorsturing kun je gegevens uit EnergieID automatisch doorsturen naar een externe MQTT-broker. Zo kun je die gegevens gebruiken in je eigen omgeving, bijvoorbeeld in interne toepassingen, automatiseringen of andere integraties.

Technische integratie bouwen? Zoek je de exacte payloadstructuur en API-definities? Bekijk dan meteen MQTT-export datamodel en payloadformat.

MQTT-gegevensdoorsturing activeren

  • Ga in je workspace naar Configuratie.
  • Open de functie MQTT-gegevensdoorsturing.
  • Voeg minstens één broker toe en vul de instellingen in.
  • Klik op Bewaren.

Alleen workspace-beheerders kunnen deze functie activeren.

Een MQTT-broker configureren

Je kunt één of meerdere brokers toevoegen. Elke broker heeft zijn eigen verbindingsgegevens, gegevensselectie en topicstructuur.

Verbindingsgegevens

Vul de gegevens van je MQTT-broker in:

  • Broker-URL: het endpoint van je broker, bijvoorbeeld mqtt://broker.example.com:1883 of mqtts://broker.example.com:8883.
  • Gebruikersnaam: de gebruikersnaam waarmee EnergieID op de broker inlogt.
  • Wachtwoord: het wachtwoord voor deze gebruikersnaam.
    • Bij een bestaande broker mag je dit veld leeg laten om het opgeslagen wachtwoord te behouden.
    • Bij een nieuwe broker is dit veld verplicht.

Kies welke gegevens je wilt doorsturen

Je kunt per broker kiezen welke gegevens EnergieID publiceert.

Verwerkte meetwaarden

Schakel deze optie in om verwerkte meetwaarden voor de dossiers in je workspace door te sturen.

De gegevens worden gepubliceerd zodra ze in EnergieID verwerkt zijn. Wanneer een integratie bijvoorbeeld gegevens tijdens een nachtelijke synchronisatie ophaalt en verwerkt, worden die daarna automatisch doorgestuurd. Integraties die continu gegevens aanleveren, worden doorgaans vrijwel onmiddellijk verwerkt en gepubliceerd.

Realtime apparaatgegevens

Schakel deze optie in om realtime gegevens van apparaten door te sturen.

Deze optie is alleen van toepassing op integraties die zelf realtime apparaatgegevens aan EnergieID aanleveren.

Let op: Je moet minstens één van beide opties inschakelen. Als beide opties uitgeschakeld zijn, kun je de configuratie niet bewaren.

Stel de MQTT-topicstructuur in

Je bepaalt per type gegevens naar welk MQTT-topic EnergieID de berichten publiceert.

MQTT-onderwerpstructuur (Topic Path) voor meetwaarden

Standaard:

energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/meter/{{meterId}}
MQTT-onderwerpstructuur (Topic Path) voor apparaatgegevens

Standaard:

energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/device/{{twinId}}

De placeholders worden automatisch vervangen wanneer EnergieID een bericht publiceert. Alle beschikbare placeholders vind je in de voorbeeldtemplates. Je bent niet verplicht om placeholders te gebruiken.

Bevestig AVG-naleving en privacy

Per MQTT-broker moet je bevestigen dat er een geldige rechtsgrond bestaat voor het delen van de gegevens met de MQTT-abonnee(s).

Zonder deze bevestiging kun je the brokerconfiguratie niet bewaren.

In de praktijk betekent dit minstens dat je verwerking conform is met de GDPR/AVG (Verordening (EU) 2016/679), met onder meer:

  • een geldige rechtsgrond voor verwerking (AVG, artikel 6),
  • een verwerkersovereenkomst wanneer de broker-exploitant als verwerker optreedt (AVG, artikel 28),
  • transparantie naar betrokkenen over doorgifte aan derde partijen (AVG, artikelen 13 en 14).

Afhankelijk van je setup kunnen bijkomende regels gelden (bijvoorbeeld sectorspecifieke verplichtingen of nationale uitvoeringsregels binnen de EU/EER).

Wat gebeurt er wanneer publiceren naar een broker mislukt?

Validatie bij bewaren

Bij een onvolledige configuratie krijg je een validatiemelding, bijvoorbeeld wanneer:

  • geen broker is toegevoegd;
  • een verplicht veld ontbreekt;
  • geen gegevens zijn geselecteerd om door te sturen;
  • de bevestiging rond AVG-naleving en privacy ontbreekt.

Fout bij gegevensdoorsturing

Wanneer gegevens niet naar een MQTT-broker kunnen worden gepubliceerd, verschijnt bij die broker een melding Leveringsfout.

Klik op de melding voor meer informatie. Je ziet onder andere:

  • het tijdstip van de meest recente fout;
  • de technische foutmelding van de verbinding of het publiceren.

Workspace-beheerders ontvangen bij de eerste fout voor een broker ook een bericht in het berichtencentrum.

Wijzigingen aan MQTT-instellingen kunnen tot 15 minuten nodig hebben om actief te worden, omdat brokerinstellingen gecachet worden. Als publiceren in die periode mislukt, ververst EnergieID de gecachte brokerconfiguratie en probeert het automatisch opnieuw.

Let op: wanneer je de MQTT-instellingen opnieuw bewaart, wordt de laatst gekende foutmelding gewist. Controleer de foutdetails dus vóór je de configuratie opnieuw bewaart.

Volledige dataformaten

Deze pagina beschrijft de instellingen en foutmeldingen. De exacte structuur van de MQTT-berichten voor meetwaarden en apparaatgegevens, inclusief voorbeeldberichten en veldbeschrijvingen, vind je in een aparte technische pagina:

Datamodel en payloadformat voor MQTT-gegevensdoorsturing

Veelgestelde vragen

Kan ik meerdere MQTT-brokers configureren?

Ja. Je kunt meerdere brokers toevoegen. Elke broker heeft zijn eigen verbindingsgegevens, geselecteerde gegevens og topicstructuur.

Moet ik mijn wachtwoord opnieuw invullen wanneer ik een broker wijzig?

Nee. Bij een bestaande broker kun je het wachtwoordveld leeg laten om het huidige wachtwoord te behouden.

Waarom ontvang ik geen berichten?

Controleer:

  • of de broker correct geconfigureerd is;
  • of minstens één type gegevens geselecteerd is;
  • of de broker-URL en toegangsgegevens correct zijn;
  • of de MQTT-gebruiker voldoende rechten heeft;
  • of er een Leveringsfout wordt weergegeven bij de broker.