Integrace RichPear Home
RESTful
RESTful vytváří senzory a binární senzory z HTTP endpointů. Hodí se pro zařízení nebo služby, které poskytují data přes REST API.
- Doména
rest- Kategorie
- Binární senzory, Senzory
- Komunikace
- lokální dotazování
- Nastavení
- ruční konfigurace
Co návod pokrývá
Návod popisuje praktické zapojení integrace RESTful 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
- Použití šablon
Příprava
Připravte URL endpointu, metodu, případné hlavičky, ověření a strukturu odpovědi. Ověřte odpověď mimo RichPear Home například v terminálu nebo API klientu.
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 RESTful senzor v konfiguraci, určete endpoint a šablonu pro vytažení hodnoty. Po restartu ověřte stav entity a chování při nedostupném API.
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.
Šablony
Šablonu pište tak, aby zvládla chybějící pole nebo prázdnou odpověď. Při změně API má senzor raději ukazovat nedostupnost než špatnou hodnotu.
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.
Interval dotazování
Nenastavujte příliš časté dotazování. Respektujte limity služby a zvažte, jak rychle se hodnota reálně mění.
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čnost
Tokeny ukládejte do tajných proměnných a endpoint nevystavujte veřejně bez ochrany. U citlivých dat nepoužívejte nezabezpečené HTTP přes internet.
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 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.