Integrace RichPear Home
RESTful Command
RESTful Command posílá HTTP požadavky na externí zařízení nebo službu. V RichPear Home se používá jako akce pro API, která mění stav nebo spouštějí úlohu.
- Doména
rest_command- Kategorie
- Automatizace
- Komunikace
- lokální doručování událostí
- Nastavení
- ruční konfigurace
Co návod pokrývá
Návod popisuje praktické zapojení integrace RESTful Command v RichPear Home, přípravu zařízení nebo účtu, kontrolu entit a zásady bezpečného použití v automatizacích.
Uživatelé obvykle otevírají systém na http://rphome.local:8123. Pokud tato adresa nefunguje, použijte http://IP-ADRESA:8123.
Hlavní témata
- Příklady
- Základní příklad s metodou PUT a payloadem
- Použití digest ověření
- Použití odpovědi REST příkazu v automatizacích
- Změna payloadu pomocí šablon
- Testování nového REST příkazu
Příprava
Připravte URL, metodu, hlavičky, payload a ověření. Každý požadavek nejdřív otestujte mimo automatizaci, abyste věděli, jak služba odpovídá při úspěchu a chybě.
Nastavení provádějte z účtu správce. Před přidáním si připravte názvy místností, očekávané entity a pravidla, kde se smí integrace používat.
Před prvním testem
Nejdřív ověřte dostupnost účtu, zařízení nebo služby mimo automatizace. Teprve potom zapojujte hodnoty do scén, notifikací nebo řízení domácnosti.
Nastavení v RichPear Home
Nastavte REST příkaz v konfiguraci a zavolejte ho ručně jako akci. Teprve po kontrole odpovědi ho zapojte do automatizace.
Po dokončení nastavení otevřete detail integrace v části Nastavení, Zařízení a služby. Zkontrolujte vytvořená zařízení, pojmenujte je podle skutečného umístění a vypněte entity, které nechcete používat.
Lokální adresa systému
Při práci v místní síti používejte http://rphome.local:8123. Pokud se lokální jméno nepřeloží, otevřete systém přes http://IP-ADRESA:8123.
Payload a šablony
Payload můžete měnit podle stavů entit pomocí šablon. Ošetřete chybějící hodnoty, aby se do API neposlal prázdný nebo neplatný příkaz.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Ověření a odpověď
U digest nebo tokenového ověření ukládejte citlivé údaje mimo veřejnou konfiguraci. Pokud používáte odpověď příkazu v automatizaci, kontrolujte stavový kód i obsah.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Bezpečné akce
REST příkaz může měnit reálné zařízení. U vypínání, otevírání nebo mazání dat přidejte podmínky, prodlevu a případně ruční potvrzení.
Po změně nastavení sledujte reálný stav zařízení nebo služby přímo v RichPear Home. Pokud se hodnota chová jinak, než čekáte, nejdřív opravte zdroj dat a teprve potom automatizaci.
Kontrola po nasazení
Po nastavení integrace RESTful Command sledujte alespoň jeden běžný provozní cyklus. U cloudových služeb počítejte se zpožděním, u lokálních zařízení ověřte chování po restartu routeru, zařízení i RichPear Home.
Do automatizací vkládejte jen hodnoty, které jste viděli v reálném provozu. Důležité akce doplňte podmínkou dostupnosti entity a rozumnou prodlevou, aby jednorázový výpadek nespustil chybnou reakci.
Před předáním běžným uživatelům ověřte názvy entit, práva uživatelů a chování při nedostupnosti služby. U zařízení, která něco fyzicky spínají nebo řídí, ponechte dostupné i ruční ovládání mimo automatizace.
Hotový provozní test
Integrace je připravená pro běžné použití, když se entity aktualizují, názvy odpovídají skutečným zařízením a automatizace mají ošetřený výpadek nebo nedostupný stav.