MQTT-export

✓ EnergieID voor bedrijven

Met de Workspace-functie MQTT-export stuur je meterdata en apparaatgegevens door naar een externe MQTT-broker. Zo kun je die EnergieID-gegevens gebruiken in je eigen omgeving, zoals in interne toepassingen, automatiseringen of andere integraties. Ben je nieuw met MQTT? Bekijk dan eerst de korte introductie op mqtt.org.

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

Waar vind je MQTT-export?

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

Alleen Workspace-beheerders kunnen deze configuratie bewaren.

Alle instellingen uitgelegd

Broker

Je kunt één of meerdere brokers toevoegen. Elke broker heeft zijn eigen inloggegevens, topictemplates en doorstuurmodi.

  • 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.

Doorstuurmodi

  • Verwerkte meterdata doorsturen: stuurt meterdata door voor elk dossier in de workspace. De data wordt verzonden zodra die in EnergieID verwerkt is. Voor integraties die ’s nachts synchroniseren, gebeurt de doorsturing dus ook ’s nachts. Integraties die continu updates sturen, worden vrijwel meteen doorgestuurd.
  • Realtime apparaatgegevens doorsturen: stuurt realtime data door op apparaatsniveau. Let op: dit geldt alleen voor integraties die zelf realtime data aan EnergieID aanleveren.

Let op: Je moet minstens één doorstuurmodus inschakelen. Als beide uit staan, kan de configuratie niet geldig opgeslagen worden.

Topictemplates

Je bepaalt per modus naar welk MQTT-topic berichten gaan.

  • Topictemplate voor meterdata (standaard): energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/meter/{{meterId}}
  • Topictemplate voor apparaatdata (standaard): energyid/workspace/{{workspaceId}}/record/{{recordNumber}}/device/{{twinId}}

De placeholders worden automatisch vervangen tijdens publicatie. Alle beschikbare placeholders staan in het voorbeeldtemplate. Je hoeft geen placeholders te gebruiken.

AVG / rechtsgrond bevestiging

Per broker moet je bevestigen dat er een geldige rechtsgrond aanwezig is voor het delen van energiedata met die MQTT-abonnee. Zonder deze bevestiging kun je niet opslaan.

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).

Welke foutmeldingen kun je zien?

Validatie bij bewaren

Bij onvolledige configuratie krijg je validatieproblemen tijdens bewaren, bijvoorbeeld:

  • Geen broker toegevoegd.
  • Verplicht veld ontbreekt (broker-URL, gebruikersnaam, of wachtwoord bij een nieuwe broker).
  • Geen doorstuurmodus geactiveerd.
  • Bevestiging van rechtsgrond (AVG) ontbreekt.

Leveringsfout tijdens verzending

Als publiceren naar een broker mislukt, verschijnt er op die broker een badge Leveringsfout. Je kunt hierop klikken voor meer informatie. In de detailweergave zie je:

  • het tijdstip van de meest recente fout,
  • de technische foutmelding van de brokerverbinding of publicatie.

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

Let op: Wanneer je de MQTT-instellingen opnieuw bewaart, wordt de laatst gekende leveringsfout gewist. Controleer foutdetails dus voor je opnieuw bewaart. Mocht er na een update van de instellingen opnieuw een fout plaatsvinden, dan krijg je opnieuw een melding.

Volledige dataformaten per modus

Deze pagina beschrijft de instellingen en foutmeldingen. De exacte payloadstructuur per doorstuurmodus (meterdata en apparaatgegevens), inclusief voorbeeldberichten en veldbeschrijvingen, staat in een aparte technische pagina:

MQTT-export datamodel en payloadformat

Veelgestelde vragen

Kan ik meerdere brokers tegelijk configureren?

Ja. Elke broker wordt afzonderlijk bewaard en gebruikt. Je kunt per broker andere topictemplates en doorstuurmodi instellen.

Moet ik mijn wachtwoord opnieuw invullen bij elke wijziging?

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

Waarom zie ik wel een actieve configuratie maar toch geen berichten?

Controleer de leveringsfout per broker, de broker-URL, de toegangsrechten van de MQTT-gebruiker en of minstens een doorstuurmodus actief is.