Integrace RichPear Home
RESTful Sensor
RESTful Sensor načítá číselné nebo textové hodnoty z HTTP endpointů. Je vhodný pro API zařízení, lokální monitoring nebo jednoduché cloudové služby.
- Doména
rest- Kategorie
- Senzory
- Komunikace
- lokální dotazování
- Nastavení
- ruční konfigurace
Co návod pokrývá
Návod popisuje praktické zapojení integrace RESTful 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
- Použití šablon
- Aktualizace dat
- Příklady
- Externí IP adresa
- Jedna hodnota z lokální instance Glances
- Hodnota z jiné instance RichPear Home
Příprava
Připravte endpoint, interval dotazování a šablonu pro hodnotu. Zkontrolujte, zda API vrací JSON, text nebo jiný formát a jak se chová při 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 senzor v konfiguraci, určete šablonu hodnoty a případné atributy. Po restartu ověřte jednotky, dostupnost a obnovovací interval.
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.
Více atributů
Z JSON odpovědi můžete vytáhnout hlavní hodnotu a doplňkové atributy. Hlavní stav držte jednoduchý, atributy použijte pro detail.
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.
Aktualizace dat
Interval nastavte podle rychlosti změny hodnoty. API pro počasí nebo verzi stačí dotazovat méně často než lokální výkonový údaj.
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 bezpečnost
Tokeny ukládejte do tajných proměnných. U externích API sledujte limity a nepoužívejte nezabezpečené HTTP přes internet pro citlivá data.
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 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.