Webservices

Podrobnější informace o rozhraní API

VŠEOBECNÉ

• Příkazy webové služby podporují interní i externí přístup.
• Současný Miniserver podporuje také protokol HTTPS.

Struktura příkazu webové služby je následující:

http://user:password@IPAddressMiniserver/command/control/value

Z bezpečnostních důvodů se při použití protokolu HTTP (Miniserver Gen.1) doporučuje při zadávání příkazu do adresního řádku vynechat přístupové údaje. Místo toho vás prohlížeč vyzve k zadání přihlašovacích údajů v samostatném okně.

Některé příkazy vyžadují uživatele s plným přístupem.

Po provedení příkazu se výsledek zobrazí v prohlížeči.

Následující příkaz například zjistí aktuální verzi softwaru Miniserveru:

Pokud je příkaz úspěšný, odpověď bude obsahovat stavový kód „200“, který znamená, že požadavek byl přijat a zpracován.

Struktura v detailu

• control: může být jakýkoli vstup nebo výstup, skutečný nebo virtuální. Výstupy lze použít pouze pro stavové požadavky.
• value: pokud není k dispozici ‚value‘, je vrácena aktuální hodnota ovládacího prvku.
  • Pro digitální hodnoty jsou povoleny následující hodnoty:
    • „Ein„, „On„, „Aus„, „Off„, „1„, „0„, „Impuls“ nebo „Pulse„.
• Virtuální digitální vstupy se 2 výstupy (nahoru-dolů, vlevo-vpravo, počínaje verzí 1.5.4.16), jsou povoleny tyto hodnoty.

• • Pro analogové vstupy jsou povoleny následující hodnoty:
    • (0-10V) vstupy pracují v rozsahu 0 až 10.00.
    • Neexistuje žádné formální omezení (např. platí teploty 21.5 nebo -5.2).
    • Jako desetinný oddělovač se používá tečka (.).
  • Pro textové vstupy jsou povoleny následující hodnoty:
    • Miniserver pracuje s UTF-8, takže všechny znaky podporované UTF-8 by měly fungovat správně.

Příklad – Pulse Input

Před odesláním impulsu do systému potřebuje váš Miniserver virtuální vstup, který příkaz přijme.

Jakmile máme náš virtuální vstup přidaný a uložený v Miniserveru, je třeba odeslat příkaz. Níže je uveden příklad aplikace třetí strany*, která do serveru Loxone Miniserver odešle příkaz s impulsem:

V tomto příkladu máme výchozí uživatelské údaje (uživatelské jméno: admin, heslo: admin) a virtuální vstup v příkazu, který má název „Test Input“. Po stisknutí tlačítka ‚Send‘ v aplikaci řetězec pomocí IP adresy vyhledá Miniserver v síti, přihlásí se a poté zpracuje příkaz.

Pokud je příkaz k odeslání přijat, vrátí se odpověď ve formátu XML:

V Loxone Config se také na zlomek sekundy rozsvítí virtuální vstup, pokud je aktivní „Live View“: 

*V těchto příkladech je Postman aplikací třetí strany, která se používá k odesílání příkazů.

STAV A KONTROLA

DOTAZ: STAV OVLÁDACÍHO PRVKU

Status requests via web service are only possible with inputs and outputs and are not possible with function blocks.

PUSH BUTTON

Příklad – Push Button

Před odesláním příkazu do systému potřebuje váš Miniserver funkční blok Push Button, který příkaz přijme.

Jakmile máme Push Button přidaný a uložený v Miniserveru, je třeba odeslat příkaz. Níže je uveden příklad aplikace třetí strany*, která odesílá příkaz „On“ do serveru Loxone Miniserver:

V tomto příkladu máme výchozí uživatelské údaje (uživatelské jméno: admin, heslo: admin) a Push Button v příkazu, který má název ‚Push-Button‘. Po stisknutí tlačítka ‚Send‘ v aplikaci řetězec pomocí IP adresy vyhledá Miniserver v síti, přihlásí se a poté zpracuje příkaz. Poslední část příkazu můžeme změnit na ‚On‘ nebo ‚Off‘ v závislosti na různých situacích.

Pokud je příkaz k odeslání přijat, bude vrácena odpověď ve formátu XML:

Kód „200“ znamená, že příkaz byl přijat a zpracován.

V Loxone rozhraní také uvidíte, že Push Button změní stav v závislosti na tom, jaký příkaz je odeslán (zapnuto/vypnuto).

*V těchto příkladech je Postman aplikací třetí strany, která se používá k odesílání příkazů.

DOTAZ: STATUS CHANGES

Konfigurace Miniserveru, statistiky a příkazy

Následující příkazy poskytují ovládání systému, operace PLC, statistiky sítě a možnosti konfigurace pro Miniserver.

1. Příkazy PLC (Programmable Logic Controller)

Tyto příkazy umožňují sledovat a ovládat systém PLC.

2. Konfigurační příkazy

Tyto příkazy umožňují načíst nebo upravit nastavení Miniserveru.

3. Příkazy pro monitorování systému

Tyto příkazy poskytují informace o výkonu a statistikách systému.

4. ‚Nastavení data a času

Správa nastavení data a času systému.

5. Monitorování úkolů

Získání stavu a vlastností systémových úloh.

6. Ovládání systému a Správa souborů

Tyto příkazy umožňují restartovat Miniserver a spravovat systémové soubory.

7. Systémové protokoly a statistiky

Získání protokolů a systémových dat.

8. Spuštění externí webové služby

Odesílání požadavků na webové služby externím zařízením.

Příkazy pro zařízení

Extensiony

Následující příkazy platí pro Extension.

K jejich spuštění je nutný uživatel s plnými přístupovými právy.

Zařízení Tree a Air

Následující příkazy platí pro konkrétní zařízení Air nebo Tree.

K jejich spuštění je nutný uživatel s plnými přístupovými právy.

Použití webového rozhraní Miniserveru v iFrame

Ve výchozím nastavení Miniserver z bezpečnostních důvodů neumožňuje vložení do iFrame. Chcete-li tuto funkci povolit, musíte ji explicitně povolit pomocí následujícího příkazu webové služby:

http://<miniserver-ip>/dev/sys/allowhttpiframe/1