História stránky

MQTT 3.1.1

MQTT 5.0

Meno jednej témy alebo filter pre viacero tém posielaný v rámci SUBSCRIBE správy. Filtrom špecifikuje MQTT klient témy, v rámci ktorých chce prijímať správy.
Pozn: témy sú zoradené hierarchicky, ako oddeľovač slúži lomka (/), ako maska jednej úrovne slúži plus (+), ako maska pre viacero úrovní znak hash (#).
Príklady filtra: a/b , level1/+ , # , +/+/+/up
Pozn: zmena parametra Topic Filter sa prejaví po reštarte komunikácie - napr. v dôsledku rozpadnutia TCP spojenia, pokiaľ sú všetky stanice na linke vypnuté (StOff) a znovu zapnuté, prípadne po reštarte KOM procesu. V prvých dvoch prípadoch sa posiela správa UNSUBSCRIBE na pôvodný Topic Filter a následne SUBSCRIBE na nový Topic Filter (to môže byť dôležité pri tzv. perzistentných sessions, keď je zadaný parameter Client ID a MQTT server si pamätá stav klienta aj po rozpade TCP spojenia).
Pozn: pre Payload Type = Sparkplug Host postačuje filter spBv1.0/# na príjem všetkých Sparkplug správ. Je možné zadať aj prázdny filter, keďže štandardne sa generuje SUBSCRIBE na BIRTH/DATA/DEATH správy odvodené od adries staníc, ktoré sú v Sparkplug formáte (group_id/edge_node_id/[device_id]).
Pozn: pre Payload Type = Sparkplug Edge Node sa automaticky posiela SUBSCRIBE správa aj na všetky NCMD/DCMD témy odvodené od adries Edge Node/Device staníc nakonfigurovaných na linke.
Príklad: 

• pre Edge Node stanicu s adresou myGroup/myEdgeNode sa posiela SUBSCRIBE správa na topic spBv1.0/myGroup/NCMD/myEdgeNode
• pre Device stanicu s adresou myGroup/myEdgeNode/myDevice1 sa posiela SUBSCRIBE správa na topic spBv1.0/myGroup/DCMD/myEdgeNode/myDevice1

Pozn: pre Payload Type = Sparkplug Edge Node sa automaticky posiela SUBSCRIBE správa aj na topic spBv1.0/STATE/<primaryHostApplication>, pokiaľ je zadaný parameter Sparkplug Host ID (<primaryHostApplication> je hodnota tohto parametra), aby bol D2000 KOM proces informovaný o pripojení sa/odpojení Primary Host Application. Pokiaľ príde STATE správa o odpojení sa Primary Host Application (STATE správa s online=false) a v konfigurácii linky je uvedených viacero IP adries, D2000 KOM proces sa odpojí od MQTT servera a skúša ďalšie MQTT servery, kým nenájde taký, ku ktorému je pripojená Primary Host Application (STATE správa s online=true).

Parameter Keep Alive posielaný v rámci CONNECT správy.
Ak je nenulový, udáva interval v sekundách, do ktorého musí klient poslať nejakú správu (ak ju nepošle, MQTT broker ho môže odpojiť). Ak nemá dáta, ktoré by mohol poslať, pošle aspoň výzvu PING request. Nulová hodnota znamená, žte MQTT broker nevyžaduje periodické posielanie správ.

Odporúčaná hodnota Keep Alive je niekoľko minút.

D2000 KOM proces posiela PING výzvy podľa nastavení parametrov Keep Alive a Ping Interval (podľa toho, ktorý interval uplynie skôr).

Nastavenie parsovania správy:

• Text only - správa nie je parsovaná, priradí sa do meraného bodu s adresou IN_TOPIC
• JSON - správa sa parsuje ako JSON dáta. Ak existuje meraný bod s adresou IN_TOPIC, celá správa bude priradená do neho.
  Ak existujú body s adresami JA=json_address, budú naplnené príslušnými dátami z JSON správy. Ak v správe také adresy neexistujú, budú merané body zneplatnené.
• Sparkplug Host - správa sa parsuje ako Sparkplug B payload (binárne kódovaný), D2000 KOM proces sa správa ako Host Application (spotrebiteľ údajov, posiela CMD a STATE správy).
• Sparkplug Edge Node - správa sa parsuje ako Sparkplug B payload (binárne kódovaný), D2000 KOM proces sa správa ako Edge Node (producent údajov, posiela BIRTH a DATA správy).

Text only

JSON

Sparkplug Host

Sparkplug Edge Node

Ak Payload Type=JSON, tak názov poľa s časovou značkou. Ak názov nie je zadaný alebo pole nie je nájdené, hodnotám je priradený aktuálny čas.
Viac informácii o formáte názvu poľa viď body s adresami JA=json_address.

• UNIX - číselná hodnota vyjadruje počet sekúnd od epochy 00:00:00 01.01.1970 UTC.
• UNIXMS - číselná hodnota vyjadruje počet milisekúnd od epochy 00:00:00.000 01.01.1970 UTC.
• ISO8601 - textový formát podľa ISO 8601, ekvivalent špecifikovania masky 'yyyy-mm-ddThh:mi:ss.mssZ' (napr. 2025-05-28T05:51:10.112Z)

Pozn: od nastavení časových parametrov stanice závisí, či je čas interpretovaný ako lokálny alebo UTC s nakonfigurovaným offsetom. Toto pravidlo neplatí pri použití špeciálnych masiek uvedených vyššie, keď sa používa vždy UTC čas s nulovým offsetom.

Kódovanie poľa Payload. MQTT protokol nešpecifikuje obsah poľa Payload; štandardné kódovanie ISO-8859-1 je vhodné na textový aj binárny obsah, UTF-8 je vhodné, ak sú prenášané UTF-8 kódované texty. Aktuálne podporované kódovania sú:

• UTF-8

• ISO-8859-1

• Windows-1250

-

Počet Topic Aliasov, ktoré môže poslať MQTT broker (parameter sa posiela v správe CONNECT). Hodnota 0 (default) znamená, že Topic Aliasy nie sú použité. Parameter je použitý iba pre MQTT Version = MQTT 5.0.

Topic Aliasy sú číselné identifikátory z intervalu <1 ... Topic Alias Maximum>, ktoré posiela D2000 KOM ako aj MQTT Broker namiesto textových identifikátorov.

Pozn: V správe CONNACK (odpoveď na CONNECT) posiela voliteľne MQTT broker svoju hodnotu "Topic Alias Maximum", ktorá má význam počtu Topic Aliasov, ktoré môže poslať D2000 KOM proces (napr. test.mosquitto.org posiela hodnotu 10). D2000 KOM používa Topic Aliasy iba ak hodnota jeho konfiguračného parametra Topic Alias Maximum je nenulová.
Pozn: Topic Aliasy posiela D2000 KOM proces iba pri zápise hodnôt (NDATA/DDATA/NCMD/DCMD), nepoužíva ich pre NBIRT/DBIRTH/NDEATH/DDEATH správy (v rámci MQTT Sparkplug) z dôvodu šetrenia aliasmi.

Pre Payload Type = Sparkplug Host: Aktivácia parsovania neštandardných SparkPlug topicov. 
Štandardný topic má tvar 'namespace/group_id/message_type/edge_node_id/[device_id]' napr. 'spBv1.0/Owner/DDATA/devicebase1/local_inputs'.
Neštandardný topic má namiesto group_id niekoľko úrovní, napr. 'spBv1.0/Basel/Packaging/DDATA/Falcon11/plannedProductionQuantity'.
Pozn: zápis do meraných bodov na staniciach s neštandardným SparkPlug topicom nie je podporený.

Pre Payload Type = Sparkplug Host: v rámci metriky je možné definovať vlastnosť (Property) s názvom Quality typu Int32. Podľa Sparkplug štandardu musí nadobúdať hodnoty 0=BAD, 192=GOOD, 500=STALE. Akúkoľvek inú hodnotu D2000 Kom proces reportuje ako chybu. Parametrom Ignore Unknown Quality je možné potlačiť tento chybový výpis.

Pre Payload Type = Sparkplug Host: Parameter udáva, ktoré adresy metriky typu Dataset sa zobrazia pri browsovaní:

• Columns only: zobrazí sa pre každý stĺpec datasetu jedna adresa (napr. Dataset[*]^ColA)
• Items only: zobrazí sa adresa každej položky (napr. Dataset[1]^ColA, Dataset[2]^ColA, ...)
• Columns + Items: zobrazia sa adresy pre stĺpce aj pre položky

Pre Payload Type = Sparkplug Host: Oddeľovač jednotlivých úrovní v šablónach (Templates) použitý pri zadávaní adresy meraného bodu v Sparkplug režime.
Prednastavená hodnota je "->", takže adresa meraného bodu môže byť napr. SA=Template1->SubTemplate2->Item. Pokiaľ by sa v mene šablón vyskytovala dvojica "->", je možné nahradiť tento oddeľovač (napr. "=>").

Pre Payload Type = Sparkplug Host:

Identifikátor Host Aplikácie (D2000 je Host Aplikácia). 
Ak je zadaný, D2000 KOM proces pošle podľa MQTT Sparkplug štandardu správu STATE (s online=true) po pripojení sa k MQTT serveru. Touto správou oznamuje, že žije (ekvivalent NBIRTH a DBIRTH správ, ktoré posielajú zariadenia typu Edge Node a Device). Zároveň nastaví v CONNECT správe Will Topic/Will Message podľa Sparkplug štandardu (STATE správa s online=false), s Will QoS=QoS_1, Will Retain=YES, Clean Session Flag=YES.
Ak identifikátor zadaný nie je, D2000 KOM správu STATE neposiela (a nastavenie Will parametrov je konfigurovateľné).
Podľa MQTT Sparkplug štandardu je identifikátor povinný pre režim Sparkplug Host (bez jeho zadania sa D2000 KOM proces tvári ako "anonymný" klient a neposiela STATE správu).

Pre Payload Type = Sparkplug Edge Node:

Identifikátor Primary Host Aplikácie (Host Aplikácie, ktorá je pre tento Edge Node definovaná ako primárna - najdôležitejšia).
Ak je identifikátor zadaný, D2000 KOM proces čaká po pripojení sa k MQTT serveru na správu STATE. Keď ju dostane a obsahuje online=true, pošle NBIRTH správu s definíciami a hodnotami všetkých výstupných meraných bodov stanice zodpovedajúcej Edge Node a voliteľne DBIRTH správy pre stanice zodpovedajúce Device/Sensor zariadeniam (ak sú také stanice nakonfigurované). Pokiaľ STATE správa obsahuje online=false (tj. Primary Host Aplikácia nie je pripojená k MQTT serveru), D2000 KOM sa odpojí od MQTT servera a skúša ďalší MQTT server podľa konfigurácie komunikačnej linky - ak je nakonfigurovaných viacero MQTT serverov. Ak je nakonfigurovaný jediný MQTT server, D2000 KOM čaká na prijatie STATE správy s online=true od Primary Host Aplikácie a až následne začne posielať správy NBIRTH/DBIRTH/NDATA/DDATA. Pokiaľ je nastavený parameter Store & Forward a  Primary Host Aplikácia nie je pripojená k MQTT serveru, zmeny hodnôt sa ukladajú do pamäte (rovnako ako pri nefunkčnej komunikácii s MQTT brokerom).
Ak nie je identifikátor zadaný, D2000 KOM proces pošle NBIRTH a prípadne DBIRTH správy okamžite po pripojení sa k MQTT serveru (a následne posiela NDATA/DDATA správy so zmenami hodnôt).
Podľa MQTT Sparkplug štandardu je špecifikovanie Primary Host Aplikácie voliteľné pre režim Sparkplug Edge Node.
Pozn: Bez ohľadu na hodnotu parametra Sparkplug Host ID sa nastaví v CONNECT správe Will Topic/Will Message podľa Sparkplug štandardu, s Will QoS=QoS_1, Will Retain=NO, Clean Session Flag=YES.

Pre Payload Type = Sparkplug Edge Node, parameter zapína Store & Forward funkcionalitu pre všetky stanice na linke: pokiaľ je komunikácia s MQTT brokerom nefunkčná, hodnoty sa ukladajú do pamäte a po obnovení komunikácie sa pošlú s príznakom príznakom is_historical.
Pozn: toto nastavenie môže byť zmenené pre konkrétne stanice parametrom stanice Store & Forward.

Pridanie textovej reprezentácie typu hodnoty (napr. Int32) a časovej značky do textového meraného bodu s adresou IN_SP2JS slúžiaceho na konverziu Sparkplug payloadu na JSON a prípadné parsovanie v ESL skripte.