Integracja z Shelly

W DOMIQ jesteśmy zwolennikami kablowych instalacji automatyki budynkowej, które oferują bardzo dużą niezawodność transmisji danych.

Są jednak sytuacje, gdzie nie ma już możliwości połozenia instalacji kablowej. Wychodząc na przeciw tym potrzebom zdecydowaliśmy się dodać integrację urządzeń Shelly w DOMIQ.

1. Komunikacja #

Urządzenia Shelly umożliwiają integrację z użyciem API HTTP oraz MQTT. W związku z tym, że API HTTP wymaga stałego odpytywania o bieżący stan urządzeń, postanowiliśmy postawić na standard MQTT, który zapewnia w pełni dwukierunkową komunikację.

Na potrzeby integracji z Shelly wykonaliśmy własną implementację brokera MQTT. W obecnej formie nasz broker MQTT spełnia część (nie jest jeszcze w pełni kompatybilny) ze standardem MQTT 3.1.1. Na tym etapie obsługuje komunikację z QoS równym 0 i wymaga ustawienia opcji Clean Session dla każdego połączenia. Więcej informacji o standardzie MQTT można znaleźć w Internecie.

1. Konfiguracja #

Pierwszym etapem integracji jest prawidłowa konfguracja modułów Shelly.

1.2. Ustawienia sieci #

Wszystkie moduły Shelly fabrycznie startują w trybie Access Point – zatem każdy moduł tworzy swoją lokalną sieć WiFi. Piewszym krokiem jest zmiana ustawień sieciowych modułu, aby łączył się on z Twoją lokalną siecią WiFi.

1. Podłącz się do sieci utworzonej przez moduł Shelly.
2. Otwórz interfejs konfguracyjny modułu – wpisz jego domyślny adres IP (patrz instrukcja obsługi Shelly) w polu adresu przeglądarki.
3. W sekcji Networks lub Internet & Security wprowadź ustawienia umożliwiające podłączenie modułu do twojej lokalnej sieci WiFi. Zalecamy ustawienie statycznego adresu IP lub utworzenie przypisania adresu IP do adresu MAC karty sieciowej (należy to wykonać w ustawieniach routera).
4. Po zapisaniu ustawień otwórz ponownie interfejs konfguracyjny Shelly, ale z wykorzystaniem już przypisanego adresu IP w Twojej sieci lokalnej.

1.3. Ustawienia MQTT #

Następnym etapem jest skonfgurowanie ustawień serwera MQTT, do którego moduł Shelly będzie się podłączał. Opis konfguracji dotyczy interfejsu Shelly. Konfguracja nieco różni się dla urządzeń Shelly 1 i 2 generacji, dlatego opiszemy te procesy osobno.

Urządzenia generacji 1

1. Zakładka Internet & Security -> Advanced – Developer Settings.
2. Zaznacz opcję Enable MQTT.
3. Uzupełnij następujące pola formularza:
   • Server – Wpisz adres IP modułu Base oraz domyślny nr portu dla komunikacji MQTT, czyli 1883. Przykład: 192.168.1.100:1883
   • Zaznacz opcję Use custom MQTT prefx i w polu poniżej wpisz nazwę modułu Shelly. Nazwa musi być unikalna dla całej instalacji!
   • Zaznacz opcję Clean Session.
   • Upewnij się, że opcja Max QoS ma wartość 0.
4. Następnie kliknij przycisk Save, aby zapisać konfgurację. Do zatwierdzenia ustawień wymagany jest restart urządzenia, o czym poinformuje Cię interfejs Shelly.
5. Konfguracja modułu zakończona.

Urządzenia generacji 2

1. Zakładka Networks -> Mqtt.
2. Włącz opcję Enable.
3. Uzupełnij następnie pola formularza:
   • Connection type: MQTT
   • W następnym polu wpisz nazwę modułu Shelly. Nazwa musi być unikalna dla całej instalacji!
   • Włącz opcję RPC status notifcations over MQTT.
   • W polu tekstowym poniżej wpisz adres IP modułu Base oraz domyślny nr portu dla komunikacji MQTT, czyli 1883 Przykład: 192.168.1.100:1883
4. Kliknij Apply aby zatwierdzić ustawienia.
5. Konfguracja modułu zakończona

1.4. Pozostałe ustawienia #

Na tym etapie moduł Shelly jest gotowy do integracji z DOMIQ/Base. Pozostałe ustawienia modułu np. rodzaj używanych wejść, harmonogramy i inne skonfguruj wg potrzeb.

3. Konfguracja modułu DOMIQ/Base #

W konfguratorze modułu Base, w zakładce Ustawienia włącz opcje: MQTT oraz Shelly. Następnie zapisz zakładkę Ustawienia i zrestartuj moduł.

Po restarcie Base jest gotowy do obsługi urządzeń Shelly. Moduły Shelly automatycznie podłączą się do Base – żadne dodatkowe działania nie są wymagane. Parametry odczytane z modułów Shelly automatycznie pojawią się w zakładce Stan.

4. Sterowanie i odczyt stanu #

Jak już wspomnieliśmy wczesniej, moduły Shelly dzielą się na moduły pierwszej i drugiej generacji. Oprócz róznic sprzętowych, różnią się także protokołem integracyjnym. Protokół modułów generacji 2 został ujednolicony dlawszystkich urządzeń, podczas gdy urządzenia pierwszej generacji dość mocno różnią się między sobą pod względem parametrów, które można odczytać, a także komend, które można wysyłać do modułów. Opis obsługi modułów obu generacji podzieliliśmy na opis poszczególnych urządzeń.

4.1. Uwagi ogólne #

• Wszystkie zaprezentowane komendy oraz identyfkatory do odczytu stanu są uogólnioną formą zapisu zawierającą fragmenty, które należy zastąpić danymi dotyczącymi konkretnego modułu Shelly. Są one ujęte w nawiasy ostre – <dowolna_nazwa>.
  Przykład: SHELLY.<nazwa>.relay.<0-1>=<komenda>.
• Numeracja przekaźników w Shelly zaczyna się od 0. Zatem gdy moduł posiada tylko jeden przekaźnik, wówczas jego indeks to 0.
• Analogicznie przedstawia się numeracja wejść binarnych. Wejścia binarne umożliwiąją podłączenie tradycyjnych łączników oświetleniowych (również dzwonkowych), a także innych urządzeń, które są w stanie zwierać styki wejścia.

W module Base zaimplementowaliśmy obsługę następujących urządzeń Shelly.

Generacja 1:

1. 1/1PM/1L
2. 2/2.5
3. Plug/PlugS
4. Dimmer 1/2
5. RGBW2 (tylko tryb White)
6. Uni
7. TRV
8. Vintage
9. H&T
10. Smoke
11. Flood
12. Door/Window 1/2
13. Motion
14. Sense
15. Button1
16. I3
17. Gas
18. EM
19. 3EM

Generacja 2:

1. Plus 1/1 PM
2. Plus 2 PM
3. Plus I4
4. Pro 1/1 PM
5. Pro 2/2 PM
6. Pro 4 PM

4.2. Generacja 1: #

4.2.1. 1/1PM/1L #

Moduł wykonawczy wyposażony w 1 przekaźnik oraz 1 wejście przyciskowe. Wersja PM wyposażona jest w pomiar mocy i raportowanie zużycia energii.

4.2.2. 2.5 #

Moduł wyposażony w dwa przekaźniki z pomiarem mocy i dwa wejścia binarne. Może pracować w trybie roletowym lub jako dwa niezależne przekaźniki.

Tryb roletowy

Tryb przekaźnikowy

4.2.3. Plug/PlugS #

Sterowane gniazdko z pomiarem mocy.

4.2.4. Dimmer 1/2 #

Moduł do sterowania oświetleniem z opcją ściemniania. Moduł wyposażony jest także w wejście binarne.

• C.SHELLY.salonsufit.light.0=100;ramp:3
  Włącz światło o nazwie salonsufit na 100%. Zostanie użyty czas przejścia równy 3 sekundy.

4.2.5. RGBW2 (tylko tryb White) #

Czterokanałowy moduł do sterowania oświetleniem LED (12/24V). Każdy kanał może być sterowany niezależnie. Ponadto moduł wyposażony w pojedyncze wejście binarne.

4.2.6. Uni #

Moduł z dwoma wejściami binarnymi oraz dwoma wyjściami bezpotencjałowymi.

4.2.7. TRV #

Zawór termostatyczny do ogrzewania.

4.2.8. Vintage #

Ściemnialna żarówka LED.

4.2.9. H&T #

Bezprzewodowy czujnik temperatury i wilgotności powietrza.

4.2.10. Smoke #

Bezprzewodowy czujnik dymu.

4.2.11. Flood #

Bezprzewodowy czujnik zalania.

4.2.12. Door/Window 1/2 #

Bezprzewodowy czujnik otwarcia drzwi/okna z pomiarem nasłonecznienia i detekcją ruchu (pomiar wibracji).

4.2.13. Motion #

Bezprzewodowy czujnik ruchu z pomiarem nasłonecznienia.

4.2.14. Sense #

Bezprzewodowe urządzenie pomiarowe wyposażone w czujniki: temperatury, wilgotności, nasłonecznienia, detektor ruchu. Ponadto umożliwia emitowanie kodów IR do dowolnych urządzeń multimedialnych. Emisja kodów IR nie jest dostępna poprzez integrację protokołem MQTT, natomiast dostępna jest przez aplikację Shelly, API HTTP lub interfejs konfguracyjny urządzenia.

4.2.15. Button1 #

Bezprzewodowy przycisk rozróżniający 4 rodzaje naciśnięć: krótkie, 2x krótkie, 3x krótkie, długie. Czas reakcji przycisku w trybie bateryjnym wynosi około 2s oraz około 100ms w trybie zasilania przez USB.

4.2.16. i3 #

Trzykanałowy moduł wejść binarnych z detekcją różnych typów naciśniecia przycisków.

4.2.17. Gas #

Detektor gazu LPG lub CNG.

4.2.18. EM #

Dwukanałowy licznik energii. Moduł wyposażony jest także w pojedyncze wyjście niskoprądowe.

4.2.19. 3EM #

Trójfazowy licznik energii elektrycznej.

4.3. Generacja 2: #

Seria „Plus” #

Moduły w serii Plus to moduły dopuszkowe drugiej generacji.

4.3.1. Plus 1/1 PM #

Moduł dopuszkowy wyposażony w pojedynczy przekaźnik oraz wejście binarne. Moduł 1 PM dodatkowo wyposażony jest licznik energii.

• C.SHELLY.test.relay.0=on;flip:0.1
  Przekaźnik zostanie włączony na 100ms.
• C.SHELLY.test.relay.0=0;flip:2
  Przekaźnik zostanie wyłączony na 2 sekundy.

4.3.2. Plus 2 PM #

Moduł wyposażony w dwa przekaźniki z pomiarem mocy i dwa wejścia binarne. Może pracować w trybie roletowym lub jako dwa niezależne przekaźniki.

Tryb roletowy

Tryb przekaźnikowy

• C.SHELLY.test.relay.0=on;flip:0.1
  Przekaźnik zostanie włączony na 100ms.
• C.SHELLY.test.relay.0=0;flip:2
  Przekaźnik zostanie wyłączony na 2 sekundy.

4.3.3. l4 #

Moduł czterech wejść binarnych.

Seria modułów „Pro” #

Moduły z serii Pro przeznaczone są do montażu w szafach rozdzielczych. Wyposażone są w łączność bezprzewodową WiFi oraz złącze Ethernet.

4.3.4. Pro 1/Pro 1PM #

Moduł rozdzielnicowy wyposażony w jeden przekaźnik oraz dwa wejścia binarne. Wersja PM ponadto wyposażona w licznik energii elektrycznej.

• C.SHELLY.test.relay.0=on;flip:0.1
  Przekaźnik zostanie włączony na 100ms.
• C.SHELLY.test.relay.0=0;flip:2
  Przekaźnik zostanie wyłączony na 2 sekundy.

4.3.5. Pro 2 #

Moduł rozdzielnicowy wyposażony w dwa przekaźniki i dwa wejścia binarne.

4.3.6. Pro 2 PM #

Moduł rozdzielnicowy wyposażony w dwa przekaźniki z pomiarem mocy i dwa wejścia binarne. Może pracować w trybie roletowym lub jako dwa niezależne przekaźniki.

Opis komend, stanu i zdarzeń jest identyczny jak dla modułu Plus 2 PM.

4.3.7. Pro 4 PM #

Moduł rozdzielniczowy wyposażony w cztery przekaźniki i cztery wejścia binarne. Każdy przekaźnik ma także licznik energii elektrycznej.

Opis komend, stanu i zdarzeń jest identyczny jak dla modułu Plus 1/1 PM, z tą różnicą, że zakres numeracji przekaźników i wejść jest od 0-3.