5.9.2 api display image
2N® IP Style
Funkce /api/display/image umožňuje modifikovat obsah zobrazovaný na displeji zařízení. Umožňuje nahrát obrázek, příp. nahraný obrázek z displeje odstranit. JPEG obrázky s progresivní kvalitou nejsou podporovány.
Funkce je součástí služby Displej a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Displej (řízení).
Pro tuto funkci lze použít metody PUT nebo DELETE. Metoda PUT slouží k uploadu obrázku na displej. Metoda DELETE slouží k odstranění dříve uploadovaného obrázku z displeje.
Metoda PUT
Parametry požadavku:
Parametr | Popis |
|---|---|
blob-image | Povinný parametr obsahující obrázek ve formátu JPEG, PNG s rozlišením daného displeje 1280 x 800 pixelů (viz funkce /api/display/caps). Parametr se uplatní pouze v případě metody PUT. Progresivní JPEG obrázky nejsou podporovány. |
| duration | Volitelný parametr. Doba zobrazení obrázku. Parametr se nastavuje v milisekundách. |
Obrázek lze zobrazit dvěma způsoby jako notifikace nebo overlay. Notifikace se zobrazuje na předem definovanou dobu, po které automaticky zmizí. Overlay zůstává na displeji do té doby, než je nahrazena jiným obrázkem nebo uživatel sám obrázek odstraní.
Pokud HTTP požadavek neobsahuje volitelný parametr, jedná se o zobrazení v režimu overlay, tj. obrázek nahraný na neurčitou dobu. Pokud je volitelný parametr uveden, obrázek se zobrazí jako notifikace, která se ukončí po uplynutí nastavené doby. Zobrazení notifikace je možné předčasně ukončit dotykem displeje.
Nahrává-li se obrázek poprvé, přenáší se z hlavní jednotky na displej přes interní sběrnici (což může chvíli trvat). V paměti displeje se dá uložit i několik obrázků, a pokud se někdy takto uložené obrázky budou znovu posílat do zařízení, nebude je již třeba přenášet přes interní sběrnici. Místo toho je bude možno ihned zobrazit na displeji z paměti.
Odpověď je ve formátu application/json a neobsahuje žádné parametry.
Parametry obrázku:
Model | Rozměry obrázku | Podporované formáty |
|---|---|---|
| 2N® IP Style | 1280 x 800 pixelů | normální JPEG (doporučeno), PNG |
Upozornění
- Podporovaný JPEG formát je JPEG Baseline (neprogresivní kódování).
Příklad:
|
Metoda DELETE
Parametr | Popis |
|---|---|
display | Povinný identifikátor displeje. Hodnota je nastavena v parametru Hardware / Rozšiřující moduly / Jméno modulu. Případně lze zjistit hodnotu pomocí funkce /api/display/caps. |
Příklad:
|
2N® IP Verso
Funkce /api/display/image umožňuje modifikovat obsah zobrazovaný na displeji zařízení. Umožňuje nahrát, příp. nahraný obrázek z displeje odstranit. Progresivní JPEG obrázky nejsou podporovány.
Funkce je součástí služby Displej a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Displej (řízení).
Pro tuto funkci lze použít metody PUT nebo DELETE. Metoda PUT slouží k uploadu obrázku na displej. Metoda DELETE slouží k odstranění dříve uploadovaného obrázku z displeje.
Metoda PUT
Parametry požadavku:
Parametr | Popis |
|---|---|
display | Povinný identifikátor displeje. Hodnota je nastavena v parametru Hardware / Rozšiřující moduly / Jméno modulu. Případně lze hodnotu zjistit pomocí funkce /api/display/caps. |
blob-image | Povinný parametr obsahující obrázek ve formátu JPEG, BMP, PNG s rozlišením daného displeje 320 x 214 pixelů (viz funkce /api/display/caps). Parametr se uplatní pouze v případě metody PUT. Požadavek smí obsahovat pouze jeden z parametrů, blob-image nebo blob-video. Progresivní JPEG obrázky nejsou podporovány. |
blob-video | Povinný parametr obsahující video ve formátu MPEG4 / H264, max. délka 60 s, fps max. 15 nahraný v rozlišení 320 x 214 pixelů.Požadavek smí obsahovat pouze jeden z parametrů, blob-image nebo blob-video. |
| duration | Volitelný parametr. Doba zobrazení obrázku/přehrávání videa. Parametr se nastavuje v milisekundách. |
| repeat | Volitelný parametr. Počet opakování přehrání videa. Parametr se týká pouze videa. |
Obrázek lze zobrazit dvěma způsoby jako notifikace nebo overlay. Notifikace se zobrazuje na předem definovanou dobu, po které automaticky zmizí. Overlay zůstává na displeji do té doby, než je nahrazena jiným obrázkem nebo uživatel sám obrázek odstraní.
Pokud HTTP požadavek neobsahuje ani jeden z výše uvedených parametrů, jedná se o zobrazení v režimu overlay tj. obrázek nahraný na neurčitou dobu. Pokud jsou uvedeny oba volitelné parametry, zobrazení notifikace se ukončí událostí, která nastane dříve. Zobrazení notifikace je možné předčasně ukončit dotykem displeje.
Nahrává-li se obrázek poprvé, přenáší se z hlavní jednotky na displej přes interní sběrnici (což může chvíli trvat). V paměti displeje se dá uložit i několik obrázků, a pokud se někdy takto uložené obrázky budou znovu posílat do zařízení, nebude je již třeba přenášet přes interní sběrnici. Místo toho je bude možno ihned zobrazit na displeji z paměti.
Odpověď je ve formátu application/json a neobsahuje žádné parametry.
Parametry obrázku:
Model | Rozměry obrázku | Podporované formáty |
|---|---|---|
| 2N® IP Verso | 320 x 214 pixelů | normální JPEG (doporučeno), BMP, PNG |
Upozornění
- Podporovaný JPEG formát je JPEG Baseline (neprogresivní kódování).
Příklad:
|
Parametry videa:
Model | Rozměry videa | Podporované formáty |
|---|---|---|
| 2N® IP Verso | 320 x 214 pixelů | MPEG4 / H264: Baseline profil, level max. 5.2 |
Metoda DELETE
Parametr | Popis |
|---|---|
display | Povinný identifikátor displeje. Hodnota je nastavena v parametru Hardware / Rozšiřující moduly / Jméno modulu. Případně lze zjistit hodnotu pomocí funkce /api/display/caps. |
Příklad:
|
2N® IP Vario
Funkce /api/display/image umožňuje modifikovat obsah zobrazovaný na displeji zařízení. Umožňuje nahrát, příp. nahraný obrázek z displeje odstranit.
Funkce je součástí služby Displej a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Displej (řízení).
Pro tuto funkci lze použít metody PUT nebo DELETE. Metoda PUT slouží k uploadu obrázku na displej. Metoda DELETE slouží k odstranění dříve uploadovaného obrázku z displeje.
Parametry požadavku:
Parametr | Popis |
|---|---|
display | Povinný identifikátor displeje (internal) |
blob-image | Povinný parametr obsahující obrázek v podporovaném formátu s rozlišením daného displeje (viz funkce /api/display/caps). Parametr se uplatní pouze v případě metody PUT. |
Odpověď je ve formátu application/json a neobsahuje žádné parametry.
Parametry obrázku:
Model | Rozměry obrázku | Podporované formáty |
|---|---|---|
| 2N® IP Vario | 320 x 240 pixelů | JPEG (doporučeno), GIF, BMP |
Upozornění
Podporovaný JPEG formát je JPEG Baseline (neprogresivní kódování).