Spis treści
Komunikacja pomiędzy modułem DOMIQ Base 2.0 a urządzeniami SUPLA opiera się na ujednoliconych identyfikatorach. Wszystkie komendy, stany oraz zdarzenia powiązane z tym standardem posiadają następującą składnię:
SUPLA.<nazwa>.<typ>.<kanał>.<podkanał>
Gdzie:
<nazwa>– unikalna nazwa przypisana do urządzenia (najczęściej składająca się z modelu urządzenia oraz jego fabrycznego numeru seryjnego).<typ>– określa rodzaj obsługiwanego obwodu (np. switch, light, sensor, cover, climate, binary_sensor, trigger).<kanał>– kolejny numer fizycznego kanału w urządzeniu, indeksowany od0.<podkanał>– indeks lub nazwa podkanału, stosowana w przypadku, gdy jeden kanał fizyczny realizuje więcej niż jedną funkcję (np. pojedynczy sensor mierzący jednocześnie temperaturę i wilgotność).
Ważne! Każda zmiana stanu dowolnego parametru automatycznie generuje (rozgłasza) w systemie DOMIQ zdarzenie o identycznej strukturze i wartości.
Przekaźnik (switch) #
Służy do sterowania standardowymi obwodami dwustanowymi (np. gniazda, oświetlenie typu włącz/wyłącz).
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Stan | SUPLA.<nazwa>.switch.<kanał>.0 | | Przekaźnik włączony. Przekaźnik wyłączony. |
Komenda | | | Wyłączenie przekaźnika. Włączenie przekaźnika. Przełączenie stanu przekaźnika na przeciwny. |
Światło (light) #
Dedykowany zestaw identyfikatorów dla ściemniaczy oraz sterowników oświetlenia wielokolorowego (RGB).
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Stan | SUPLA.<nazwa>.light.<kanał>.<podkanał> | | Obwód włączony. Obwód wyłączony. |
| Stan | SUPLA.<nazwa>.light.<kanał>.<podkanał>.rgb | | Aktualnie ustawiona barwa światła RGB. |
| Stan | SUPLA.<nazwa>.light.<kanał>.<podkanał>.rgb.<r/g/b> | 0-100 | Aktualny poziom jasności składowej barwy w procentach. |
| Stan | SUPLA.<nazwa>.light.<kanał>.<podkanał>.brightness | 0-100 | Aktualny poziom jasności obwodu w procentach. |
| Komenda | C.SUPLA.<nazwa>.light.<kanał>.<podkanał>.rgb | | Ustawienie koloru świecenia. Parametry <R>, <G>, <B> to liczby z zakresu 0-255. |
| Komenda | | | Wyłączenie obwodu. Włączenie obwodu. Przełączenie stanu obwodu. |
| Komenda | C.SUPLA.<nazwa>.light.<kanał>.<podkanał>.rgb.<r/g/b> | 0-100 | Ustawienie jasności dla pojedynczego kanału barwy (czerwony/zielony/niebieski) w procentach. |
| Komenda | | 0-100 | Ustawienie poziomu jasności w procentach. |
Czujnik (sensor) #
Umożliwia odczyt wartości pomiarowych z czujników temperatury, wilgotności i innych sensorów analogowych.
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Stan | SUPLA.<nazwa>.sensor.<kanał>.<pomiar> | zależy od typu pomiaru | Zwraca aktualną wartość pomiarową. Oznaczenie <pomiar> odpowiada nazwie mierzonej wielkości fizycznej, np. temperature lub humidity. Dokładny opis parametru można zweryfikować w kolumnie Opis w zakładce Stan konfiguratora Base. |
Roleta (Cover) #
Klasa identyfikatorów przeznaczona do obsługi napędów rolet, żaluzji oraz bram.
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Stan | SUPLA.<nazwa>.cover.<kanał>.0.position | 0-100 | Aktualna pozycja bezwzględna rolety. |
| Stan | SUPLA.<nazwa>.cover.<kanał>.0 | updownstop | Aktualny kierunek ruchu napędu rolety. |
| Stan | SUPLA.<nazwa>.cover.<kanał>.0.tilt | 0-100 | Aktualny kąt nachylenia lameli żaluzji. |
| Komenda | | | Otwieranie (podnoszenie). Zamykanie (opuszczanie). Zatrzymanie pracy napędu. |
| Komenda | C.SUPLA.<nazwa>.cover.<kanał>.0.tilt | 0-100 | Ustawienie kąta nachylenia lameli żaluzji w procentach (jeżeli funkcja jest obsługiwana przez urządzenie). |
| Komenda | | 0-100 | Ustawienie żądanej pozycji bezwzględnej (stopień zamknięcia rolety w procentach; 0% = roleta całkowicie otwarta). |
Termostat (Climate) #
Zaawansowany zbiór identyfikatorów do kompleksowej kontroli parametrów pracy klimatyzacji i ogrzewania.
| Rodzaj | Identyfikator | Zakres wartości | Opis |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.mode | off auto heat cool heat_cool | Aktualny tryb pracy termostatu (dostępność poszczególnych trybów zależy od specyfikacji technicznej urządzenia i jest opisana w kolumnie Opis w zakładce Stan). |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.action | off idle heating cooling | Urządzenie wyłączone. Urządzenie w stanie czuwania (temperatura w normie). Aktywne ogrzewanie. Aktywne chłodzenie. |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.temperature | wartość liczbowa | Aktualna temperatura zadana w °C. |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.temperature_high | wartość liczbowa | Aktualna górna granica temperatury zadanej w °C. |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.temperature_low | wartość liczbowa | Aktualna dolna granica temperatury zadanej w °C. |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.current_temperature | wartość liczbowa | Aktualna temperatura odczytywana bezpośrednio przez wbudowany czujnik termostatu (w °C). Ważne: Niezależne odczyty z sensorów fizycznych są dostępne również pod osobnym identyfikatorem z sekcji Czujnik (sensor). |
| Stan | SUPLA.<nazwa>.climate.<kanał>.0.current_humidity | 0–100 | Aktualna wilgotność otoczenia w procentach (jeżeli urządzenie jest wyposażone w higrometr). |
| Komenda | C.SUPLA.<nazwa>.climate.<kanał>.0.mode | off auto heat cool heat_cool | Wyłączenie termostatu. Uruchomienie trybu automatycznego (np. praca według chronogramu). Wymuszenie trybu ogrzewania. Wymuszenie trybu chłodzenia. Tryb automatycznego grzania i chłodzenia (dwuprogowy). |
| Komenda | C.SUPLA.<nazwa>.climate.<kanał>.0.temperature | wartość liczbowa | Ustawienie temperatury zadanej w °C (dla trybów jednokierunkowych heat oraz cool). |
| Komenda | C.SUPLA.<nazwa>.climate.<kanał>.0.temperature_high | wartość liczbowa | Ustawienie górnej granicy temperatury w °C (tryb heat_cool), powyżej której rozpoczyna się chłodzenie. |
| Komenda | C.SUPLA.<nazwa>.climate.<kanał>.0.temperature_low | wartość liczbowa | Ustawienie dolnej granicy temperatury w °C (tryb heat_cool), poniżej której rozpoczyna się ogrzewanie. |
Czujnik binarny (binary_sensor) #
Służy do monitorowania stanów dwustanowych (np. czujniki magnetyczne otwarcia okien/drzwi, czujniki zalania).
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Stan | SUPLA.<nazwa>.binary_sensor.<kanał>.<podkanał> | | Stan wysoki (np. naruszony, otwarty, wykryto zalanie). Stan niski (np. bezpieczny, zamknięty, brak zalania). |
Wyzwalacz (trigger) #
Wykorzystywany do obsługi zdarzeń generowanych przez przyciski monostabilne (dzwonkowe). Dostępność poszczególnych zdarzeń zależy od konfiguracji oprogramowania układowego modułu SUPLA.
| Rodzaj | Identyfikator | Zakres wartości | Opis |
|---|---|---|---|
| Zdarzenie | E.SUPLA.<nazwa>.trigger.<kanał> | button_turn_onbutton_turn_offbutton_short_pressbutton_long_pressbutton_double_pressbutton_triple_pressbutton_quadruple_pressbutton_quintuple_press | Naciśnięcie przycisku. Puszczenie przycisku. Krótkie kliknięcie. Długie przytrzymanie. Podwójne kliknięcie. Potrójne kliknięcie. Poczwórne kliknięcie. Pięciokrotne kliknięcie. |