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.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.00/offWyłącz.
1/onWłącz.
togglePrzełącz.
StanSHELLY.<nazwa>.relay.00-1Aktualny stan przekaźnika.
SHELLY.<nazwa>.input.00-1Aktualny stan wejścia binarnego.
SHELLY.<nazwa>.longpush.00-1Informacja o długim nacisnięciu przycisku.
SHELLY.<nazwa>.relay.0.power
(tylko wersja PM)
dowolna
liczba
Bieżący pobór mocy.
SHELLY.<nazwa>.relay.0.energy
(tylko wersja PM)
dowolna
liczba
Zużycie energii [W/m].
SHELLY.<nazwa>.temperature
(tylko wersja PM)
dowolna
liczba
Wewnętrzna temperatura urządzenia
SHELLY.<nazwa>.overtemperature
(tylko wersja PM)
0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.temperature_status
(tylko wersja PM)
normal/
high/
veryhigh
Status temperatury urządzenia.
SHELLY.<nazwa>.overpower_value
(tylko wersja PM)
dowolna
liczba
Jeżeli jest przeciążenie przekaźnika, ten parametr zawiera informację o ile watów przekroczono limit.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary

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

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.roller.0upW górę.
downW dół.
stopStop.
rcKalibracja rolety.
0-100Ustawienie rolety na określoną pozycję.
100 – pełne otwarcie
0 – pełne zamknięcie
StanSHELLY.<nazwa>.roller.0up/down/
stop
Aktualny stan rolety.
SHELLY.<nazwa>.roller.0.pos0-100Aktualna pozycja rolety. Opcja dostępna tylko po
kalibracji.
Wartość -1 oznacza błędną pozycję (brak kalibracji).
SHELLY.<nazwa>.input.<0-1>0-1Informacja o stanie wejścia binarnego.
SHELLY.<nazwa>.roller.0.powerdowolna
liczba
Bieżący pobór mocy.
SHELLY.<nazwa>.roller.0.energydowolna
liczba
Zużycie energii [W/m].
SHELLY.<nazwa>.temperaturedowolna
liczba
Wewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.overtemperature0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.temperature_statusnormal/
high/
veryhigh
Status temperatury urządzenia.
SHELLY.<nazwa>.voltagedowolna
liczba
Bieżące napięcie modułu.
ZdarzenieE.SHELLY.<nazwa>.reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary

Tryb przekaźnikowy

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.<0-1>0/offWyłącz.
1/onWłącz.
togglePrzełącz.
StanSHELLY.<nazwa>.relay.<0-1>0-1Aktualny stan przekaźnika.
SHELLY.<nazwa>.input.<0-1>0-1Aktualny stan wejścia binarnego.
SHELLY.<nazwa>.longpush.<0-1>0-1Informacja o długim nacisnięciu przycisku.
SHELLY.<nazwa>.relay.<0-1>.power dowolna
liczba
Bieżący pobór mocy.
SHELLY.<nazwa>.relay.<0-1>.energy dowolna
liczba
Zużycie energii [W/m].
SHELLY.<nazwa>.relay.<0-1>.overpower_valuedowolna
liczba
Jeżeli jest przeciążenie przekaźnika, ten parametr zawiera informację o ile watów przekroczono limit.
SHELLY.<nazwa>.temperaturedowolna
liczba
Wewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.overtemperature 0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.temperature_statusnormal/
high/
veryhigh
Status temperatury urządzenia.
SHELLY.<nazwa>.voltagedowolna
liczba
Bieżące napięcie sieciowe modułu.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-1>S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary

4.2.3. Plug/PlugS #

Sterowane gniazdko z pomiarem mocy.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.00/offWyłącz.
1/onWłącz.
togglePrzełącz.
StanSHELLY.<nazwa>.relay.00-1Aktualny stan przekaźnika.
SHELLY.<nazwa>.relay.0.power dowolna
liczba
Bieżący pobór mocy.
SHELLY.<nazwa>.relay.0.energydowolna
liczba
Zużycie energii [W/m].
SHELLY.<nazwa>.temperature dowolna
liczba
Wewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.overtemperature 0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.overpower_valuedowolna
liczba
Jeżeli jest przeciążenie przekaźnika, ten parametr zawiera informację o ile watów przekroczono limit.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.4. Dimmer 1/2 #

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

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.light.00-100Ustawienie określonej jasności.
onWłącz.
offWyłącz.
togglePrzełącz.
<komenda>
;ramp:<rampa>
Wszystkie powyższe komendy z opcją użycia rampy. Rampa określa czas przejścia ze stanu obecnego do zadanego. Maksymalna wartość rampy 5 [s]
StanSHELLY.<nazwa>.light.00-100Wartość wyjścia ściemnianego.
SHELLY.<nazwa>.input.00-1Stan wejścia binarnego.
SHELLY.<nazwa>.longpush.00-1Informacja o długim nacisnięciu przycisku.
SHELLY.<nazwa>.light.0.power dowolna liczbaBieżący pobór mocy.
SHELLY.<nazwa>.light.0.energy dowolna liczbaZużycie energii [W/m].
SHELLY.<nazwa>.temperaturedowolna liczbaWewnętrzna temperatura urządzenia
SHELLY.<nazwa>.overtemperature 0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.overload0-1Informacja o przeciążeniu wyjścia (wtedy wartość 1).
SHELLY.<nazwa>.loaderror0-1Informacja o problemie z wyjściem ściemnialnym (wtedy wartość 1).
SHELLY.<nazwa>.light.0.overpower_valuedowolna liczbaJeżeli jest przeciążenie przekaźnika, ten parametr zawiera informację o ile watów przekroczono limit.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary
  • 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.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.white.<0-3>0-100Ustawienie określonej jasności.
onWłącz.
offWyłącz.
togglePrzełącz.
<komenda>
;ramp:<rampa>
Wszystkie powyższe komendy z opcją użycia rampy. Rampa określa czas przejścia ze stanu obecnego do zadanego. Maksymalna wartość rampy 5 [s]
StanSHELLY.<nazwa>.white.<0-3>0-100Wartość wyjścia ściemnianego.
SHELLY.<nazwa>.input.00-1Stan wejścia binarnego.
SHELLY.<nazwa>.longpush.00-1Informacja o długim nacisnięciu przycisku.
SHELLY.<nazwa>.white.<0-3>.power dowolna liczbaBieżący pobór mocy.
SHELLY.<nazwa>.white.<0-3>.energydowolna liczbaZużycie energii [W/m].
SHELLY.<nazwa>.temperaturedowolna liczbaWewnętrzna temperatura urządzenia
SHELLY.<nazwa>.overtemperature 0-1Informacja o przegrzaniu urządzenia (wtedy wartość 1).
SHELLY.<nazwa>.white.<0-3>.overpower0-1Informacja o przeciążeniu wyjścia (wtedy wartość 1).
SHELLY.<nazwa>.loaderror0-1Informacja o problemie z wyjściem ściemnialnym (wtedy wartość 1).
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary

4.2.6. Uni #

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

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.<0-1>0/offWyłącz.
1/onWłącz.
togglePrzełącz.
StanSHELLY.<nazwa>.relay.<0-1>0-1Stan wyjścia.
SHELLY.<nazwa>.input.<0-1> 0-1Stan wejścia binarnego.
SHELLY.<nazwa>.longpush.<0-1>0-1Informacja o długim nacisnięciu przycisku.
SHELLY.<nazwa>.adc.0 wg zakresu przetwornikaWartość napięcia mierzona przez wbudowany przetwornik analogowo-cyfrowy.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-1>S/LInformacja o zwarciu wejścia binarnego:
S – krótkie
L – długie
Tylko, gdy wejście w trybie Momentary

4.2.7. TRV #

Zawór termostatyczny do ogrzewania.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.thermostat.0.schedule0-1Włącz/wyłącz sterowanie przez harmonogram.
C.SHELLY.nazwa>.thermostat.0.accelerated_heating0-1Włącz/wyłącz funkcję przyspieszonego ogrzewania.
C.SHELLY.<nazwa>.thermostat.0.schedule_profile1-5Aktywowanie proflu harmonogramu
ogrzewania o wybranym numerze.
C.SHELLY.<nazwa>.thermostat.0.target4-31Ustawienie temperatury zadanej.
C.SHELLY.<nazwa>.thermostat.0.ext_tdowolnaWysyłanie do głowicy termostatu wartości temperatury otoczenia mierzonej przez zewnętrzny czujnik.
C.SHELLY.<nazwa>.thermostat.0.value_min_percent0-100Minimalna wartość otwarcia zaworu.
C.SHELLY.<nazwa>.thermostat.0.boost_minutes0-1440Czas pracy w trybie przyspieszonego
ogrzewania. Po jego upływie ogrzewanie wróci do trybu normalnego.
StanSHELLY.<nazwa>.thermostat.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.thermostat.target4-31Wartość temperatury zadanej.
SHELLY.<nazwa>.thermostat.enabled0-1Informacja o aktywacji automatycznego
sterowania zaworem grzejnikowym.
SHELLY.<nazwa>.thermostat.sensorwg zakresu czujnikaTemperatura pomieszczenia.
SHELLY.<nazwa>.thermostat.sensor.isvalid0-1Informacja, czy czujnik temperatury pracuje prawidłowo.
SHELLY.<nazwa>.thermostat.pos0-100Pozycja zaworu grzejnikowego. -1 oznacza brak kalibracji zaworu.
SHELLY.<nazwa>.thermostat.schedule0-1Informacja o aktywowaniu harmonogramu.
SHELLY.<nazwa>.thermostat.profile1-5Informacja o numerze aktywowanego
harmonogramu.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.8. Vintage #

Ściemnialna żarówka LED.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.light.00-100Ustawienie określonej jasności.
onWłącz.
offWyłącz.
togglePrzełącz.
<komenda>
;ramp:<rampa>
Wszystkie powyższe komendy z opcją użycia rampy. Rampa określa czas przejścia z jednego stanu do innego. Maksymalna wartość rampy 5 [s].
StanSHELLY.<nazwa>.light.00-100Aktualna jasność.
SHELLY.<nazwa>.light.0.powerdowolna liczbaBieżący pobór mocy.
SHELLY.<nazwa>.light.0.energydowolna liczbaZużycie energii [W/m].
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.9. H&T #

Bezprzewodowy czujnik temperatury i wilgotności powietrza.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.temperaturewg zakresu
przetwornika
Mierzona temperatura.
SHELLY.<nazwa>.sensor.humidity0-100Wilgotność względna.
SHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.sensor.act_reasonsbattery/button/periodic/
poweron/sensor/alarm
Powód wzbudzenia czujnika.
SHELLY.<nazwa>.sensor.ext_power0-1Informacja o podłączeniu do zewnętrznego źródła zasilania.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.10. Smoke #

Bezprzewodowy czujnik dymu.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.temperaturewg zakresu
przetwornika
Mierzona temperatura.
SHELLY.<nazwa>.sensor.smoke0-1Stan wykrycia dymu.
SHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.11. Flood #

Bezprzewodowy czujnik zalania.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.temperaturewg zakresu
przetwornika
Mierzona temperatura.
SHELLY.<nazwa>.sensor.flood0-1Stan wykrycia zalania.
SHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.sensor.act_reasonsbattery/button/periodic/
poweron/sensor/alarm
Powód wzbudzenia czujnika.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.12. Door/Window 1/2 #

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

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.statewg zakresu przetwornikaStan otwarcia okna/drzwi.
SHELLY.<nazwa>.sensor.tilt0-1Kąt owarcia okna/drzwi.
SHELLY.<nazwa>.sensor.vibration0-1Informacja o wykryciu wibracji.
SHELLY.<nazwa>.sensor.act_reasonsbattery/button/periodic/poweron/
sensor/movement/temperature/light
Powód wzbudzenia czujnika.
SHELLY.<nazwa>.sensor.luxwg zakresu przetwornikaPoziom jasności w luxach.
SHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.sensor.temperaturewg zakresu przetwornikaMierzona temperatura.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.13. Motion #

Bezprzewodowy czujnik ruchu z pomiarem nasłonecznienia.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.motion0-1Informacja o wykryciu ruchu.
SHELLY.<nazwa>.active0-1Informacja, czy detekcja ruchu jest aktywowana.
SHELLY.<nazwa>.vibration0-1Informacja o wykryciu wibracji.
SHELLY.<nazwa>.luxwg zakresu
przetwornika
Poziom jasności w luxach.
SHELLY.<nazwa>.battery0-100Stan naładowania baterii.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

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.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.motion0-1Informacja o wykryciu ruchu.
SHELLY.<nazwa>.sensor.charger0-1Informacja o podłączeniu do zewnętrznego źródła zasilania.
SHELLY.<nazwa>.sensor.temperaturewg zakresu
przetwornika
Temperatura pomieszczenia.
SHELLY.<nazwa>.sensor.luxwg zakresu
przetwornika
Poziom jasności w luxach.
SHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.sensor.humidity0-100Wilgotność względna [%].
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

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.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.sensor.battery0-100Stan naładowania baterii.
SHELLY.<nazwa>.sensor.charger0-1Informacja o podłączeniu do zewnętrznego źródła zasilania.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/SS/SSS/LInformacja o naciśnięciu przycisku:
S – krótkie
SS- 2x krótkie
SSS – 3x krótkie
L – długie

4.2.16. i3 #

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

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.input.<0-2>0-1Stan wejścia.
SHELLY.<nazwa>.temperature_statusnormal/
high/
veryhigh
Status temperatury urządzenia.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-2>S/L/SS/SSS/SL/LSInformacja o naciśnięciu przycisku:
S – krótkie
SS- 2x krótkie
SSS – 3x krótkie
L – długie
SL – sekwencja krótko-długo
LS – sekwencja długo-krótko

4.2.17. Gas #

Detektor gazu LPG lub CNG.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.valve.0openOtwórz zawór.
closeZamknij zawór.
C.SHELLY.<nazwa>.sensor.0muteWyciszenie alarmu.
unmuteAnulowanie wyciszenia alarmu.
testUruchomienie procedury testującej detektor.
StanSHELLY.<nazwa>.sensor.operationunknown/warmup/
normal/fault
Stan detektora:
unknown – Stan nieustalony.
warmup – Detektor się rozgrzewa.
normal – Normalna praca detektora.
fault – Błąd detektora.
SHELLY.<nazwa>.sensor.gasunknown/none/
mild/heavy/test
Stan alarmu detektora:
unknown – Stan alarmu nieustalony.
none – Brak alarmu.
mild – Delikatny wyciek gazu.
heavy – Poważny wyciek gazu.
test – Stan po przeprowadzeniu procedury testowej.
SHELLY.<nazwa>.sensor.self_testnot_completed/
completed/running/

pending
Stan procedury testowej:
not_completed – Procedura testowa niedokończona.
completed – Procedura testowa zakończona.
running – Procedura w trakcie.
pending – Procedura oczekuje na
rozpoczęcie.
SHELLY.<nazwa>.sensor.concentration0-65535Koncentracja gazu [czątka/m3], -1 gdy błąd.
SHELLY.<nazwa>.valve.stateunknown/closed/
opened/not_connected/

failure/closing/
opening/checking
Stan zaworu gazu:
unknown – Stan nieznany.
closed – Zawór zamknięty.
opened – Zawór otwarty.
not_connected – Zawór nie jest podłączony.
failure – Wykryto awarię zaworu.
closing – Zawór jest w trakcie zamykania.
opening – Zawór jest w trakcie otwierania.
checking – Stan zaworu jest w trakcie
sprawdzenia.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.18. EM #

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

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.0onWłącz wyjście.
offWyłącz wyjście.
togglePrzełącz wyjście.
C.SHELLY.<nazwa>.emeter.0resetReset wszystkich danych licznika.
clear_tSkasowanie licznika energii pobranej.
clear_rSkasowanie licznika oddanej.
StanSHELLY.<nazwa>.emeter.0.energydowolna liczbaLicznik energii pobranej [W/min].
SHELLY.<nazwa>.emeter.0.returned_energydowolna liczbaLicznik energii oddanej [W/min].
SHELLY.<nazwa>.emeter.0.totaldowolna liczbaCałkowita wartość energii pobranej [Wh].
SHELLY.<nazwa>.emeter.0.total_returneddowolna liczbaCałkowita wartość energii oddanej [Wh].
SHELLY.<nazwa>.emeter.0.powerdowolna liczbaMoc czynna [W].
SHELLY.<nazwa>.emeter.0.reactive_powerdowolna liczbaMoc bierna [W].
SHELLY.<nazwa>.emeter.0.voltagedowolna liczbaNapięcie [V].
SHELLY.<nazwa>.relay.00-1Stan wyjścia.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

4.2.19. 3EM #

Trójfazowy licznik energii elektrycznej.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.0onWłącz wyjście.
offWyłącz wyjście.
togglePrzełącz wyjście.
C.SHELLY.<nazwa>.emeter.<0-2>resetReset wszystkich danych licznika.
clear_tSkasowanie licznika energii pobranej.
clear_rSkasowanie licznika oddanej.
StanSHELLY.<nazwa>.emeter.<0-2>.energydowolna liczbaLicznik energii pobranej [W/min].
SHELLY.<nazwa>.emeter.<0-2>.returned_energydowolna liczbaLicznik energii oddanej [W/min].
SHELLY.<nazwa>.emeter.<0-2>.totaldowolna liczbaCałkowita wartość energii pobranej [Wh].
SHELLY.<nazwa>.emeter.<0-2>.total_returneddowolna liczbaCałkowita wartość energii oddanej [Wh].
SHELLY.<nazwa>.emeter.<0-2>.powerdowolna liczbaMoc czynna [W].
SHELLY.<nazwa>.emeter.<0-2>.reactive_powerdowolna liczbaMoc bierna [W].
SHELLY.<nazwa>.emeter.<0-2>.voltagedowolna liczbaNapięcie [V].
SHELLY..emeter.<0-2>.pf0-1Współczynnik mocy.
SHELLY.<nazwa>.relay.00-1Stan wyjścia.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.

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.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.00/offW górę.
1/onW dół.
toggleStop.
on/off/
1/0;flip:xx
Wykonuje zmianę stanu przekaźnika na określony
interwał czasu. Przykłady pod tabelą.
xx – czas trwania komendy, może być wartość
ułamkowa.
StanSHELLY.<nazwa>.relay.00-1Stan przekaźnika.
SHELLY.<nazwa>.input.00-1Stan wejścia binarnego.
SHELLY.<nazwa>.relay.0.errorsovertemp/
overpower/
overvoltage
Informacja o błędach modułu.
SHELLY.<nazwa>.relay.0.power
(tylko wersja PM)
dowolna
liczba
Pobór mocy.
SHELLY.<nazwa>.relay.0.energy
(tylko wersja PM)
dowolna
liczba
Zużycie energii [W/m].
SHELLY.<nazwa>.relay.0.temperature
(tylko wersja PM)
dowolna
liczba
Wewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.relay.0.voltage
(tylko wersja PM)
dowolna
liczba
Mierzone napięcie [V].
SHELLY.<nazwa>.relay.0.current
(tylko wersja PM)
dowolna
liczba
Mierzony prąd [A].
SHELLY.<nazwa>.relay.0.pf
(tylko wersja PM)
0-1Współczynnik mocy.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.0S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.longpush.00-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button
  • 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

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.roller.0upW górę.
downW dół.
stopStop.
rcKalibracja rolety.
0-100Ustawienie rolety na określoną pozycję.
100 – pełne otwarcie
0 – pełne zamknięcie
rel:xZmiana położenia rolety względem aktualnej pozycji.
x – zmiana wyrażona w % w zakresie -100..100

Komenda korzysta z formuły:
pozycja_zadana = pozycja_aktualna +x

Jeżeli pozycja zadana wykracza po zakres, wówczas
przyjmowana jest wartość maksymalna lub minimalna.
up;duration:xRuch rolety w górę przez określony czas x
down;duration:xRuch rolety w dół przez określony czas x
StanSHELLY.<nazwa>.roller.0up/down/stopStan ruchu rolety.
SHELLY.<nazwa>.roller.0.pos0-100Aktualna pozycja. Opcja dostępna tylko po kalibracji.
Wartość -1 oznacza błędną pozycję (brak kalibracji).
SHELLY.<nazwa>.roller.0.target0-100Zadana pozycja rolety.
SHELLY.<nazwa>.roller.0.stateopen/closed/opening/
closing/stopped/
calibrating
Informacja o stanie:
open – pełne otwarcie;
closed – pełne zamknięcie;
opening – w trakcie otwierania;
closing – w trakcie zamykania;
stopped – ruch zatrzymany w pozycji pomiędzy pełnym otwarciem a zamknięciem;
calibrating – w trakcie kalibracji;
SHELLY.<nazwa>.roller.0.powerdowolna liczbaBieżący pobór mocy.
SHELLY.<nazwa>.roller.0.energydowolna liczbaZużycie energii [W/h].
SHELLY.<nazwa>.roller.0.temperaturedowolna liczbaWewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.roller.0.voltagedowolna liczbaMierzone napięcie [V].
SHELLY.<nazwa>.roller.0.pf0-1Współczynnik mocy.
SHELLY.<nazwa>.roller.0.currentdowolna liczbaMierzony prąd [A].
SHELLY.<nazwa>.roller.0.positioning0-10 – gdy silnik nieskalibrowany;
1 – gdy silnik skalibrowany i pozycjonowanie
jest możliwe;
SHELLY.<nazwa>.roller.0.errorswg dokumentacji
urządzenia
Informacja o błędach modułu.
SHELLY.<nazwa>.input.<0-1>0-1Stan wejścia binarnego.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.longpush.00-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.input_event.0S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button

Tryb przekaźnikowy

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.<0-1>0/offWyłącz.
1/onWłącz.
togglePrzełącz.
on/off/
1/0;flip:xx
Wykonuje zmianę stanu przekaźnika na
określony interwał czasu.
xx – czas trwania komendy, może być
wartość ułamkowa.
Przykłady pod tabelą.
StanSHELLY.<nazwa>.relay.<0-1>0-1Stan przekaźnika.
SHELLY.<nazwa>.input.<0-1>0-1Stan wejścia binarnego.
SHELLY.<nazwa>.relay.<0-1>.errorsovertemp/overpower/
overvoltage
Informacja o błędach modułu.
SHELLY.<nazwa>.relay.<0-1>.powerdowolna liczbaPobór mocy.
SHELLY.<nazwa>.relay.<0-1>.energydowolna liczbaZużycie energii [W/h].
SHELLY.<nazwa>.relay.<0-1>.temperaturedowolna liczbaWewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.relay.<0-1>.voltagedowolna liczbaMierzone napięcie [V].
SHELLY.<nazwa>.relay.<0-1>.currentdowolna liczbaMierzony prąd [A].
SHELLY.<nazwa>.relay.<0-1>.pf0-1Współczynnik mocy.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-1>S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.longpush.00-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button
  • 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.

IdentyfikatorWartośćOpis
StanSHELLY.<nazwa>.input.<0-3>0-1Stan wejścia binarnego.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-3>S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.longpush.<0-3>0-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button

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.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.00/offWyłącz.
1/onWłącz.
togglePrzełącz.
on/off/
1/0;flip:xx
Wykonuje zmianę stanu przekaźnika na
określony interwał czasu.
Przykłady pod tabelą.
xx – czas trwania komendy, może być
wartość ułamkowa.
StanSHELLY.<nazwa>.relay.00-1Stan przekaźnika.
SHELLY.<nazwa>.input.<0-1>0-1Stan wejścia binarnego.
SHELLY.<nazwa>.relay.0.errorsovertemp/overpower/
overvoltage
Informacja o błędach modułu.
SHELLY.<nazwa>.relay.0.power
(tylko wersja PM)
dowolna liczbaPobór mocy.
SHELLY.<nazwa>.relay.0.energy
(tylko wersja PM)
dowolna liczbaZużycie energii [W/h].
SHELLY.<nazwa>.relay.0.temperature
(tylko wersja PM)
dowolna liczbaWewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.relay.0.voltage
(tylko wersja PM)
dowolna liczbaMierzone napięcie [V].
SHELLY.<nazwa>.relay.0.current
(tylko wersja PM)
dowolna liczbaMierzony prąd [A].
SHELLY.<nazwa>.relay.0.pf
(tylko wersja PM)
0-1Współczynnik mocy.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-1>S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.longpush.<0-1>0-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button
  • 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.

IdentyfikatorWartośćOpis
KomendaC.SHELLY.<nazwa>.relay.<0-1>0/offWyłącz.
1/onWłącz.
togglePrzełącz.
on/off/
1/0;flip:xx
Wykonuje zmianę stanu przekaźnika na
określony interwał czasu.
Przykłady pod tabelą.
xx – czas trwania komendy, może być
wartość ułamkowa.
StanSHELLY.<nazwa>.relay.<0-1>0-1Stan przekaźnika.
SHELLY.<nazwa>.input.<0-1>0-1Stan wejścia binarnego.
SHELLY.<nazwa>.relay.<0-1>.errorsovertemp/overpower/
overvoltage
Informacja o błędach modułu.
SHELLY.<nazwa>.relay.<0-1>.power
(tylko wersja PM)
dowolna liczbaPobór mocy.
SHELLY.<nazwa>.relay.<0-1>.energy
(tylko wersja PM)
dowolna liczbaZużycie energii [W/h].
SHELLY.<nazwa>.relay.<0-1>.temperature
(tylko wersja PM)
dowolna liczbaWewnętrzna temperatura urządzenia.
SHELLY.<nazwa>.relay.<0-1>.voltage
(tylko wersja PM)
dowolna liczbaMierzone napięcie [V].
SHELLY.<nazwa>.relay.<0-1>.current
(tylko wersja PM)
dowolna liczbaMierzony prąd [A].
SHELLY.<nazwa>.relay.<0-1>.pf
(tylko wersja PM)
0-1Współczynnik mocy.
ZdarzenieE.SHELLY.<nazwa>.<reszta_identyfikatora>Patrz StanModuł Base rozgłasza zdarzenia dla zmian wszystkich parametrów z sekcji Stan.
E.SHELLY.<nazwa>.input_event.<0-1>S/SS/LInformacja o zwarciu wejścia binarnego:
S – krótkie
SS – 2x krótkie
L – długie
Tylko, gdy wejście w trybie Button
E.SHELLY.<nazwa>.longpush.<0-1>0-1Zdarzenie dla długiego zwarcia wejścia.
Tylko, gdy wejście w trybie Button

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.

Powered by BetterDocs

Select your currency
PLN Złoty polski
EUR Euro