AN30 Node-RED příklad REST JSON komunikace s NETIO 4x

Podporovaná zařízení: NETIO 4All, NETIO PowerPDU 4C, NETIO 4, PowerCable REST, PowerBOX 3Px, PowerPDU 4PS, PowerDIN 4Pz, PowerBOX 4Kx, PowerPDU 8QS

Příklad AN30 obsahuje dva příklady práce s NETIO zásuvkami pomocí http přenosu netio.json souborů.

• První příklad lépe vysvětluje funkce a možnosti měření a ovládání jednoho výstupu (Output 1).
• Druhý příklad AN30v2 je zjednodušená verze prakticky použitelná pro Vaše Node-RED projekty.

První AN30 Node-RED skript (flow) demonstruje ovládání výstupu 1 z Dashboardu, který běží v prostředí Node-RED. Pět tlačítek zobrazených na Dashboardu volá všechny možné akce výstupu (vypni, zapni, krátké vypnutí (restart), krátké zapnutí, přepnutí stavu). Soubor netio.json se zapisuje do http serveru chytrých zásuvek http POST.

V dashboardu se periodicky zobrazují stavy všech výstupů a měřené hodnoty z NETIO 4x zařízení (proud, napětí, celkové zatížení zařízení), pokud zařízení umí měřit elektrické hodnoty. Čtení stavu výstupů a měřených hodnot probíhá pomocí stahování souboru netio.json každou sekundu z http serveru zařízení (NETIO zásuvky) pomocí http GET.

Podrobnosti o M2M protokolu: Popis protokolu http(s) REST JSON

Node-RED

Prostředí Node-RED lze spustit na lokálním PC, na Raspberry Pi, v cloudu (MS Azure, IBM) a podobně.

Díky popularitě Node-RED jsme pro Vás připravili víc příkladů:

• AN29: Node-RED příklad URL API komunikace s NETIO 4x 
• AN30: Node-RED příklad REST JSON komunikace s NETIO 4x
• AN31: Node-RED příklad XML komunikace s NETIO 4x
• AN32: Node-RED příklad Modbus/TCP komunikace s NETIO 4x / PowerCable

Flow (Node-RED skript) pro AN30:

NETIO REST JSON http(s) protokol

Aktuální stav zásuvky v okamžiku čtení (0 / 1) je uveden v proměné State. Tato proměnná je určena pro čtení i zápis, pokud není proměná Action uvedena vůbec, nebo je nastavena na hodnotu 6.

Pokud je proměná Action v odeslaném souboru netio.json nastavena na jinou hodnotu než 6, dostane přednost a hodnota nastavená v proměnné State bude ignorována.

Akce které lze aplikovat na každý výstup (elektrickou zásuvku)

NETIO elektrické zásuvky používají ve všech M2M protokolech stejné akce, které lze vykonávat na jednotlivých zásuvkách. Do každého výstupu lze například zapsat akci typu Toggle=přepni na druhý stav, nebo Short Off=vypni na několik sekund.
 

Proměná Action je ale určena pouze pro zápis hodnoty, nelze z ní číst aktuální stav elektrické zásuvky.

•  0 = Vypnutí výstupu  (Off)
•  1 = Zapnutí výstupu (On)
•  2 = Vypnutí výstupu na krátkou dobu (short Off)
•  3 = Zapnutí výstupu na krátkou dobu (short On)
•  4 = Přepnutí výstupu z jednoho stavu do druhého (toggle)
•  5 = Ponechání stavu výstupu (no change)
•  6 = Ignorováno

Hodnota 6 v tagu akce znamená, ignoruj číslo akce a zapiš hodnotu v proměnné “State” kde se vyskytuje pouze 0 nebo 1. Viz dokumentace k M2M JSON.
 

Ukázka JSON souboru pro změnu stavu (Toggle / přepnutí) výstupu číslo 1:

{

 "Outputs": [{

  "ID": 1,

  "Action": 4

 }]

}

Nastavení NETIO 4x chytrých zásuvek

Ve webovém rozhraní zařízení v sekci M2M API Protocols - JSON API , je třeba povolit URL JSON API.

Nastavte Username a Password pro READ-WRITE.

READ-WRITE přihlašovací údaje fungují pro čtení i zápis. V obou HTTP Request blocích (POST i GET) lze použít tytéž READ-WRITE přihlašovací údaje.

Pro uložení stiskněte tlačítko Save Changes. Po uložení dojde k restartu zařízení (cca 1 minuta).

Import AN30 flow (skriptu) do node-RED

V menu vyberte Import -> Clipboard.

Následně zkopírujte text do označeného pole a dejte import.

AN30 se primárně skládá ze dvou částí: POST a GET

POST: Zápis O1

• Pět tlačítek vytvořených v dashboardu ve Flow se zobrazuje na Dashboardu
• Po zmáčknutí tlačítka Output 1 = ON v Dashboardu, se nastaví payload na NETIO.json soubor určující output a akci (definováno na každém tlačítku, podle akcí výstupu).
• Blok HTTP Request (POST) odešle NETIO.json soubor jako request na IP adresu.
• Odpověď od serveru (stav odeslání) vrátí jako výstup.
• Blok Msg.payload zobrazí výstup od HTTP Request (POST)

GET: Čtení O1 – O4

• Blok 1 Second Repeat po sekundových intervalech spíná HTTP Request (GET) blok, který odešle NETIO.json jako GET request a vrátí jako odpověď od serveru kompletní JSON soubor se stavem zásuvky.
• Blok JSON Parse změní JSON soubor, který dostal od HTTP Request (GET) bloku na JSON Object, díky čemuž je možno pracovat s jednotlivými vlastnostmi JSON souboru.
• Blok Function bere jednotlivé části JSON objektu a nastavuje je jako vlastnosti msg objektu, pro pozdější použití.
• Blok Current Chart je funkce, která nastavuje msg.payload na vlastnost msg objektu msg.TotalCurrent, protože Current Chart (Device) blok, který je na ní napojen je schopen zobrazit pouze hodnotu msg.payload.
• Poté následují různé výstupní bloky, které zobrazují v Dashboardu vybrané vlastnosti msg objektu, kterému jsme přiřadili vlastnosti z JSON objektu. 

Msg object a msg.payload

Je jednodušše a přehledně vysvětleno zde:

http://www.steves-internet-guide.com/node-red-message-object/

Ukázka netio.json souboru:

HTTP Request (GET)

Tento blok odešle HTTP Request (GET) a vrátí odpověď o stavu doručení.

Debug node

Vypisuje msg.payload.

Defaultně je nastaven na msg.payload a tudíž v tomto případě zobrazuje v Node-RED odpověď od serveru.

Inject node

Tento blok po sekundových intervalech aktivuje HTTP Request node, který odešle GET request díky čemuž se v Dashboardu aktualizují hodnoty po sekundových intervalech.

Gauge node

Tento blok přidává do Dashboardu widget měřiče.

V AN30 zobrazuje každý jednu vlastnost msg objektu: Napětí [V], proud [A], frekvenci [Hz] a Overall True Power Factor (TPF).

Kód rozdělen do čtyř částí:

• Přidělování hodnot z JSON objektu jednotlivým vlastnostem msg objektu

V případě, že vaše NETIO 4x zařízení nepodporuje měření globálních hodnot, se v node-RED vypisují chyby, protože tato funkce nemůže najít v JSON objektu danou vlastnost např.: msg.payload.GlobalMeasure.Voltage, protože JSON objekt ji neobsahuje. A v tomto případě je nastavena vlastnost msg objektu např.: msg.Voltage na 0 a chyba je odchycena a nenastane.

• Přidělení hodnot stavu outputů

Link node

Link node in a out fungují jako tunel. Do link node in dojde msg.payload a z link node out zase vyjde.

V AN30 je použit pouze ke zpřehlednění flow.

V Dashboard je v menu uveden odkaz na stránky NETIO products:

Konfigurace pro node-RED se přenáší jako JSON struktura a lze ji vložit přes clipboard.

 AN30 v2: Node-RED flow ke stažení

Podporovaná zařízení

• NETIO 4
• NETIO 4All
• PowerPDU 4C
• PowerPDU 4PS
• PowerBOX 3Px
• PowerDIN 4Pz
• PowerCable REST 101x