Dokumentace · Pro výrobce zařízení

PLC Tecomat (Mosaic): připojení k onlineWattu přes MQTT

Poslední změna: Verze textu 1 z 17. 11. 2026English version

Obsah

Tato stránka je pro výrobce a integrátory, kteří programují PLC Tecomat v prostředí Mosaic a chtějí z něj posílat data do onlineWattu a přijímat příkazy z portálu. Úplný popis rozhraní je na stránce Připojení zařízení: MQTT a HTTP API.

Co budete potřebovat

  • Účet výrobce v onlineWattu – zřizuje se po dohodě, viz Portál pro výrobce zařízení.
  • Typ zařízení s komunikací MQTT a mappingem a v něm jedno založené zařízení na zkoušku. Z jeho detailu opíšete MQTT uživatele, MQTT heslo a číslo zařízení z MQTT topiků.
  • Adresu MQTT brokeru a port – dostanete je od onlineWattu při zřízení účtu.
  • PLC Tecomat Foxtrot 2 s připojením k internetu přes Ethernet a prostředí Mosaic. Šifrované spojení (TLS) uživatelského kanálu umí jen Foxtrot 2.
  • V projektu knihovny MQTTLib a JsonLibEx (parser JSON, funkční blok fbJsonParserEx, potřebný pro příjem příkazů); obě jsou součástí Mosaic.

Postup

1. Založte typ a zařízení v portálu

V menu Typy zařízení klikněte na Přidat typ zařízení, zvolte Technologie a Komunikace MQTT a do pole Mapping zapište hodnoty, které budete posílat. Potom v menu Zařízení klikněte na Přidat zařízení.

2. Opište přístupové údaje

Zařízení → tři tečky → Editovat: MQTT uživatel, MQTT heslo a MQTT topiky. Číslo v topiku onlinewatt/devices/123/metrics je číslo zařízení.

3. Připravte projekt v Mosaic

Přidejte do projektu knihovny MQTTLib a JsonLibEx. Odesílání a příjem jsou dvě samostatná spojení k brokeru, každé na vlastním uživatelském kanálu Ethernetu a s vlastním clientId.

4. Nastavte uživatelské kanály

V konfiguraci PLC otevřete oba kanály (Obecný uživatelský kanál), zaškrtněte Modul povolen a na záložce Vlastnosti v části Nastavení Ethernet UNI režimu nastavte:

Položka ETH1_UNI1 (odesílání) ETH1_UNI3 (příjem příkazů)
Velikost přijímací zóny 512 1350
Velikost vysílací zóny 1350 512
Protokol TLS/SSL Client (pouze Foxtrot 2) TLS/SSL Client (pouze Foxtrot 2)
Vzdálená IP adresa 0.0.0.0 0.0.0.0
Vzdálený port 0 0
Místní port 0 0

Adresu a port brokeru nastavuje až program při připojení, v konfiguraci kanálu zůstávají nuly.

5. Vložte program a doplňte údaje

Vložte příklad níže jako nový program, zařaďte ho do cyklického zpracování a nahraďte ukázkové proměnné vlastními hodnotami. Přístupové údaje zapište do PLC až při výrobě – ne do zdrojového kódu.

6. Zkontrolujte portál

V seznamu Zařízení se u vašeho kusu do minuty změní čas ve sloupci Poslední metriky. Zařízení si pak zákazník nebo instalační firma zaregistruje sériovým číslem a registračním tokenem z výrobního štítku.

Jak příklad funguje

  1. Adresa brokeru: blok fbNsLookUpEx zjistí IP adresu brokeru z DNS po startu, jednou denně a každou minutu, kdy PLC není připojené.
  2. Metriky: každou sekundu se sčítají vzorky, jednou za minutu odejde jejich průměr na topik metrics.
  3. Události: když nastavíte číslo události (UID z typů událostí v portálu), odejde zpráva {"id": číslo} na topik events.
  4. Příkazy: blok fbMQTTSubscriberEx přijímá zprávy z topiku commands, fbJsonParserEx z nich přečte uid a command a program odpoví na topik commands_response se stejným uid.
  5. Pořadí odesílání: odpověď na příkaz má přednost před událostí a ta před metrikami. Další zprávu program pošle, až broker potvrdí předchozí.

Příklad

(* Příklad: PLC Tecomat (Mosaic) posílá data do onlineWattu přes MQTT a přijímá příkazy.
   Potřeba: PLC Foxtrot 2, knihovny MQTTLib a JsonLibEx (součást Mosaic),
   v konfiguraci PLC dva uživatelské kanály s protokolem TLS/SSL Client:
   ETH1_UNI1 (odesílání; přijímací zóna 512, vysílací 1350) a ETH1_UNI3 (příjem; přijímací 1350, vysílací 512).
   Hodnoty rBatterySoc, rBatteryPower, rGridL1..3 nahraďte vlastními proměnnými.
   Příklad je výchozí bod – před nasazením ho vyzkoušejte na svém PLC. *)
PROGRAM prgOnlineWatt
  VAR
    (* Přístupové údaje: adresu brokeru dostanete od onlineWattu, ostatní z detailu zařízení v portálu.
       Do zdrojového kódu je nepište – zapisujte je do PLC až při výrobě (retain proměnné, servisní panel). *)
    sBrokerName  : STRING[80];         // adresa MQTT brokeru
    uiBrokerPort : UINT;               // port MQTT brokeru
    sDeviceID    : STRING[20];         // číslo zařízení z MQTT topiků, např. 123
    sLogin       : STRING[40];         // MQTT uživatel
    sPass        : STRING[40];         // MQTT heslo
    sHwVersion   : STRING[20] := 'CP-2979';
    sSwVersion   : STRING[20] := '1.0.0';

    (* Naměřené hodnoty – nahraďte vlastními *)
    rBatterySoc   : REAL;              // %
    rBatteryPower : REAL;              // kW, minus = vybíjení
    rGridL1, rGridL2, rGridL3 : REAL;  // kW, minus = dodávka do sítě
    iEventId      : INT;               // > 0 = poslat událost s tímto číslem (UID z portálu)
    iTempOffset   : INT;               // posun teploty z tlačítek portálu −2 … +2

    (* DNS *)
    DnsLookup : fbNsLookUpEx;
    BrokerIP  : TIPadr;                // IP adresa brokeru zjištěná z DNS
    xDnsInit, xGetIP, xIpReady : BOOL;

    (* MQTT *)
    Pub : fbMQTTPublisherEx;
    Sub : fbMQTTSubscriberEx;
    pubParam : T_MQTT_COM_PUB_PARAM;
    subParam : T_MQTT_COM_SUB_PARAM;
    sTopicBase, sPubTopic, sSubTopic : STRING[80];
    sMsg      : STRING[255];           // jedna zpráva; delší skládejte z více řetězců (odesílá se max. 1200 B)
    usiData   : ARRAY [0..1199] OF USINT;
    usiIn     : ARRAY [0..2047] OF USINT;   // příchozí zprávy až 2048 B
    uiLen, i  : UINT;
    pByte     : PTR_TO USINT;
    xSend, xSendCom, xBusy, xSubscribed : BOOL;
    BusyTimeout : TON;

    (* Metriky: průměr za minutu *)
    Minute : TON;
    xMetricsDue : BOOL;
    rSumSoc, rSumBat, rSumL1, rSumL2, rSumL3, rCnt : REAL;

    (* Příkazy *)
    Json : fbJsonParserEx;
    jsonInfo : TJsonInfo;
    uiInCountOld : UINT;
    xParsing, xRespond, xCmdOk : BOOL;
    sCmdUid, sCmdName, sCmdMsg : STRING[80];
  END_VAR

  sTopicBase := 'onlinewatt/devices/' + sDeviceID;

  (* 1. Adresa brokeru z DNS: po startu, jednou denně a každou minutu bez spojení *)
  IF NOT xDnsInit OR System_S.R_EDGE_1DAY OR ((NOT Pub.connected_to_broker) AND System_S.R_EDGE_1MIN) THEN
    xDnsInit := TRUE;
    xGetIP := TRUE;
  END_IF;
  DnsLookup(getIP := xGetIP, DnsIP := GetDNS_IP(ethChan := ETH1), Name := sBrokerName, IP := BrokerIP);
  IF DnsLookup.Done THEN
    xIpReady := TRUE;
    xGetIP := FALSE;
  ELSIF DnsLookup.Err THEN
    xGetIP := FALSE;
  END_IF;

  (* 2. Každou sekundu sčítat vzorky, jednou za minutu poslat průměr *)
  IF System_S.R_EDGE_1SEC THEN
    rSumSoc := rSumSoc + rBatterySoc;
    rSumBat := rSumBat + rBatteryPower;
    rSumL1 := rSumL1 + rGridL1;
    rSumL2 := rSumL2 + rGridL2;
    rSumL3 := rSumL3 + rGridL3;
    rCnt := rCnt + 1.0;
  END_IF;
  Minute(IN := NOT Minute.Q, PT := T#60s);
  IF Minute.Q THEN
    xMetricsDue := TRUE;
  END_IF;

  (* 3. Co odeslat: odpověď na příkaz má přednost před událostí a ta před metrikami *)
  IF Pub.connected_to_broker AND NOT xBusy AND NOT xSend THEN
    IF xRespond THEN
      sMsg := '{"uid":"' + sCmdUid + '","response":{"success":' + BOOL_TO_STRING(xCmdOk) + ',"message":"' + sCmdMsg + '"}}';
      sPubTopic := sTopicBase + '/commands_response';
      xRespond := FALSE;
      xSend := TRUE;
    ELSIF iEventId > 0 THEN
      sMsg := '{"id":' + INT_TO_STRING(iEventId) + '}';
      sPubTopic := sTopicBase + '/events';
      iEventId := 0;
      xSend := TRUE;
    ELSIF xMetricsDue AND rCnt > 0.0 THEN
      sMsg := '{"battery_soc":' + REAL_TO_STRINGF(rSumSoc / rCnt, '%3.1f')
            + ',"battery_power":' + REAL_TO_STRINGF(rSumBat / rCnt, '%4.3f')
            + ',"grid_l1_power":' + REAL_TO_STRINGF(rSumL1 / rCnt, '%4.3f')
            + ',"grid_l2_power":' + REAL_TO_STRINGF(rSumL2 / rCnt, '%4.3f')
            + ',"grid_l3_power":' + REAL_TO_STRINGF(rSumL3 / rCnt, '%4.3f')
            + ',"hw_version":"' + sHwVersion + '","sw_version":"' + sSwVersion + '"}';
      sPubTopic := sTopicBase + '/metrics';
      rSumSoc := 0.0; rSumBat := 0.0; rSumL1 := 0.0; rSumL2 := 0.0; rSumL3 := 0.0; rCnt := 0.0;
      xMetricsDue := FALSE;
      xSend := TRUE;
    END_IF;
  END_IF;

  (* 4. Řetězec do pole bajtů a odeslání *)
  IF xSend THEN
    uiLen := INT_TO_UINT(LEN(sMsg));
    pByte := ADR(sMsg);
    FOR i := 1 TO uiLen DO
      usiData[i - 1] := pByte^;
      pByte := pByte + 1;
    END_FOR;
    xSendCom := TRUE;
    xBusy := TRUE;
    xSend := FALSE;
  END_IF;

  pubParam.pRetain := FALSE;   // bez příznaku retain
  pubParam.qos := 1;           // metriky s QoS 1
  pubParam.clean := FALSE;     // trvalá relace

  Pub(connect := xIpReady,
      chanCode := ETH1_UNI1,
      brokerIP := BrokerIP,
      brokerPort := uiBrokerPort,
      localPort := 6000,
      keepAlive := TRUE,
      keepAliveInterval := T#60s,
      connTimeOut := T#35s,
      pingInterval := T#25s,
      clientId_auto := FALSE,
      clientId := TecoInfoStruct.plcName + '_' + sDeviceID + '_pub',   // jedinečné pro každé spojení
      loginName := sLogin,
      loginPass := sPass,
      comParam := pubParam,
      topicTxt := sPubTopic,
      sendCom := xSendCom,
      pData := ADR(usiData),
      dataLength := uiLen);
  xSendCom := FALSE;

  (* Potvrzení od brokeru u QoS 1: PUBACK (64) *)
  IF Pub.mesType = 64 THEN
    xBusy := FALSE;
  END_IF;
  BusyTimeout(IN := xBusy, PT := T#10s);
  IF BusyTimeout.Q OR NOT Pub.connected_to_broker THEN
    xBusy := FALSE;
  END_IF;

  (* 5. Příjem příkazů *)
  sSubTopic := sTopicBase + '/commands';
  IF NOT Sub.connected_to_broker THEN
    xSubscribed := FALSE;
  ELSIF Sub.errCode = 0 AND NOT xSubscribed THEN
    Sub.subRq := TRUE;
    xSubscribed := TRUE;
  END_IF;

  Sub(connect := xIpReady,
      chanCode := ETH1_UNI3,
      brokerIP := BrokerIP,
      brokerPort := uiBrokerPort,
      localPort := 50000,
      keepAlive := TRUE,
      keepAliveInterval := T#60s,
      pingInterval := T#25s,
      connTimeOut := T#35s,
      clientId_auto := FALSE,
      clientId := TecoInfoStruct.plcName + '_' + sDeviceID + '_sub',
      loginName := sLogin,
      loginPass := sPass,
      comParam := subParam,
      topicTxt := sSubTopic,
      pData := ADR(usiIn));

  (* Nová zpráva → spustit parser JSON *)
  IF Sub.msgCounter <> uiInCountOld THEN
    uiInCountOld := Sub.msgCounter;
    sCmdUid := '';
    sCmdName := '';
    Json(start := TRUE, shrink := FALSE, size := UINT_TO_UDINT(Sub.inMsgLen), sourceJSON := usiIn[0], JsonInfo := jsonInfo);
    xParsing := TRUE;
  END_IF;

  (* Parser vrací položky jednu po druhé *)
  IF xParsing THEN
    IF Json.done THEN
      IF jsonInfo.item.name = 'uid' THEN
        sCmdUid := jsonInfo.item.value;
      ELSIF jsonInfo.item.name = 'command' THEN
        sCmdName := jsonInfo.item.value;
      END_IF;
    END_IF;
    Json(start := FALSE, shrink := FALSE, size := UINT_TO_UDINT(Sub.inMsgLen), sourceJSON := usiIn[0], JsonInfo := jsonInfo);
    IF Json.eod THEN
      xParsing := FALSE;
      (* Tlačítka teploty v portálu: názvy příkazů určuje mapping typu zařízení, např. IndoorTemp+1 *)
      xCmdOk := TRUE;
      IF sCmdName = 'IndoorTemp-2' THEN iTempOffset := -2;
      ELSIF sCmdName = 'IndoorTemp-1' THEN iTempOffset := -1;
      ELSIF sCmdName = 'IndoorTemp0' THEN iTempOffset := 0;
      ELSIF sCmdName = 'IndoorTemp+1' THEN iTempOffset := 1;
      ELSIF sCmdName = 'IndoorTemp+2' THEN iTempOffset := 2;
      ELSE xCmdOk := FALSE;
      END_IF;
      IF xCmdOk THEN
        sCmdMsg := 'OK';
        (* Po provedení pošlete událost se speciální akcí pro daný posun (UID podle typu událostí v portálu) *)
      ELSE
        sCmdMsg := 'Neznamy prikaz';
      END_IF;
      xRespond := sCmdUid <> '';   // na každý příkaz odpovědět se stejným uid
    END_IF;
  END_IF;
END_PROGRAM

Na co si dát pozor

  • Velikost zpráv: fbMQTTPublisherEx odešle nejvýše 1200 B, fbMQTTSubscriberEx přijme nejvýše 2048 B. Řetězec STRING má nejvýše 255 znaků, delší zprávu proto skládejte z více řetězců a před odesláním zkontrolujte celkovou délku – zápis za konec pole by PLC zastavil.
  • Jedinečné clientId pro každé spojení a každý kus, například z názvu PLC a čísla zařízení. Když se se stejným clientId připojí jiný klient, předchozí spojení se ukončí.
  • Metriky jednou za minutu, jako průměr vzorků od minulého odeslání. Když metriky asi 5 minut nepřijdou, portál zařízení označí jako offline.
  • Znaménka: minus znamená vybíjení baterie a dodávku do distribuční sítě; plus výrobu, nabíjení a odběr ze sítě.
  • Na každý příkaz odpovězte se stejným uid. Po změně teploty pošlete událost se speciální akcí pro daný posun a nový stav v dalších metrikách.
  • Ostatní pravidla jsou stejná jako pro jiná zařízení – viz Připojení zařízení: MQTT a HTTP API.

Pomůžeme vám

S integrací PLC Tecomat pomáháme: s návrhem mappingu a typů událostí, se zkušebním zařízením i s kontrolou, že data do portálu chodí správně. Napište na info@onlinewatt.com, jaké PLC a jaký program používáte.

Limity příkladu

  • Příklad je výchozí bod, ne hotový program: posílá jen několik ukázkových hodnot, neřeší frontu více událostí ani opakované odeslání zprávy, kterou broker nepotvrdil.
  • Názvy typů a bloků se mohou mezi verzemi knihoven lišit; před nasazením příklad vyzkoušejte na svém PLC.
  • Metriky posílá s QoS 1. Potvrzení od brokeru pozná podle typu zprávy PUBACK; jinou kvalitu služby nepoužívejte bez domluvy.

← Celá dokumentace · Našli jste chybu nebo vám něco chybí? Napište na info@onlinewatt.com.