Integrace RichPear Home

RESTful binary sensor

RESTful binary sensor vytváří binární stav z HTTP endpointu. Hodí se pro jednoduché API, které vrací zapnuto/vypnuto, dostupnost, alarm nebo jiný dvoustavový údaj.

Doména
rest
Kategorie
Binární senzory
Komunikace
lokální dotazování
Nastavení
ruční konfigurace
00

Co návod pokrývá

Návod popisuje praktické zapojení integrace RESTful binary sensor 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

  1. Nastavení
  2. Použití šablon
  3. Příklady
  4. aREST senzor
  5. Přístup k endpointu chráněnému ověřením
01

Příprava

Připravte URL endpointu, metodu, případné hlavičky a ověření. Odpověď API si nejdřív otestujte mimo RichPear Home a určete, která hodnota znamená aktivní stav.

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.

02

Nastavení v RichPear Home

Nastavte binární senzor v konfiguraci a použijte šablonu pro převod odpovědi na pravda/nepravda. Po restartu ověřte stav při obou reálných situacích.

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.

03

Šablony

Šablona musí zvládnout prázdnou odpověď, chybu API i změnu datového typu. Lepší je vrátit nedostupnost než falešný aktivní alarm.

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.

04

Ověření endpointu

U endpointu s heslem nebo tokenem ukládejte citlivé údaje do tajných proměnných. Neposílejte tokeny v URL, pokud endpoint podporuje bezpečnější hlavičku.

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.

05

Použití

Binární REST senzor používejte pro přehled nebo podmínky automatizací. Kritickou fyzickou akci doplňte dalším nezávislým potvrzením.

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.

99

Kontrola po nasazení

Po nastavení integrace RESTful binary sensor 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.