Natywna integracja z Home Assistant (komponent) 2.0

Oto jest! Nowa, jeszcze bardziej funkcjonalna i prostsza w instalacji i konfiguracji wersja integracji z Home Assistant! 🔥🔥🔥
Do pobrania z: https://github.com/dgtal1/extalife_custom_component/releases/tag/2.0

Postanowiłem przeskoczyć od razu z wersji 1.1 na wersję 2.0, bo zmian w środku jest na prawdę dużo. Jest i dużo nowości. O tym poniżej.

Ogólny opis rozwiązania, lista obsługiwane moduły Exta Life jest taki sam jak dla starszej wersji 1.1 i jest dostępny pod tym linkiem.

Nowa funkcjonalność w wersji 2.0:

• integracja obsługuje teraz konfigurację z GUI! (ekran integracji HA). Należy wyszukać na liście integracji pozycję 'Exta Life' i postępować zgodnie z kreatorem krok po kroku.
  Dodałem wsparcie dla logo Exta Life! teraz w jakimkolwiek miejscu w HA, gdzie występuje lista integracji - zobaczycie znajome logo Exta Life Tym samym zrobiłem pierwszy swój commit na GitHub'ie projektu HA Gdybyście tylko wiedzieli jak uzyskałem logo w wysokiej rozdzielczości dla HA, aby ładnie się skalowało…To był wyczyn
  
  
  
  
  Jest możliwość dodania integracji wyłącznie z GUI (np "czysta" instalacja HA), ale nie zapomniałem także o tych, którzy woleliby niczego nie zmieniać w swoich instalacjach HA, więc przygotowałem kod migrujący konfiguracje integracji z pliku configuration.yaml do GUI. Migracja dokona się automatycznie podczas startu HA. Po uruchomieniu HA integracja będzie widoczna w ekranie ‘Integracje’.
  
  Generalnie planuję porzucić konfigurację poprzez plik configuration.yaml w przyszłości zgodnie z wytycznymi architektów HA. Integracje mają być konfigurowane z GUI, gdyż to pozwala lepiej i łatwiej nimi zarządzać. Ale na razie będzie, aby dać czas na oswojenie się z konfiguracją GUI.
  
  
• Możliwe jest usunięcie integracji "w locie" w trakcie działania HA bez konieczności restartu! To funkcja, która jest możliwa dla integracji dodawanych z GUI lub ogólnie poprzez tzw. Config Entry, które tworzy się z GUI lub poprzez kod migrując konfigurację z pliku configuration.yaml. Należy jednak pamiętać, że jeśli nie usuniecie wpisu 'extalife' z pliku configuration.yaml, to integracja pojawi się ponownie po restarcie.
  
  
• Dzięki konfiguracji z GUI możliwe jest teraz dodanie integracji Exta Life wielokrotnie i dzięki temu połączyć HA z dowolną liczbą kontrolerów EFC-01 (warunek: różne adresy IP kontrolerów oraz różne adresy MAC widziane przez serwer HA - do zrealizowania przez VPN). Mający Exta Life w pracy i domu na pewno docenią tą możliwość
  
  
• dodałem obsługę konfiguracji integracji poprzez tak zwane Opcje (strona Integracje> Exta Life> Opcje, aby precyzyjnie dostosować zachowanie integracji do potrzeb użytkownika. Opcje zdefiniowane w pliku configuration.yaml automatycznie zmigrują się do GUI.
  Zaimplementowane opcje są tymi samymi, co w wersji 1.1: mapowanie na światło na podstawie ikony (znaczenie numerów można sprawdzić tutaj), odwrócone sterowanie roletą - suwak w GUI HA nadal będzie działał tak jak w aplikacji Exta Life; niestety przyciski góra dół nadal będą działać nieprawidłowo w położeniach skrajnych.
  Zmiany niektórych opcji (np mapowanie switch na light) wymagają restartu HA, aby przynieść oczekiwany efekt.
  
  
• Dodałem obsługę Rejestru urządzeń (Device Registry) - można teraz zobaczyć wszystkie urządzenia Exta Life (!) i powiazane z nimi encje na ekranie 'Urządzenia' w HA. Zobaczycie tam także kontroler EFC-01 oraz wszystkie nadajniki Exta Life!
  
  
• Dodałem obsługę Automatyzacji urządzeń (typ wyzwalacza/warunku/akcji ‘Urządzenie’)! Można teraz tworzyć nowe automatyzacje bardzo łatwo dzięki zdarzeniom i działaniom dla danego urządzenia! Nie potrzeba już znać technicznych nazw encji oraz wywoływać usług (services) dla danego urządzenia do stworzenia automatyzacji. Wszystko jest reprezentowane czytelnie i zrozumiale w HA. Nowi i niezaznajomieni użytkownicy HA na pewno docenią tą funkcjonalność. Bariera wejścia w HA znacznie się obniża dzięki temu.
  Zachęcam Was do zdefiniowania sobie w ten sposób automatyzacji
  
  
  
• dodałem obsługę kontrolera EFC-01 w ekranie Urządzenia (Device Registry)! Kontroler posiada teraz swoją własną encję, dzięki której można monitorować jego dostępność (stany: ready oraz unavailable).
  Poza stanem można monitorować wersję softu kontrolera, jego IP oraz MAC.
  Nazwa encji kontrolera widoczna będzie w ekranie ‘Urządzenia’ (Device Registry) i zaczyna się od ‘extalife.’ a po kropce nazwa encji zależna jest od nazwy zdefiniowanej w samym kontrolerze. Domyślnie: extalife.efc_01
  
  
• Dodałem - wieloktrotnie już wspominaną - obsługę automatyzacji wywoływanych poprzez sygnały z nadajników Exta Life! Wyobraźcie sobie np uruchomienie odkurzacza w zadanej strefie poprzez przyciśnięcie przycisku na pilocie Exta Life, albo sterowanie różnymi rzeczami poprzez jeden łącznik RNP-21 uruchamiając różne rzeczy lub sceny w zależności od tego czy przyciśniemy raz, czy dwa czy przytrzymamy? Fantastyczna wizja, nieprawdaż?
  
  Możliwe będzie w HA zareagowanie na następujące zdarzenia z nadajnika: wciśnięcie przycisku, puszczenie przycisku, dwuklik(!), trójklik(!), przytrzymanie klawisza na dłużej(!) (*)
  
  Przykład dla RNP-21:
  
  
• EDIT 03.08.2020:
  W wersji 2.0b2 dodałem dzięki koledze @rampler wsparcie dla klocków Exta Free obsługiwanych przez kontroler EFC-01. Są to: ROP-01, ROP-02, ROM-01, ROM-10, ROP-05, ROP-06, ROP-07, ROB-01, SRP-02, RDP-01, RDP-02, RDP-11, SRP-03.
  Elementy te z racji jednokierunkowej transmisji reprezentowane są w GUI HA przez 2 przyciski do włączania i wyłączania osobno i działają w oparciu o stan tzw assumed state czyli założoną wartość stanu elementu. Po włączeniu w GUI stan zmienia się zawsze na włączony a po wyłączeniu na wyłączony. Kontroler nie jest w stanie sprawdzić prawdziwego stanu elementu.
  UWAGA: Kontroler oferuje sterowanie jedynie na zasadzie włącz/wyłącz nawet dla ściemniacza RDP-11 mimo, że w aplikacji da się wybierać kolor, to aplikacja i tak wysyła jedynie komendy załączania i wyłączania. Tak samo robi integracja HA.
  

(*) - obsługa reakcji na sygnały z nadajników przekazywane przez kontroler została dodana testowo. Funkcja ta została dodana z myślą o przyszłości, gdy Zamel (miejmy nadzieję) doda wsparcie dla sygnałów z nadajników w aplikacji Exta Life, i co za tym idzie - do integracji. Mam na prawdę nadzieję, że firma Zamel stanie na wysokości zadania i doda wsparcie, szczególnie gdy deklarowała, że integracje z innymi systemami traktuje poważnie.
Obecnie możliwe jest zdefiniowanie automatyzacji typu ‘Urządzenie’, wybranie nadajnika, który ma być wyzwalaczem dla automatyzacji oraz wybranie zdarzenia: wciśnięcie przycisku, puszczenie przycisku, dwuklik, trójklik, przytrzymanie klawisza na dłużej. Przetestowanie tego jest możliwe poprzez wywołanie testowego serwisu w ekranie Narzędzi deweloperskich


Instalacja i konfiguracja:
1. Wypakować podkatalog extalife z archiwum do katalogu HA config/custom_components. W razie potrzeby stworzyć katalog custom_components, gdy nie istnieje. Po wypakowaniu pliki z kodem (rozszerzenie .py) powinny znajdować się w katalogu HA config/custom_components/extalife

2. W GUI HA w ekranie Integracje odszukać pozycję 'Exta Life' ze znajomym logo i postępować zgodnie z instrukcjami na ekranie. Proste, prawda?
UWAGA: może się zdarzyć, że integracji nie będzie na liście mimo poprawnego wypakowania plików do folderu custom_components. To wina cache'owania w przeglądarce listy integracji. Trzeba wyczyścić cache przeglądarki i odświeżyć stronę HA i integracja powinna pojawić się na liście. Kto instalował u siebie HACS ten wie o co chodzi. A resztę odsyłam do procedury opisanej na stronie HACS, bo jest ona taka sama dla naszej integracji.


3. Integracja została załadowana. W Narzędziach Deweloperkich powinny pojawić się wszystkie encje a w ekranie Urządzenia - wszystkie urządzenia Exta Life włącznie z nadajnikami i kontrolerem EFC-01.


Proszę w tym wątku o wszelkie komentarze z problemami, niedziałającymi funkcjami, wrażeniami, sugestiami itp. Im więcej błędów znajdziemy tym lepiej, bo to pozwoli na stworzenie stabilnego i lepszego softu.
Gotowi do testowania? START! 🟢🏁

Dla chętnych przyłączyć się do pracy nad tą integracją deweloperów - oto link do repozytorium Github.

---

ROADMAP:
Plany na kolejne wersje:
2.1:
- przebudować integrację tak, aby zużywała tylko jedno połączenie z kontrolerem tak jak aplikacja Exta Life.

Zainstalowane - działa
Uwaga dla tych co instalują na "jolce" - brakuje modułu getmac i trzeba ręcznie doinstalować
pip install getmac

Zainstalowane - działa
Uwaga dla tych co instalują na "jolce" - brakuje modułu getmac i trzeba ręcznie doinstalować

Kod: [Zaznacz]

pip install getmac

To możliwe, że zespół Jolki nie dostarcza pewnych komponentów, które są dystrybuowane z "oryginalnym" HA. Niestety ten komponent do ustalania MAC jest bardzo potrzebny z kilku względów. Może się okazać konieczne doinstalowywanie go po każdym upgrade Jolki, ale na 100% nie wiem bo nie wiem jak jest zrobiona Jolka. Jeśli na "gołym" Pythonie ew. Python Virtual Environment to może nie i moduły będą zostawały.

Nie wiedziałem, że wyprowadziłeś się z HA do Jolki. Przytulniej?

PS. Czy masz jakieś nadajniki w swojej instalacji? Ja spostrzegłem dopiero teraz, że na moim produkcyjnym HA brakuje mi nadajników w urządzeniach, mimo, że na testowym i deweloperskim są i nie wiem z czego to wynika. Czy u ciebie są na liście urządzeń?

@WSZYSCY: Czy ktoś ma nadajniki Exta Life? Czy ukazały się na liście urządzeń integracji Exta Life?

Mam nadajniki i też ich nie widać.
Druga sprawa, jedna z głowice termo została wykryta ale cały czas mam status "niedostępny"
w logach znalazłem:
Error doing job: Task exception was never retrieved

Traceback (most recent call last):
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/__init__.py", line 302, in async_update
    channels = await self._hass.async_add_executor_job(self.controller.get_channels)
  File "/data/data/pl.sviete.dom/files/usr/lib/python3.7/concurrent/futures/thread.py", line 57, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 320, in get_channels
    resp = self.tcp.exec_command(cmd, None, 1.5)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 678, in exec_command
    resp = self._exec_command(command, data, timeout)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 729, in _exec_command
    resp_js = self._tcp_to_json(resp, command)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 633, in _tcp_to_json
    if data[-1] == chr(3):
IndexError: string index out of range


EDIT1
temat drugiej głowicy nieaktualny - mój błąd 
EDIT2
dwa moje RNK-24 też się pojawiły 
EDIT3
Po restarcie kontrolera zamela i bramki jolki już ten błąd co wyżej się nie pojawił i wszystko wydaje się być ok 

Coś pięknego, BRAWO admin!

Mam nadajniki i też ich nie widać.
Druga sprawa, jedna z głowice termo została wykryta ale cały czas mam status "niedostępny"
w logach znalazłem:

Kod: [Zaznacz]

Error doing job: Task exception was never retrieved

Traceback (most recent call last):
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/__init__.py", line 302, in async_update
    channels = await self._hass.async_add_executor_job(self.controller.get_channels)
  File "/data/data/pl.sviete.dom/files/usr/lib/python3.7/concurrent/futures/thread.py", line 57, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 320, in get_channels
    resp = self.tcp.exec_command(cmd, None, 1.5)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 678, in exec_command
    resp = self._exec_command(command, data, timeout)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 729, in _exec_command
    resp_js = self._tcp_to_json(resp, command)
  File "/data/data/pl.sviete.dom/files/home/AIS/custom_components/extalife/pyextalife.py", line 633, in _tcp_to_json
    if data[-1] == chr(3):
IndexError: string index out of range


EDIT1
temat drugiej głowicy nieaktualny - mój błąd 
EDIT2
dwa moje RNK-24 też się pojawiły 
EDIT3
Po restarcie kontrolera zamela i bramki jolki już ten błąd co wyżej się nie pojawił i wszystko wydaje się być ok 

No to super, że wszystko działa. Ten błąd z loga pojawia się bardzo sporadycznie u niektórych. Na razie nie udało mi się namierzyć co może być problemem, bo wygląda jak błąd kontrolera. U mnie to nigdy nie wystąpiło. Gdyby się powtarzał to daj znać.

Coś pięknego, BRAWO admin!

Dzięki ale będziemy bić brawo jak wszystko po dłuższym czasie będzie działało. Myślę, że tak będzie, ale jeszcze trzeba trochę potestować. Mnie zastanawia dlaczego nie mam nadajników na produkcyjnym HA a na 2 innych są. Coś tam może gdzieś jest nie tak, więc jeszcze się trzeba przyglądać tej wersji, ale myślę, że generalnie jest dobrze
Czy u ciebie są nadajniki widoczne na liście?

A i taka generalna uwaga - jutro zaczynam wakacje i wyjeżdzam, więc przez kolejne 2 tygodnie nie będę w stanie grzebnąć w razie potrzeby w kodzie. Jeśli będą jakieś poważne problemy i restart nie pomoże to zalecam cofnięcie do 1.1 a jak wrócę to popatrzę na nową wersję.

Uruchomione na szybko i od strzału w HA testowym (docker w Linux). Wszystkie moje urządzenia zintegrowane, nadajniki RNK widoczne wraz z czujnika temperatury. Statusy również OK.

Uruchomione na szybko i od strzału w HA testowym (docker w Linux). Wszystkie moje urządzenia zintegrowane, nadajniki RNK widoczne wraz z czujnika temperatury. Statusy również OK.

I oby tak dalej. Dzięki za testowanie panowie👍

Nadajniki RNK widoczne na liście encji. W oknie "przegląd" już ich nie widać. Chyba, że są przypisane do jakiegoś odbiornika. Jeśli są jako wyzwalacz sceny lub jak u mnie bez przypisania, to na liście przełączników ich nie ma.

Nadajniki RNK widoczne na liście encji. W oknie "przegląd" już ich nie widać. Chyba, że są przypisane do jakiegoś odbiornika. Jeśli są jako wyzwalacz sceny lub jak u mnie bez przypisania, to na liście przełączników ich nie ma.

Nadajniki nie mają encji. Są reprezentowane wyłącznie przez urządzenia. W zasadzie nie ma sensu aby miały encje, gdyż ich stany zmieniają się tylko impulsowo. Nie ma też odpowiedniej platformy w HA aby je reprezentować (nazwa encji no transmitter.xxx). Można zrobić swoją, ale za bardzo nie ma sensu. W innych podobnych integracjach w HA (np ZHA, ZigBee) jest tak samo. Nadajniki są tylko urządzeniami, za to wspierają Device Automations, dzięki którym można reagować na sygnały z nich. Kontrolery ZigBee umożliwiają notyfikację z nadajników. Czekamy aż Zamel zrobi to samo w EFC-01

Nadajniki nie mają encji. Są reprezentowane wyłącznie przez urządzenia. W zasadzie nie ma sensu aby miały encje, gdyż ich stany zmieniają się tylko impulsowo. Nie ma też odpowiedniej platformy w HA aby je reprezentować (nazwa encji no transmitter.xxx). Można zrobić swoją, ale za bardzo nie ma sensu. W innych podobnych integracjach w HA (np ZHA, ZigBee) jest tak samo. Nadajniki są tylko urządzeniami, za to wspierają Device Automations, dzięki którym można reagować na sygnały z nich. Kontrolery ZigBee umożliwiają notyfikację z nadajników. Czekamy aż Zamel zrobi to samo w EFC-01

Dzięki za wyjaśnienie. W takim razie cieszę się, że prawidłowo się zintegrowały.

Tworząc automatyzację wybieram akcja -> urządzenie -> otwieram listę urządzeń i mam mnóstwo odbiorników ROP-22
Nie ma informacji o tym jakie jest ID czy encja urządzenia. Dopiero po wybraniu widać, po możliwych do zdefiniowaniach akcjach, z którym ROP`em mamy do czynienia.

tak to wygląda w YAML

Tworząc automatyzację wybieram akcja -> urządzenie -> otwieram listę urządzeń i mam mnóstwo odbiorników ROP-22
Nie ma informacji o tym jakie jest ID czy encja urządzenia. Dopiero po wybraniu widać, po możliwych do zdefiniowaniach akcjach, z którym ROP`em mamy do czynienia.

Tak działa HA. Poniekąd można na to wpłynąć. Możnaby ustawiać inną nazwę urządzenia związana z nazwą nadana w aplikacji Exta Life i myślałem o tym orzd chwilę, ale to nie jest dobry pomysł bo nazwa dotyczy kanału czyli encji, a zależność między urządzeniem a encja to 1:n czyli nie pasuje. To faktycznie może być mylące, ale rozwiązanie jest bardzo proste: zmienić nazwy urządzeń w HA na bardziej adekwatne i czytelne dla użytkownika czyli siebie🙂 I wtedy definiując automatyzację będzie już prosto określić z czym mamy do czynienia. Zauważ że w aplikacji Exta Life jest analogicznie, także w integracji Z-Wave prawdopodobnie z tego samego powodu (n encji dla 1 urządzenia, a jazda encja ma swoją nazwę)