|
JSON (JavaScript Object Notation) je jednoduchý textový formát
určený pro ukládání a výměnu dat. Hodnoty mohou být uspořádané do
objektů a polí, vedle čísel a řetězců podporuje také logické hodnoty a
hodnotu null. Zápis je přehledný, úsporný a nezávislý na
programovacím jazyce. Díky široké podpoře můžeme stejná data snadno
zpracovat ve webové aplikaci, v podnikovém systému nebo v jednoduchém
pomocném programu.
V systému Control Web 9 je JSON podporován na několika
úrovních. Pokud potřebujeme předat aktuální hodnoty proměnných, můžeme
využít přímo procedury datové sekce. Pro práci s obecnou strukturou
dokumentu je k dispozici přístroj json. A pokud mají být
data dostupná dalším aplikacím po síti, můžeme použít přístroj web_server.
Tvůrce aplikace tak může zvolit způsob, který nejlépe odpovídá
konkrétní úloze.

Podpora JSON v datových sekcích, v přístroji json a ve
webovém serveru.
Datová sekce jako JSON
Každá datová sekce má proceduru GetJSON, která
vrátí jména datových elementů a jejich aktuální hodnoty jako
řetězec ve formátu JSON. Není tedy potřeba jednotlivé hodnoty
převádět na text a postupně sestavovat výsledný řetězec. Pokud do
sekce doplníme další proměnnou, bude automaticky součástí
generovaného dokumentu.
Ukážeme si jednoduchý příklad. V aplikaci máme datovou sekci
technologie s údaji o teplotě, chodu zařízení a počtu
vyrobených kusů:
var technologie;
teplota : real;
chod : boolean;
pocet_kusu : longint;
end_var;
Pokud jsou aktuální hodnoty těchto proměnných 72.5, true
a 1250, získáme je jediným voláním. Proměnná json_text
je v následujícím příkladu typu string:
json_text = technologie.GetJSON();
Výsledný objekt bude obsahovat následující hodnoty (mezery a
způsob zápisu desetinných čísel se mohou lišit):
{
"teplota": 72.5,
"chod": true,
"pocet_kusu": 1250
}
Stejným způsobem se převádějí také pole datových elementů.
Výjimkou jsou elementy typu data a instrument,
které se při generování vynechávají. Pro předávání textu v
konkrétním kódování existuje také varianta GetJSON(Encoding).
Například volání technologie.GetJSON(65001) vrací
bytestring v kódování UTF-8.
Převod funguje i opačným směrem. Procedura PutJSON
zapíše přijaté hodnoty do odpovídajících elementů sekce. Nemusíme
přitom uvádět všechny proměnné. Pokud potřebujeme změnit pouze
jednu hodnotu, stačí objekt s jedinou položkou. Proměnná chyba
je typu string:
if not technologie.PutJSON( '{"pocet_kusu": 0}', chyba ) then
system.DebugOutput( chyba );
end;
Takto můžeme například načíst nastavení nebo vynulovat
počítadlo po zahájení nové výrobní dávky. Procedura kontroluje
existenci elementů a kompatibilitu datových typů. Pokud některou
hodnotu nelze zapsat, vrátí false a podrobnosti se
vypíší do Okna zpráv. Ostatní platné položky se přesto zapíší, při
neúspěchu se tedy původní hodnoty automaticky neobnovují.
Přístroj json
Struktura dat, která přicházejí z jiného systému, nemusí
odpovídat datovým sekcím naší aplikace. Dokument může obsahovat
vnořené objekty, pole měření nebo další informace, ze kterých
potřebujeme vybrat jen několik hodnot. Pro tyto případy je určen
přístroj json. Přístroj je neviditelný a pracujeme s
ním pomocí nativních procedur.
Dokument můžeme načíst ze souboru procedurou ReadJSONFile,
z řetězce procedurou SetJSONString nebo z datového
elementu typu data procedurou SetJSONData.
Při načítání se kontroluje správnost zápisu. Kořenovým prvkem musí
být objekt nebo pole.
Pokud strukturu dokumentu známe, můžeme pro získání hodnot
použít cestu JSONPath. Cesta začíná tečkou a pokračuje jmény
jednotlivých položek. U pole uvedeme index v hranatých závorkách,
první prvek má index nula.

Pomocí cesty můžeme přímo vybrat hodnotu z vnořeného
objektu nebo pole.
Pro dokument na obrázku můžeme přečíst teplotu následujícím
kódem. Přístroj se jmenuje j, proměnná prijaty_text
obsahuje JSON, chyba je řetězec a teplota
je typu real:
if j.SetJSONString( prijaty_text, chyba ) then
if j.GetPathReal( '.stav.teplota', teplota ) then
system.DebugOutput( 'Teplota', teplota );
end;
else
system.DebugOutput( chyba );
end;
Vedle čtení jednotlivých hodnot jsou k dispozici také procedury
pro získání celého pole, například GetPathArrayReal.
Pokud strukturu dopředu neznáme, můžeme dokument postupně
procházet, zjišťovat typy položek a vstupovat do jednotlivých
objektů a polí.
Přístroj samozřejmě umožňuje také vytvářet nové dokumenty.
Procedura Clear připraví prázdný objekt, do kterého
přidáváme položky požadovaných typů. V následujícím příkladu
sestavíme zprávu o zařízení:
j.Clear();
j.AddString( 'zarizeni', 'Kotelna' );
j.AddRecord( 'stav' );
j.AddReal( 'teplota', 72.5 );
j.AddBoolean( 'chod', true );
j.LevelUp();
j.GetJSONString( json_text, true );
Volání AddRecord vytvoří vnořený objekt a další
položky se vkládají do něj. Procedura LevelUp nás
vrátí o úroveň výš. Výsledkem je následující text:
{"zarizeni":"Kotelna","stav":{"teplota":72.5,"chod":true}}
Parametr true v proceduře GetJSONString
zapne kompaktní zápis bez formátovacích mezer a konců řádků. Pro
přehledné zobrazení při ladění můžeme použít false.
Hotový dokument je možné také uložit do souboru procedurou WriteJSONFile.
Stejný přístroj tak využijeme pro příjem dat, úpravy i přípravu
zpráv pro jiný systém.
JSON ve webovém serveru
Přístroj web_server umožňuje vedle zobrazování
webových stránek také přímý přístup k datům aplikace
prostřednictvím REST API. Jiná aplikace může standardním HTTP
požadavkem přečíst aktuální hodnoty nebo zapsat nové. Data se
přenášejí ve formátu JSON. Pro zpřístupnění datové sekce tedy
nemusíme programovat vlastní obsluhu jednotlivých požadavků.
Sekce musí být globální, musí mít vyplněno jméno section_name
a musí být uvedena v podsekci sections sekce rest_api
v parametrech webového serveru. Vše můžeme nastavit přímo v
inspektoru přístroje.

Nastavení datových sekcí dostupných přes REST API v
inspektoru přístroje web_server.
Každá takto zpřístupněná sekce má adresu /api/sections/jmeno_sekce.
Pro čtení použijeme metodu GET. Pokud jsme
zpřístupnili sekci technologie, můžeme její hodnoty
přečíst například nástrojem cURL:
curl.exe http://localhost/api/sections/technologie
Odpovědí bude JSON objekt s aktuálními hodnotami datových
elementů, stejně jako v příkladu s procedurou GetJSON.
Adresa localhost v ukázce předpokládá, že klient i
server běží na stejném počítači a server používá standardní HTTP
port 80.
Pro zápis použijeme metodu POST a v těle požadavku
odešleme objekt s novými hodnotami. Hlavička Content-Type
musí mít hodnotu application/json. Následující ukázka
je určena pro příkazový řádek Windows cmd.exe:
curl.exe -X POST -H "Content-Type: application/json" -d "{\"pocet_kusu\":0}" http://localhost/api/sections/technologie
Server vrátí výsledek operace opět jako JSON:
{"result":true,"error":""}
Také zde stačí odeslat pouze měněné položky. Pokud se při
zápisu více položek některou nepodaří zapsat, server oznámí chybu,
ale ostatní platné hodnoty zůstanou zapsané.
Pokud je zapnuto přihlašování uživatelů přes web, klient se
nejprve přihlásí požadavkem POST na /api/login.
Získaný token potom přikládá k dalším požadavkům v hlavičce Authorization: Bearer token.
Pro zabezpečený přenos můžeme využít podporu HTTPS přímo ve
webovém serveru.
Vedle hotového REST API můžeme zpracovávat také vlastní JSON
zprávy. Při odeslání dat metodou POST s typem application/json
je k dispozici událostní procedura OnPostJSON.
Přijatý parametr Data můžeme předat přístroji json
pomocí procedury SetJSONData a dále zpracovat podle
potřeb aplikace.
Podpora JSON v systému Control Web 9 tak usnadňuje
propojení průmyslové aplikace s okolním světem. Pro běžné předání
hodnot stačí procedura datové sekce nebo nastavení webového
serveru. Složitější struktury zpracujeme přístrojem json.
Měření, řízení technologie i výměnu dat přitom připravujeme v
jednom vývojovém prostředí.
|