Przykłady akcji pomiędzy sterownikami BleBox

Każdy sterownik ma swój typ API, który można sprawdzić w zakładce „szczegóły, aktualizacja i pomoc”, np. czujnik temperatury tempSensor ma typ API multiSensor.

Szczegółowa dokumentacja znajduje się pod tym linkiem: https://technical.blebox.eu/

switchBox

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to cyfra opisana poniżej:

• 0 – wyłącza
• 1 – włącza
• 2 – zmienia stan na przeciwny (jeżeli było włączone to wyłącza i na odwrót)

Zaawansowane:

• 1/forTime/(…TIMES…)/ns/0

gdzie (…TIMES…) to czas w sekundach na ile ma się włączyć switchBox

Przykłady:

• 1/forTime/5/ns/0 – podłączone urządzenie zostanie włączone na 5 sekund

switchBox z kilkoma wyjściami

Dla akcji typu: wyślij URL:
– http://IP/s/(…OUTPUT…)/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…OUTPUT…)/(…REQUEST…)

gdzie (…OUTPUT…) to cyfra opisana poniżej:

• 0  – pierwsze wyjście (O1)
• 1 – drugie wyjście (O2)

gdzie (…REQUEST…) to cyfra opisana poniżej:

• 0 – wyłącza
• 1 – włącza
• 2 – zmienia stan na przeciwny (jeżeli było włączone to wyłącza i na odwrót)

Przykłady:

• 0/1 – włączy wyjście O1
• 1/1 – włączy wyjście O2
• 0/2 – zmieni stan wyjścia O1 na przeciwny (jeżeli wyjście było włączone to wyłączy i na odwrót)

Zaawansowane:

• (…OUTPUT…)/1/forTime/(…TIMES…)/ns/0

gdzie (…OUTPUT…) to numer wyjścia (patrz powyżej) oraz gdzie (…TIMES…) to czas w sekundach na ile ma się włączyć wyjście switchBoxD.

Przykłady:

• 0/1/forTime/5/ns/0 – włączy na 5 sekund wyjście O1
• 1/1/forTime/5/ns/0 – włączy na 5 sekund wyjście O2

wLightBoxS i dimmerBox

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to wartość jasności w formacie WW. Jest ona zapisana szesnastkowo na dwóch znakach (00-FF co odpowiada zapisowi dziesiętnemu: 0-255):

• 00 – wyłącza
• FF – włącza, ustawia jasność na 100%

Przykłady:

• 00 – wyłączy
• 19 – włączy i ustawi jasność na 10%
• 33 – włączy i ustawi jasność na 20%
• 4D – włączy i ustawi jasność na 30%
• 66  – włączy i ustawi jasność na 40%
• 7F – włączy i ustawi jasność na 50%
• 99 – włączy i ustawi jasność na 60%
• B3 – włączy i ustawi jasność na 70%
• CC – włączy i ustawi jasność na 80%
• E6 – włączy i ustawi jasność na 90%
• FF – włączy i ustawi jasność na 100%

Zaawansowane w LightBoxS:

• offon/last —> zmienia stan – off / ostatni stan (ostatnia jasność)
• onlast —> zawsze włącza ostatni stan
• inc/XX —> zwiększa obecną jasność o XX (hex)
• dec/XX —> zmniejsza obecną jasność o XX (hex)
• x/(…EFFECT_ID…) —> włącza efekt o danym ID (0-9)
• x/(…EFFECT_ID…)/forTime/(…TIME_S…) —> włącza dany efekt na zadany czas
• XX/colorFadeMs/(…TIME_MS…) —> włącza daną jasność z zadanym czasem rozjaśniania
• XX/forTime/(…TIME_S…) —> włącza daną jasność na zadany czas
• s/XX/colorFadeMs/(…TIME_MS…)/forTime/(…TIME_S…) —> włącza daną jasność na zadany czas z zadanym czasem rozsjaśniania

gdzie XX to wartość 0-FF, (…TIME_S…) to czas w sekundach, (…TIME_MS…) to czas rozjaśniania w milisekundach, a (…EFFECT_ID…) to cyfra – numer efektu z aplikacji (0-9).

Zaawansowane dimmerBox:

• offon/last —> zmienia stan – off / ostatni stan (ostatnia jasność)
• offon/toggle —> zmienia stan – off / on (max 100%)
• offon/XX —> zmienia stan – off / XX (jasność w HEX 00-FF)
• onlast —> zawsze włącza ostatni stan
• onfull —> zawsze włącza na maks (tak jak /s/FF)
• off —> wyłącza (tak jak /s/00)
• inc/XX —> zwiększa obecną jasność o XX (hex)
• dec/XX —> zmniejsza obecną jasność o XX (hex)

wLighBox (5CH) i pixelBox

Akcje (rozkazy) dla produktu wLightBox oraz pixelBox:

Dla akcji typu: wyślij URL:
– http://IP/s/(…CHANNELS…)

Dla akcji typu: steruj innym urządzeniem:
– (…CHANNELS…)

gdzie (…CHANNELS…) to 5 wartości jasności (RR-GG-BB-WW-CW). Są one zapisane szesnastkowo na dwóch znakach dla każdego koloru / kanału taśmy led (00-FF co odpowiada zapisowi dziesiętnemu: 0-255) odpowiednio:

• RR – czyli 00-FF (0-255) – jasność koloru czerwonego / kanału 1
• GG – czyli 00-FF (0-255) – jasność koloru zielonego / kanału 2
• BB – czyli 00-FF (0-255) – jasność koloru niebieskiego / kanału 3
• WW – czyli 00-FF (0-255) – jasność koloru białego ciepłego / kanału 4
• CW – czyli 00-FF (0-255) – jasność koloru białego zimnego / kanału 5

Przeliczona skala jasności:

• 00 – jasność 0%
• 19 – jasność 10%
• 33 – jasność 20%
• 4D – jasność 30%
• 66  – jasność 40%
• 7F – jasność 50%
• 99 – jasność 60%
• B3 – jasność 70%
• CC – jasność 80%
• E6 – jasność 90%
• FF – jasność 100%

Przykłady:

• 0000000000 – wyłączy taśmę led / wszystkie kanały wyłączone
• FF00000000 – włączy kolor czerwony / kanał 1 włączony, reszta wyłączone
• 00FF000000 – włączy kolor zielony / kanał 2 włączony, reszta wyłączone
• 0000FF0000 – włączy kolor niebieski / kanał 3 włączony, reszta wyłączone
• 000000FF00 – włączy kolor biały ciepły / kanał 4 włączony, reszta wyłączone
• 00000000FF – włączy kolor biały zimny / kanał 5 włączony, reszta wyłączone

• FFFFFF0000 – włączy kolor biały (czerwony, zielony, niebieski)
• FFFF000000 – włączy kolor żółty (czerwony, zielony)
• FF00FF0000 – włączy kolor fuksja (czerwony, niebieski)
• 00FFFF0000 – włączy kolor cyjan (zielony, niebieski)
• FF7F000000 – włączy kolor pomarańczowy (czerwony, 50% zielonego)

Zaawansowane:

• offon/last

włączy lub wyłączy ostatnio ustawiony kolor/jasność kanałów. Innymi słowy, jeżeli taśma LED świeci to zostanie wyłączona, jeżeli nie świeci to zostanie włączony ostatnio ustawiony kolor.

• (…CHANNELS…)/forTime/(…TIMES…)

gdzie (…CHANNELS…) to 4 wartości jasności (patrz powyżej) oraz gdzie (…TIMES…) to czas w sekundach na ile ma się włączyć zadana jasność/kolor.

• x/(…EFFECT_ID…)

gdzie (…EFFECT_ID…) to cyfra – numer efektu z aplikacji (0-9).

Przykłady:

• offon/last – włączy lub wyłączy ostatnio ustawiony kolor/jasność kanałów.
• FF00000000/forTime/5 – włączy kolor czerwony na 5 sekund
• x/0 – wyłączy efekt
• x/1 – włączy efekt o numerze 1
• x/5 – włączy efekt o numerze 5

shutterBox

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to znak lub wartość (w przypadku wykonanej kalibracji na sterowniku) opisana poniżej:

• u – otwórz
• d – zamknij
• s – stop
• n – następny rozkaz z sekwencji (kolejny rozkaz w sekwencji otwórz-stop-zamknij-stop)
• f – pozycja ulubiona (tylko przy skalibrowanym sterowniku)

Przykłady:

• u – spowoduje otworzenie
• d – spowoduje zamknięcie
• s – spowoduje zatrzymanie
• n- spowoduje kolejny rozkaz w sekwencji otwórz-stop-zamknij-stop
• f – spowoduje „jazdę” do pozycji ulubionej

Zaawansowane:

• p/(…VALUE_PERCENTAGE…)
• t/(…VALUE_PERCENTAGE…)

gdzie (…VALUE_PERCENTAGE…) to liczba od 0 do 100 oznaczająca procent zamknięcia (tylko przy skalibrowanym sterowniku).

Przykłady:

• p/0 – spowoduje otworzenie (jednoznaczne z u)
• p/100 – spowoduje zamknięcie (jednoznacze z d)
• p/50 – spowoduje zamknięcie bramy do połowy
• t/0 – spowoduje minimalne ustawienie lameli w zależności od silnika
• t/100 – spowoduje maksymalne ustawienie lameli w zależności od silnika
• t/50 – spowoduje ustawienie lameli w zależności od silnika

rollerGate

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to znak opisany poniżej:

• o – otwórz
• c – zamknij
• s – stop
• n – następny rozkaz z sekwencji (kolejny rozkaz w sekwencji otwórz-stop-zamknij-stop)
• w – pozycja przejścia/wietrzenia (tylko przy skalibrowanym sterowniku)

Przykłady:

• o – spowoduje otworzenie
• c – spowoduje zamknięcie
• s – spowoduje zatrzymanie
• n – spowoduje kolejny rozkaz w sekwencji otwórz-stop-zamknij-stop
• w – spowoduje „jazdę” do pozycji ulubionej, przejścia dla pieszych, wietrzenia

Zaawansowane:

• p/(…VALUE_PERCENTAGE…)

gdzie (…VALUE_PERCENTAGE…) to liczba od 0 do 100 oznaczająca procent zamknięcia bramy (tylko przy skalibrowanym sterowniku).

Przykłady:

• p/0 – spowoduje otworzenie (jednoznaczne z o)
• p/100 – spowoduje zamknięcie (jednoznacze z c)
• p/50 – spowoduje zamknięcie bramy do połowy

gateBox

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to znak opisany poniżej:

• p – wysteruj pierwsze wyjście (impuls na wejście przyciskowe sterownika bramy)
• s – wysteruj drugie wyjście (impuls na wejście przyciskowe sterownika bramy), (brak w przypadku doorBox’a)

Przykłady:

• p – spowoduje wysterowanie wyjścia pierwszego
• s – spowoduje wysterowanie wyjścia drugiego (brak w przypadku doorBox’a)

saunaBox

Akcje (rozkazy) dla produktu saunaBox:

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to cyfra opisana poniżej:

• 0 – wyłącz grzanie
• 1 – włącz grzanie z ostatnio zadaną temperaturą

Przykłady:

• 0 – spowoduje wyłączenie grzania
• 1 – spowoduje włączenie grzania z ostatnio zadaną temperaturą

Zaawansowane:

• t/(…TEMPERATURE_X100…)

gdzie (…TEMPERATURE_X100…) to temperatura pomnożona przez 100 tzn. od -5500 do 12500 (od -55 do +125).

Przykłady:

• t/0 – spowoduje ustawienie temperatury na 0 stopni (nie włącza/wyłącza sauny)
• t/125 – spowoduje ustawienie temperatury na 125 stopni (nie włącza/wyłącza sauny)
• t/60 – spowoduje ustawienie temperatury na 60 stopni (nie włącza/wyłącza sauny)

thermoBox

Dla akcji typu: wyślij URL:
– http://IP/s/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to cyfra opisana poniżej:

• 0 – wyłącz kontroler
• 1 – włącz kontroler z ostatnio zadaną temperaturą
• 3 – włącz tryb BOOST

Przykłady:

• 0 – spowoduje wyłączenie grzania
• 1 – spowoduje włączenie grzania z ostatnio zadaną temperaturą

Zaawansowane:

• 1/t/(…TEMPERATURE_X100…)
• 0/t/(…TEMPERATURE_X100…)
• t/(…TEMPERATURE_X100…)
• t/inc/(…TEMPERATURE_X100…)
• t/dec/(…TEMPERATURE_X100…)

gdzie (…TEMPERATURE_X100…) to temperatura pomnożona przez 100 tzn. od -5500 do 12500 (od -55 do +125).

Przykłady:

• 1/t/2300 – spowoduje włączenie kontrolera i ustawienie temperatury na 23 stopnie
• t/2000 – spowoduje ustawienie temperatury na 20 stopni (nie włącza/wyłącza kontrolera)
• t/2250 – spowoduje ustawienie temperatury na 22.5 stopnia (nie włącza/wyłącza kontrolera)
• 0/t/2100 – spowoduje wyłączenie kontrolera i ustawienie temperatury na 21 (np. na przyszłe grzanie)
• t/inc/100 – spowoduje zwiększenie temperatury o 1 stopnien
• t/dec/50 – spowoduje zmniejszenie temperatury o 0.5 stopnia

actionBox

Dla akcji typu: wyślij URL: (uwaga inaczej niż inne sterowniki)
– http://IP/t/(…REQUEST…)

Dla akcji typu: steruj innym urządzeniem:
– (…REQUEST…)

gdzie (…REQUEST…) to <numer przycisku>/<numer wyzwalacza>, gdzie:

• <numer przycisku> to liczba od 0 do 3 (kolejno numer przycisku actionBox oznaczonego jako 1 – 4)
• <numer wyzwalacz> to ustawiony w actionBox wyzwalacz:
  • 1 – krótkie kliknięcie
  • 2 – długie kliknięcie
  • 3 – zbocze opadające (np. puszczenie przycisku)
  • 4 – zbocze narastające (np. wciśnięcie przycisku)
  • 5 – zbocze (np. zarówno puszczenie jak i wciśnięcie)

Przykłady:

• 0/1
• 2/5

multiSensor

Akcje (rozkazy) dla produktu saunaBox:

Dla akcji typu: wyślij URL:
– http://IP/(…ENDPOINT…)

gdzie (…ENDPOINT…) to ścieżka opisana poniżej:

• state – zwraca podstawowy stan czujników (id, type, value, state, trend, elapsedTimeS)
• state/extended – spowoduje odczyt pełnych danych czujników wraz z ich nazwami i ikonami

Typy czujników (type w odpowiedzi state)

• temperature – temperatura
• pozostałe typy zależne od modelu/konfiguracji sond – patrz api/probes/state

Pola opisujące pojedynczy czujnik

• id – numer czujnika
• type – typ czujnika
• value – aktualna wartość
• state – stan/status pomiaru (kod liczbowy)
• trend – kierunek trendu wartości (kod liczbowy)
• elapsedTimeS – czas (s) od ostatniego pomiaru
• iconSet (tylko state/extended) – ikona przypisana do czujnika
• name (tylko state/extended) – nazwa nadana czujnikowi