Integrace RichPear Home
RichPear Home WebSocket API
RichPear Home WebSocket API poskytuje obousměrné spojení pro frontend, aplikace a vlastní nástroje. Hodí se pro živé stavy a řízení systému.
- Doména
websocket_api- Kategorie
- Ostatní
- Komunikace
- podle nastavení integrace
- Nastavení
- ruční konfigurace
Co návod pokrývá
Návod popisuje praktické zapojení integrace RichPear Home WebSocket API 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
- Nastavení
- Sledování aktuálních spojení
Příprava
Připravte ověřený klient, token a bezpečné síťové prostředí. WebSocket API nevystavujte neznámým klientům.
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
API používejte přes zabezpečeného klienta a otestujte přihlášení, odběr událostí a ukončení spojení. Sledujte aktuální aktivní spojení.
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.
Spojení
Dlouho běžící klient musí umět obnovit spojení po restartu systému. Neúspěšné opakované připojování může zbytečně zatěžovat server.
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.
Oprávnění
Token omezte na konkrétního uživatele a účel. Při ztrátě klienta token zneplatněte.
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.
Monitoring
Sledování aktuálních spojení pomáhá najít zapomenuté skripty nebo aplikace, které systém zbytečně zatěžují.
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 RichPear Home WebSocket API 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.