...
| Parameter | Popis | Jednotka / rozmer | Náhradná hodnota | ||||||
|---|---|---|---|---|---|---|---|---|---|
| Zapnutie podrobných výpisov o posielaní a prijímaní hodnôt. | YES/NO | NO | ||||||
| Verzia MQTT protokolu, ktorá sa použije na pripojenie sa k MQTT serveru. Je možné použiť starší štandard MQTT 3.1.1 (október 2014) alebo novší štandard MQTT 5.0 (marec 2019). MQTT brokery zvyčajne podporujú oba štandardy, starší štandard je jednoduchší a úspornejší. | MQTT 3.1.1 MQTT 5.0 | MQTT 3.1.1 | ||||||
| Užívateľské meno použité v správe CONNECT na pripojenie sa k MQTT serveru. | - | |||||||
| Heslo použité v správe CONNECT na pripojenie sa k MQTT serveru. | - | |||||||
| 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: 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). | - | # | ||||||
| Požadovaná maximálna úroveň potvrdzovania (QoS) posielaná v rámci SUBSCRIBE správy. MQTT server môže následne posielať PUBLISH správy s takouto alebo nižšou úrovňou potvrdzovania (ale nie vyššou). PUBLISH správy posielané MQTT serverom budú potvrdzované procesom D2000 KOM podľa úrovne potvrdzovania v nich špecifikovanej. Čím vyššia je úroveň potvrdzovania, tým viac správ je medzi klientom a serverom vymenených (1 pri QoS_0, 2 pri QoS_1 a 4 pri QoS_2). | QoS_0 QoS_1 QoS_2 | QoS_1 | ||||||
| Unikátny identifikátor klienta (Client Identifier) posielaný v rámci CONNECT správy. Pozn: je možné zadať aj prázdny reťazec - v tom prípade server môže klientovi prideliť unikátne meno (pokiaľ takúto funkcionalitu podporuje) alebo vráti chybu. Pokiaľ nie je zadaný Client ID, bude ale ignorované nastavenia parametra Clean Session Flag (keďže server pridelí zakaždým unikátne meno). Testovaný MQTT server (thethings.network) vrátil chybu, pokiaľ bolo Client ID prázdne a Clean Session Flag=NO. Pozn: niektoré MQTT brokery (PIXII.COM, Eclipse Mosquitto) identifikovali klientov iba podľa Client ID. V praxi to spôsobovalo, že dva rôzne D2000 systémy, ktoré sa pripájali k jednému brokerovi, boli považované za jedného klienta a broker pri vytvorení spojenia zrušil existujúce spojenie, ktoré považoval za staré, prípadne nedovolil vytvoriť nové spojenie a vrátil chybu Connection Refused, identifier rejected (2). Po nastavení Client ID na unikátnu hodnotu začali komunikácie fungovať bez rozpadov spojení. | - | D2000kom | ||||||
| Parameter Clean Session Flag správy CONNECT. Hodnota NO znamená, že server použije aktuálny stav session (spojenia) - napr. po rozpade a znovuobnovení TCP spojenia. Znamená to, že sú zaslané všetky nepotvrdené PUBLISH správy s QoS_1 a QoS_2 (a voliteľne aj QoS_0 v závislosti na implementácii). Hodnota YES znamená, že sa session vytvorí nanovo a žiadne nepotvrdené PUBLISH správy nie sú opakované. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný a Clean Session Flag sa nastaví na YES (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a Clean Session Flag sa nastaví na YES (viď popis parametra Sparkplug Host ID). | YES/NO | NO | ||||||
| Úroveň potvrdzovania (QoS) použitá pri posielaní PUBLISH správ procesom D2000 KOM. Poslanie PUBLISH správy je dôsledok zápisu do výstupného meraného bodu s adresou OUT_VALUE. Čím vyššia je úroveň potvrdzovania, tým viac správ medzi klientom a serverom poslaných (1 pri QoS_0, 2 pri QoS_1 a 4 pri QoS_2). | QoS_0 QoS_1 QoS_2 | QoS_0 | ||||||
| Nastavenie príznaku Retain použité pri posielaní PUBLISH správ procesom D2000 KOM. Aktivácia príznaku Retain spôsobí, že posledná správa poslaná procesom D2000 KOM bude na MQTT serveri dostupná iným klientom okamžite po ich pripojení, ako aj po odpojení D2000 KOM procesu. | YES/NO | NO | ||||||
| Parameter Keep Alive posielaný v rámci CONNECT správy. 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). | 0-65535 sec | 0 | ||||||
| Pokiaľ MQTT server neposlal za špecifikovaný časový interval žiadnu správu, D2000 KOM proces pošle výzvu PING request a očakáva odpoveď PING response (do času Reply Timeout). Hodnota 0 posielanie PING request správ vypína. Parameter umožňuje detekovať rozpadnutie TCP spojenia. | 0-3600 sec | 60 | ||||||
| Nastavenie parsovania správy:
| Text only JSON Sparkplug Host Sparkplug Edge Node | Text only | ||||||
| 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. | - | - | ||||||
| Maska pre parsovanie hodnoty v poli s časovou značkou. Špeciálne masky sú:
Pozn: od nastavení časových parametrov stanice závisí, či je čas interpretovaný ako lokálny alebo UTC s nakonfigurovaným offsetom. | - | yyyy-mm-dd hh:mi:ss.mss | ||||||
| Ignorovanie chýbajúcej časovej značky - pokiaľ sa v JSON payloade nevyskytuje, nevypíše sa varovanie. | YES/NO | NO | ||||||
| Parameter Will Flag správy CONNECT. Hodnota Yes znamená, že server pošle záujemcom správu Last Will v prípade straty spojenia s D2000 KOM procesom. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný a Last Will sa posiela (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a Last Will sa posiela (viď popis parametra Sparkplug Host ID). | YES/NO | NO | ||||||
| Úroveň potvrdzovania (QoS) použitá pri posielaní správy Last Will v prípade straty spojenia s D2000 KOM procesom. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný a nastaví sa QoS_1 (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a nastaví sa QoS_1 (viď popis parametra Sparkplug Host ID). | QoS_0 QoS_1 QoS_2 | QoS_0 | ||||||
| Nastavenie príznaku Retain použité pri posielaní správy Last Will v prípade straty spojenia s D2000 KOM procesom. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný a Retain sa nastaví na YES (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a Retain sa nastaví na NO (viď popis parametra Sparkplug Host ID). | YES/NO | NO | ||||||
| Topic použitý pri posielaní správy Last Will v prípade straty spojenia s D2000 KOM procesom. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a Topic sa nastaví podľa Sparkplug štandardu (viď popis parametra Sparkplug Host ID). | - | |||||||
| Obsah správy Last Will v prípade straty spojenia s D2000 KOM procesom. Pozn: Ak Payload Type = Sparkplug Host a parameter Sparkplug Host ID nie je prázdny, tento parameter je ignorovaný (viď popis parametra Sparkplug Host ID). Pozn: Ak Payload Type = Sparkplug Edge Node, tento parameter je ignorovaný a Last Will sa nastaví podľa Sparkplug štandardu (viď popis parametra Sparkplug Host ID). | - | |||||||
| Pokiaľ do požadovaného času MQTT server neodpovie na správy SUBSCRIBE, UNSUBSCRIBE a PING request, prípadne sa nepodarí načítať ľubovoľnú správu (a je načítaná iba jej časť), D2000 KOM proces vyhlási chybu, zavrie spojenie a znovu ho otvorí. Hodnota 0 vypína časový limit. Parameter umožňuje reagovať na problematické chovanie MQTT servera. | sec | 20 | ||||||
| Timeout čakanie pri jednom čítaní z TCP spojenia. D2000 KOM opakuje čítanie spontánnych dát Max. Wait Retry krát a pokiaľ nenačíta žiadne dáta, je vyhlásený timeout a čítanie je ukončené (a môže nasledovať ďalšie čítanie alebo prípadne zápis). Zmenšením parametrov Wait Timeout a Max. Wait Retry je možné dosiahnuť rýchlejšiu odozvu D2000 KOM procesu na zápis na úkor vyššej záťaže CPU, pokiaľ MQTT server nemá žiadne dáta. Pozn: ak od MQTT servera prichádza veľa správ a D2000 KOM potrebuje aj zapisovať hodnoty, odporúčame nižšu hodnotu parametra (napr. 0.005 sec), aby zápis nebol blokovaný čítaním (v každom prípade ale po 10 prijatých správach nasleduje prerušenie, počas ktorého sa môžu vykonať nahromadené zápisy). | sec | 0.100 | ||||||
| Počet opakovaní čítania z TCP spojenia. Pozri popis parametra Wait Timeout. | - | 3 | ||||||
| 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ú:
| - | ISO-8859-1 | ||||||
MQTT 5.0 Parameters | |||||||||
| 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á. | 0 | 0 - 65535 | ||||||
Sparkplug parametre | |||||||||
| Parameter aktivuje výpisy neznámych metrík a tém (Topicov), ktoré nemajú vlastné stanice, ale skončia na stanici s adresou ".*" (ak taká existuje). Výpisy budú v logu linky ako chybové hlášky aj keď je debug na linke vypnutý (na uľahčenie pridávania meraných bodov). | YES/NO | NO | ||||||
| Aktivácia parsovania neštandardných SparkPlug topicov (ak Payload Type = Sparkplug Host). | YES/NO | NO | ||||||
| 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. | YES/NO | NO | ||||||
| Parameter udáva, ktoré adresy metriky typu Dataset sa zobrazia pri browsovaní:
| - | Columns only | ||||||
| Oddeľovač jednotlivých úrovní v šablónach (Templates) použitý pri zadávaní adresy meraného bodu v Sparkplug režime. | -> | |||||||
| Ak Payload Type = Sparkplug Host: Identifikátor Host Aplikácie (D2000 je Host Aplikácia). Ak 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 Payload Type = Sparkplug Edge Node, parameter zapína Store & Forward funkcionalitu pre všetky stanice na linke: pokiaľ je komunikácia nefunkčná, hodnoty sa ukladajú do pamäte a po obnovení komunikácie sa pošlú s príznakom is_historical. | YES/NO | NO | ||||||
| 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. | YES/NO | NO | ||||||
...
| Kľúčové slovo | Plný názov | Popis | Jednotka | Náhradná hodnota | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Subscribe Station Address | Ak má tento parameter hodnotu YES, do SUBSCRIBE správy je pridaný aj Topic súvisiaci s adresou stanice:
| YES/NO | NO | ||||||
| Station Will Topic | Will topic zariadenia. Ak je tento parameter nastavený a je prijatá správa so zhodným topicom, stanica prejde do komunikačnej chyby (StHardErr) a hodnoty meraných bodov sa zneplatnia. Takto je možné emulovať štandardné správanie, ktoré nastane pri chybe komunikácie so zariadením (aj keď komunikácia medzi procesom D2000 Kom a MQTT brokerom je funkčná). Ak Payload Type = Sparkplug Host, nie je nutné zadávať tento parameter - ak príde NDEATH/DDEATH správa s topicom, ktorý zodpovedá adrese stanice, stanica prejde do komunikačnej chyby. | ||||||||
| Station Will Payload | Obsah Will správy. Ak je tento parameter nastavený a je prijatá správa so zhodným topicom ako definuje parameter Station Will Topic, musí byť navyše zhodný aj Payload. Ak tento parameter je prázdny reťazec, stačí zhoda topiccu s parametrom Station Will Topic. Pozn: tento parameter bol implementovaný kvôli MQTT brokerom, ktorí posielajú správy s rovnakým Topic pri pripojení/odpojení zariadenia, pričom rozdiel je iba v Payloade. | ||||||||
| Payload Type | Nastavenie parsovania správy (preťaženie linkového parametra Payload Type):
| Default Text only JSON Sparkplug | Default | ||||||
| Time Field Name | Ak Payload Type = JSON, tak názov poľa s časovou značkou - preťaženie linkového parametra Time Field Name. | - | - | ||||||
| Time Mask | Maska pre parsovanie hodnoty v poli s časovou značkou - preťaženie linkového parametra Time Mask). Pozn: od nastavení časových parametrov stanice závisí, či je čas interpretovaný ako lokálny alebo UTC s nakonfigurovaným offsetom. | - | - | ||||||
Sparkplug parametre | ||||||||||
| Send Node Control/Rebirth | Ak Payload Type = Sparkplug Host, pri pripojení sa k MQTT serveru sa pošle na SparkPlug stanicu príkaz (NCMD alebo DCMD) s metrikou 'Node Control/Rebirth'. Odpoveďou by mala byť správa (NBIRTH/DBIRTH) so všetkými aktuálnymi metrikami. | YES/NO | YES | ||||||
| Store & Forward | Parameter umožnuje zmeniť Store & Forward funkcionalitu, ktorú pre všetky stanice na linke definguje linkový parameter Store & Forward. Hodnota Default znamená použitie nastavenia nakonfigurovaného na linke. | Default False True | Default | ||||||
| Sparkplug Alias Mode | Ak Payload Type = Sparkplug Edge Node, parameter určuje režim používania aliasov. Aliasy sú numerické (celočíselné - Int64) identifikátory, používané voliteľne v správach s dátami a príkazmi (NDATA/DDATA/NCMD/DCMD) namiesto textových identifikátorov, z dôvodu zmenšenia veľkosti správ. Ak sa používajú, v správe NBIRTH/DBIRTH sú uvedené spolu s textovými identifikátormi. Aliasy musia byť unikátne v rámci všetkých meraných bodov patriacich pod jednu stanicu.
| Default (SAL=alias) Automatic (HOBJ) Off | Default (SAL=alias) | ||||||
...