Polecenia¶
LK4 może być sterowany za pomocą poleceń, które mogą być wysyłane za pośrednictwem protokołu HTTP lub MQTT.
Dodatkowo w wersji z modemem LTE obsługuje również polecenia SMS.
Jak używać poleceń¶
Prawie każde polecenie ma strukturę NAZWA=WARTOŚĆ.
HTTP¶
Aby wysłać polecenie przez HTTP należy wysłać zapytanie HTTP GET na adres /api/v1/save/, np.
http://[IP]/api/v1/save/?out1=1
http://[IP]/api/v1/save/?out=out1
http://[IP]/api/v1/save/?outName1=Lampa%20Biurko
W jednym zapytaniu można wysłać wiele poleceń, np.
http://[IP]/api/v1/save/?out1=1&out2=1&out3=1&out4=1&out5=1&out6=1
Specjalne znaki w wartości parametrów
Należy pamiętać o tym, że spacje i znaki specjalne w wartości parametru GET muszą być zastąpione ich hex kodami ASCII, np. spacja = %20, % = %25.
Jeżeli w urządzeniu włączona jest metoda Basic Authentication, nagłówek HTTP Authorization musi być ustawiany w każdym żądaniu API.
Wyjątek stanowi adres /api/v1/post_data/signin, przeznaczony do weryfikacji danych logowania.
Uprawnienia dostępu przy Basic Authentication¶
Przy włączonej metodzie Basic Authentication możliwość wykonywania poleceń zależy od poziomu uprawnień użytkownika:
- admin – dostęp do wszystkich poleceń,
- user – dostęp do poleceń sterujących wyjściami (OUT, PWM) oraz zmiennymi VAR,
- użytkownicy sterujący – dostęp do poleceń sterujących wyjściami (OUT, PWM) oraz zmiennymi VAR,
- publicznie (bez uwierzytelniania) – brak dostępu do poleceń.
Ograniczenia te dotyczą wyłącznie zapytań HTTP i nie mają wpływu na mechanizm MQTT ani SMS.
MQTT¶
Do wysyłania poleceń przez MQTT jest potrzebny klient MQTT, np. webowy klient na naszym serwisie
Po skonfigurowaniu klienta MQTT i pomyślnym połączeniu z serwerem MQTT, można wysyłać polecenia na temat [Prefiks tematu]/cmd o treści podobnej jak w poleceniach HTTP, np.
out1=1
out=out1
outName1=Lampa Biurko
Po MQTT również można wysłać wiele poleceń w jednej wiadomości, np.
out1=1&out2=1&out3=1&out4=1&out5=1&out6=1&out7=1
Warto zauważyć, że nie ma tu potrzeby kodowania znaków jak w przypadku HTTP.
Każde polecenie jest potwierdzane odpowiedzią 1 na temacie [Prefiks tematu]/cmdr. W przypadku wiadomości z wieloma poleceniami, będzie wiele odpowiedzi - osobno dla każdego polecenia.
SMS¶
Tylko dla LK4 z modemem LTE
Polecenia w wiadomościach SMS muszą mieć odpowiednią strukturę:
[KOD DOSTĘPU]:cmd:[POLECENIE]
Przykładowo:
1234:cmd:out=out1
W odróżnieniu do HTTP i MQTT przez SMS można wysyłać tylko pojedyncze polecenia, nie można łączyć używając &.
W konfiguracji modemu można włączyć opcję Wyślij SMS zwrotny po poleceniu SMS, aby otrzymywać SMSy zwrotne na polecenia o treści, np. cmd ack SMS from LK4 uptime=1874.
Lista poleceń¶
Ustawienia UI¶
webRefresh¶
Jak często wartości z urządzenia są odświeżane na stronie, wartość w sekundach.
webRefresh=[A]
A- liczba rzeczywista0.3 - 3276.
webLanguage¶
Język interfejsu użytkownika.
webLanguage=[A]
-
A- liczba całkowita{ 0: 'PL', 1: 'EN', 2: 'FR', 3: 'HU', 4: 'CS', 5: 'DE', // dodane w SW 1.42 }
webUserSetNames¶
Po włączeniu nazwy odczytów będą wyświetlane jako same nazwy użytkownika bez standardowych nazw, np. Temp wewnatrz zamiast DS1 - Temp wewnatrz.
webUserSetNames=[A]
A- liczba całkowita0-1
webReadOnlyUser¶
Użytkownik będzie mógł tylko odczytać dane, bez możliwości sterowania wyjściami na stronie Status dla użytkownika.
webReadOnlyUser=[A]
A- liczba całkowita0-1
webAutoSignIn¶
Usunięte w wersji SW 1.38 z powodu niekompatybilności z nowym systemem logowania.
Automatycznie zaloguj się jako administrator podczas odwiedzania strony indeksu (pomiń stronę logowania). Gdy ta opcja jest włączona, wylogowanie nie ma efektu, a logowanie użytkownika jest niedostępne.
webAutoSignIn=[A]
A- liczba całkowita0-1
webHomepage¶
Strona, która zostanie załadowana po zalogowaniu.
webHomepage=[A]
-
A- liczba całkowita0-3```js { 0: 'Status', 1: 'StatusUser', 2: 'SerialPort', 3: 'Modbus', }
webVisibility¶
Określa widoczność elementów na stronie Status oraz Status użytkownika.
webVisibility=[A]
-
A- ciąg 140 cyfr0-1(obecnie używane pierwsze 127), gdzie kolejne cyfry odpowiadają widoczności elementów.{ 0: 'OUT1 showValue', 1: 'OUT1 showName', 2: 'OUT2 showValue', 3: 'OUT2 showName', 4: 'OUT3 showValue', 5: 'OUT3 showName', 6: 'OUT4 showValue', 7: 'OUT4 showName', 8: 'OUT5 showValue', 9: 'OUT5 showName', 10: 'OUT6 showValue', 11: 'OUT6 showName', 12: 'PWM1 showValue', 13: 'PWM1 showName', 14: 'PWM1 showDuty', 15: 'PWM2 showValue', 16: 'PWM2 showName', 17: 'PWM2 showDuty', 18: 'PWM3 showValue', 19: 'PWM3 showName', 20: 'PWM3 showDuty', 21: 'VAR1 show', 22: 'VAR2 show', 23: 'VAR3 show', 24: 'VAR4 show', 25: 'VAR5 show', 26: 'VAR6 show', 27: 'VAR7 show', 28: 'VAR8 show', 29: 'iA1 showValue', 30: 'iA1 showName', 31: 'iA2 showValue', 32: 'iA2 showName', 33: 'iA3 showValue', 34: 'iA3 showName', 35: 'DS1 showName', 36: 'DS1 showValue', 37: 'DS2 showName', 38: 'DS2 showValue', 39: 'DS3 showName', 40: 'DS3 showValue', 41: 'DS4 showName', 42: 'DS4 showValue', 43: 'DS5 showName', 44: 'DS5 showValue', 45: 'DS6 showName', 46: 'DS6 showValue', 47: 'DS7 showName', 48: 'DS7 showValue', 49: 'DS8 showName', 50: 'DS8 showValue', 51: 'T1 showName', 52: 'T1 showValue', 53: 'H1 showName', 54: 'H1 showValue', 55: 'P1 showName', 56: 'P1 showValue', 57: 'IAQ show', 58: 'DewPoint show', 59: 'PM1 showName', 60: 'PM1 showValue', 61: 'PM2.5 showName', 62: 'PM2.5 showValue', 63: 'PM4 showName', 64: 'PM4 showValue', 65: 'PM10 showName', 66: 'PM10 showValue', 67: 'CO2 showName', 68: 'CO2 showValue', 69: 'm1 show', 70: 'm2 show', 71: 'm3 show', 72: 'm4 show', 73: 'm5 show', 74: 'm6 show', 75: 'm7 show', 76: 'm8 show', 77: 'm9 show', 78: 'm10 show', 79: 'm11 show', 80: 'm12 show', 81: 'm13 show', 82: 'm14 show', 83: 'm15 show', 84: 'm16 show', 85: 'm17 show', 86: 'm18 show', 87: 'm19 show', 88: 'm20 show', 89: 'm21 show', 90: 'm22 show', 91: 'm23 show', 92: 'm24 show', 93: 'm25 show', 94: 'm26 show', 95: 'm27 show', 96: 'm28 show', 97: 'm29 show', 98: 'm30 show', 99: 'DIFF1 showValue', 100: 'DIFF2 showValue', 101: 'DIFF3 showValue', 102: 'DIFF4 showValue', 103: 'DIFF5 showValue', 104: 'DIFF6 showValue', 105: 'iD1 show', 106: 'iD2 show', 107: 'iD3 show', 108: 'iD4 show', 109: 'POWER1 showName', 110: 'POWER1 showValueP', 111: 'POWER1 showValueE', 112: 'POWER2 showName', 113: 'POWER2 showValueP', 114: 'POWER2 showValueE', 115: 'POWER3 showName', 116: 'POWER3 showValueP', 117: 'POWER3 showValueE', 118: 'POWER4 showName', 119: 'POWER4 showValueP', 120: 'POWER4 showValueE', 121: 'POWER5 showName', 122: 'POWER5 showValueP', 123: 'POWER5 showValueE', 124: 'POWER6 showName', 125: 'POWER6 showValueP', 126: 'POWER6 showValueE', }
webPositionTop¶
Określa pozycje elementów na stronie Status użytkownika, konkretnie przesunięcie od góry w px względem pozycji domyślnej.
webPositionTop=[A]
A- ciąg 84 liczb całkowitych-1024 - 1024oddzielonych znakiem*.
webPositionLeft¶
Określa pozycje elementów na stronie Status użytkownika, konkretnie przesunięcie od lewej w px względem pozycji domyślnej.
webPositionLeft=[A]
A- ciąg 84 liczb całkowitych-1024 - 1024oddzielonych znakiem*.
Ogólne¶
restartFlag¶
Ustawia flagę, która jest resetowana przy uruchomieniu urządzenia. Pozwala to na szybkie sprawdzenie czy wystąpił restart urządzenia od ostatniego ustawienia flagi.
restartFlag=1
eeprom_reset¶
Przywraca ustawienia do domyślnych wartości.
eeprom_reset=1
restart¶
Ponownie uruchamia urządzenie.
restart=1
Inne¶
varName¶
Dodane w SW 1.06
Ustawia nazwę dla zmiennej VAR (1-8).
varName[A]=[B]
A- numer zmiennej, liczba całkowita1-8B- ciąg do 15 znaków
var¶
Ustawia stan zmiennej VAR (1-8).
var[A]=[B]
A- numer zmiennej, liczba całkowita1-8B- stan do ustawienia, liczba całkowita0-1
Wyjścia¶
out¶
Ustawia stan wyjścia. Polecenie ma dwa warianty - jeden do zmiany stanu na przeciwny a drugi do ustawiania konkretnego stanu (składnia obu wariantów poniżej).
out=out[A]
A- numer wyjścia, liczba całkowita1-6
out[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- stan do ustawienia, liczba całkowita0-1
outName¶
Ustawia nazwę wyjścia.
outName[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- ciąg do 15 znaków
outResetTime¶
Ustawia czas powrotu dla wyjścia. Funkcja automatycznie wyłącza wyjście po upływie określonego czasu (w sekundach) od ostatniej zmiany stanu (wywołanej przez użytkownika lub funkcję zdarzeń). Wartość 0 oznacza, że funkcja jest nieaktywna.
outResetTime[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- czas w sekundach, liczba całkowita0-65535
outAutoSwitch¶
Aktywuje okresowe przełączanie stanu wyjścia z zadanymi czasami włączenia i wyłączenia.
outAutoSwitch[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- liczba całkowita0-1
outAutoSwitchH¶
Ustawia czas załączenia wyjścia dla okresowego przełączania.
outAutoSwitchH[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- czas w sekundach, liczba całkowita0-65535
outAutoSwitchL¶
Ustawia czas wyłączenia wyjścia dla okresowego przełączania.
outAutoSwitchL[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- czas w sekundach, liczba całkowita0-65535
outStartOn¶
Aktywuje funkcję włączenia wyjścia z określonym opóźnieniem po uruchomieniu urządzenia.
outStartOn[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- liczba całkowita0-1
outStartOnTime¶
Ustawia czas opóźnienia po którym wyjście będzie włączone.
outStartOnTime[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- czas w sekundach, liczba całkowita0-65535
outSaveState¶
Aktywuje funkcję zapamiętywania stanu wyjścia, tak by był przywrócony po restarcie urządzenia.
outSaveState[A]=[B]
A- numer wyjścia, liczba całkowita1-6B- liczba całkowita0-1
outNegation¶
Aktywuje negacje stanu wyjść. Sprawia, że 1 jest prezentowane jako OFF, a 0 jako ON.
outNegation=[A]
A- liczba całkowita0-1
outLock¶
Aktywuje blokowanie stanu wyjść z poziomu poleceń HTTP/MQTT. Stan będzie tylko sterowany przez funkcje urządzenia, takie jak Harmonogramy, Zdarzenia, Watchdog.
outLock=[A]
A- liczba całkowita0-1
Wyjścia PWM¶
pwmName¶
Ustawia nazwę dla wyjścia PWM.
pwmName[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- ciąg do 15 znaków
pwm¶
Ustawia stan wyjścia PWM. Polecenie ma dwa warianty - jeden do zmiany stanu na przeciwny a drugi do ustawiania konkretnego stanu (składnia obu wariantów poniżej).
pwm=pwm[A]
A- numer wyjścia, liczba całkowita1-3
pwm[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- stan do ustawienia, liczba całkowita0-1
pwmDuty¶
Ustawia cykl pracy (współczynnik wypełnienia) dla wyjścia PWM.
pwmDuty[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- cykl pracy w procentach, liczba całkowita0-100
pwmActiveLow¶
Ustawia tryb Aktywny niski, co odwraca działania włącznika i współczynnika wypełnienia dla wyjścia PWM.
pwmActiveLow[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- liczba całkowita0-1
pwmModeOnOff¶
Ustawia tryb Tryb ON/OFF, co sprawia, że wyjście PWM zmienia się w wyjście dwustanowe: włącz/wyłącz
pwmModeOnOff[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- liczba całkowita0-1
pwmFrequency¶
Ustawia częstotliwość dla wyjść PWM.
pwmFrequency=[A]
A- częstotliwość w Hz, liczba całkowita1-1000000
pwmChangeTime¶
Ustawia czas, w którym współczynnik wypełnienia sygnału zostanie zmieniony.
pwmChangeTime[A]=[B]
A- numer wyjścia, liczba całkowita1-3B- czas w sekundach, liczba całkowita0-2147483647
Wejścia¶
iAName¶
Ustawia nazwę dla wejścia analogowego.
iAName[A]=[B]
A- numer wejścia, liczba całkowita1-3B- ciąg do 15 znaków
iASensor¶
Ustawia czujnik dla wejścia.
iASensor[A]=[B]
A- numer wejścia, liczba całkowita1-3-
B- określa czujnik podłączony do wejścia, liczba całkowita0-16{ 0: "off", 1: "vin=3.3V/5V", // 5V dla iA3 2: "vin=58V", 3: "ACS711EX_15", 4: "ACS711EX_30", 5: "ACS709_75", 6: "R=0.1", 7: "LA100-P", 8: "SCT-013-000", 9: "SCT-013-030", 10: "PT1000", 11: "4..20mA", 12: "AC meter", 13: "ACS711LC-12.5A", 14: "ACS711LC-25A", 15: "ACS712-20A", 16: "WCS1800", }
iACalibration¶
Ustawia kalibrację dla wejścia.
iACalibration[A]=[B]
A- numer wejścia, liczba całkowita1-3B- wartość kalibracji, liczba całkowita
iAMultiplier¶
Ustawia mnożnik dla odczytu wejścia.
iAMultiplier[A]=[B]
A- numer wejścia, liczba całkowita1-3B- mnożnik, liczba rzeczywista
dsName¶
Ustawia nazwę odczytu DS.
dsName[A]=[B]
A- numer czujnika DS, liczba całkowita1-8B- ciąg do 15 znaków
i2cTempName¶
Ustawia nazwę odczytu temperatury czujnika I2C.
i2cTempName=[A]
A- ciąg do 15 znaków
i2cHumName¶
Ustawia nazwę odczytu wilgotności czujnika I2C.
i2cHumName=[A]
A- ciąg do 15 znaków
i2cPressureName¶
Ustawia nazwę odczytu ciśnienia czujnika I2C.
i2cPressureName=[A]
A- ciąg do 15 znaków
i2cPressureCal¶
Ustawia kalibrację dla odczytu ciśnienia czujnika I2C.
i2cPressureCal=[A]
A- ilość metrów nad poziomem morza, liczba całkowita
pmName¶
Ustawia nazwę dla odczytu PM.
pm[A]Name=[B]
A- identyfikator odczytu1- PM1.0,2- PM2.5,4- PM4.0,10- PM10.0B- ciąg do 15 znaków
co2Name¶
Ustawia nazwę dla odczytu CO2.
co2Name=[A]
A- ciąg do 15 znaków
diffName¶
Dodane w SW 1.06
Ustawia nazwę dla odczytu DIFF.
diffName[A]=[B]
A- numer pomiaru DIFF, liczba całkowita1-6B- ciąg do 15 znaków
diffConfig1S¶
Ustawia pierwsze wejście dla operacji DIFF.
diffConfig1S[A]=[B]
A- numer pomiaru DIFF, liczba całkowita1-6-
B- numer wejścia, liczba całkowita0-42{ 0: 'INPA1', 1: 'INPA2', 2: 'INPA3', 3: 'DS1', 4: 'DS2', 5: 'DS3', 6: 'DS4', 7: 'DS5', 8: 'DS6', 9: 'DS7', 10: 'DS8', 11: 'T1', 12: 'H1', 13: 'Dew Point', 14: 'POWER1', 15: 'POWER2', 16: 'POWER3', 17: 'POWER4', 18: 'POWER5', 19: 'POWER6', 20: 'ENERGY1', 21: 'ENERGY2', 22: 'ENERGY3', 23: 'ENERGY4', 24: 'ENERGY5', 25: 'ENERGY6', 26: 'VCC', 27: 'DIFF1', 28: 'DIFF2', 29: 'DIFF3', 30: 'DIFF4', 31: 'DIFF5', 32: 'DIFF6', 33: 'm1', // dodane w SW 1.43 34: 'm2', // dodane w SW 1.43 35: 'm3', // dodane w SW 1.43 36: 'm4', // dodane w SW 1.43 37: 'm5', // dodane w SW 1.43 38: 'm6', // dodane w SW 1.43 39: 'm7', // dodane w SW 1.43 40: 'm8', // dodane w SW 1.43 41: 'm9', // dodane w SW 1.43 42: 'm10', // dodane w SW 1.43 }
diffConfig2S¶
Ustawia drugie wejście dla operacji DIFF.
diffConfig2S[A]=[B]
A- numer pomiaru DIFF, liczba całkowita1-6B- numer wejścia, liczba całkowita0-32, lista wartości
diffConfigO¶
Ustawia operator dla operacji DIFF.
diffConfigO[A]=[B]
A- numer pomiaru DIFF, liczba całkowita1-6-
B- numer operatora, liczba całkowita0-3{ 0: '-', 1: '+', 2: '*', 3: '/', }
iDName¶
Ustawia nazwę dla wejścia cyfrowego.
iDName[A]=[B]
A- numer wejścia cyfrowego, liczba całkowita1-4B- ciąg do 15 znaków
iDNegation¶
Aktywuje negację dla wejścia cyfrowego. Sprawia, że 1 jest prezentowane jako OFF, a 0 jako ON.
iDNegation[A]=[B]
A- numer wejścia cyfrowego, liczba całkowita1-4B- liczba całkowita0-1
iDBistable¶
Aktywuje tryb pracy bistabilnej dla wejścia.
iDBistable[A]=[B]
A- numer wejścia cyfrowego, liczba całkowita1-4B- liczba całkowita0-1
iDBistableTime¶
Ustawia czas dla trybu pracy bistabilnej.
iDBistableTime[A]=[B]
A- numer wejścia cyfrowego, liczba całkowita1-4B- czas w sekundach, liczba całkowita0-65535
iDCountImpulse¶
Aktywuje funkcję Czas impulsu dla wejścia.
iDCountImpulse[A]=[B]
A- numer pary wejść cyfrowych, liczba całkowita1-2B- liczba całkowita0-1
Czujniki¶
dsReadID¶
Odczytuje kolejny DS ID i umieszcza go w zmiennej dsReadID do odczytu.
dsReadID=0
dsID¶
Ustawia ID czujnika DS na danej pozycji.
dsID[A]=[B]
A- numer czujnika DS, liczba całkowita1-8B- ID do ustawienia, ciąg znaków w postaciXX:XX:XX:XX:XX:XX:XX:XX, gdzieXto0-9, A-F
dsOffset¶
Ustawia offset dla odczytu DS.
dsOffset[A]=[B]
A- numer czujnika DS, liczba całkowita1-8B- offset do ustawienia, liczba rzeczywista
i2cFrequency¶
Ustawia częstotliwość komunikacji I2C z czujnikiem.
i2cFrequency=[A]
A- częstotliwość w kHz, liczba całkowita5-100
i2cSensor¶
Ustawia typ podstawowego czujnika I2C.
i2cSensor=[A]
-
A- numer czujnika, liczba całkowita0-5{ 0: 'None', 1: 'BME280', 2: 'AM2320', 3: 'HTS221', 4: 'BME680', 5: 'AM2301B/AHT25/AHT20', }
i2cPMSensor¶
Ustawia typ czujnika PM I2C.
i2cPMSensor=[A]
-
A- numer czujnika, liczba całkowita0-2{ 0: 'None', 1: 'SPS30', 2: 'APM10', }
i2cCO2Sensor¶
Ustawia typ czujnika CO2 I2C.
i2cCO2Sensor=[A]
-
A- numer czujnika, liczba całkowita0-2{ 0: 'None', 1: 'SCD40', 2: 'ACD10', }
i2cINA740Sensor¶
Dostępne od SW 1.24
Aktywuje obsługę czujnika INA740 w czujnikach dodatkowych I2C.
i2cINA740Sensor=[A]
A- liczba całkowita0-1
i2cMLX90614Sens¶
Dostępne od SW 1.38
Aktywuje obsługę czujnika MLX90614 w czujnikach dodatkowych I2C.
i2cMLX90614Sens=[A]
A- liczba całkowita0-1
i2cDetect¶
Wykrywa podłączony czujnik I2C.
i2cDetect=1
Port szeregowy¶
uartSensor¶
Ustawia obsługę modułu podłączonego do portu szeregowego.
uartSensor=[A]
-
A- numer modułu, liczba całkowita0-6{ 0: "OFF", 1: "DURALUX", 2: "PM SDS011", 3: "CO2 MH-Z16/19", 4: "PM SPS30", 5: "Bar/Qr Code Scanner", 6: "Ultrasonic distance sensor", }
Modbus¶
modbusSensor¶
Wybiera moduł podłączony do portu Modbus.
modbusSensor[A]=[B]
A- numer slotu Modbus, liczba całkowita1-5-
B- numer podłączonego modułu, liczba całkowita0-6,100-104{ 0: "OFF", 1: "SDM120", 2: "SDM72D-M", 3: "Epever Tracer", 4: "Sofarsolar", 5: "SDM630/72D-v2", 6: "CHINT-DTSU666", 100: "custom1 (custom)", 101: "custom2 (custom)", 102: "custom3 (custom)", 103: "custom4 (custom)", 104: "custom5 (custom)", }
modbusID¶
Ustawia ID obsługiwanego modułu Modbus.
modbusID[A]=[B]
A- numer slotu Modbus, liczba całkowita1-5B- ID, liczba całkowita
modbusCConfig¶
Ustawia nazwę niestandardowego urządzenia Modbus i parametry komunikacji jak bitrate, bit parzystości i bit stopu.
modbusCConfig[A]=[B]*[C]*[D]*[E]*[F]
A- numer niestandardowej konfiguracji, liczba całkowita1-5B- nazwa, ciąg do 15 znaków-
C- bitrate, liczba całkowita0-5{ 0: "9600", 1: "19200", 2: "38400", 3: "57600", 4: "115200", 5: "4800", } -
D- bit parzystości, liczba całkowita0-2{ 0: "none", 1: "even", 2: "odd", } -
E- bit stopu, liczba całkowita1-2 F- opóźnienie pomiędzy odczytami rejestrów, liczba rzeczywista0.001-0.255(przed SW 1.38 zakres0.1-22.5)
modbusCField¶
Ustawia parametry odczytu dla niestandardowego urządzenia Modbus, takie jak nazwę, jednostkę, dzielnik, adres rejestru, kod funkcji, typ (rodzaj), endian.
modbusCField[A][B]=C*D*E*F*G*H*I
A- numer niestandardowej konfiguracji, liczba całkowita1-5B- numer odczytu, liczba całkowita1-30C- nazwa odczytu, ciąg do 15 znakówD- jednostka, ciąg do 7 znaków-
E- dzielnik, liczba całkowita0-4{ 0: "1", 1: "10", 2: "100", 3: "1000", 4: "10000", } -
F- adres rejestru w formacie dziesiętnym, liczba całkowita -
G- kod funkcji, liczba całkowita1-4{ 1: "0x01", 2: "0x02", 3: "0x03", 4: "0x04", } -
H- typ zmiennej, liczba całkowita0-2{ 0: "int16", 1: "int32", 2: "float", } -
I- określa opcję endian, liczba całkowita0-3{ 0: "no swap", 1: "swap byte", 2: "swap word", 3: "swap byte and word", }
modbusCommand¶
Dodane w SW 1.42
Ustawia wpis polecenia Modbus RTU na danej pozycji.
modbusCommand[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]
A- numer wpisu polecenia, liczba całkowita1-10B- określa, czy wpis jest ustawiony (1- ustawiony), liczba całkowita0-1C- nazwa, ciąg do 15 znakówD- ID modułu Modbus, liczba całkowita1-255-
E- bitrate, liczba całkowita0-5{ 0: "9600", 1: "19200", 2: "38400", 3: "57600", 4: "115200", 5: "4800", } -
F- bit parzystości, liczba całkowita0-2{ 0: "none", 1: "even", 2: "odd", } -
G- bit stopu, liczba całkowita1-2 H- adres rejestru w formacie dziesiętnym, liczba całkowita-
I- kod funkcji, liczba całkowita5, 6, 15, 16{ 5: "0x05", 6: "0x06", 15: "0x0F", 16: "0x10", } -
J- ilość zapisywanych rejestrów, liczba całkowita:1dla kodów funkcji (I)0x05i0x06,1-32dla kodów funkcji (I)0x0Fi0x10 K- ciąg wartości do ustawienia w rejestrach, do 32 liczb całkowitych0-65535rozdzielonych znakiem,(ilość musi się zgadzać z wartościąJ)
runModbusCommand¶
Dodane w SW 1.42
Wysyła polecenie Modbus RTU skonfigurowane na danej pozycji.
runModbusCommand=[A]
A- numer wpisu polecenia, liczba całkowita1-10
modbusTCPServer¶
Aktywuje serwer Modbus TCP.
Uwaga, aby zastosować tą zmianę wymagane jest ponowne uruchomienie urządzenia.
modbusTCPServer=[A]
A- określa, czy funkcja jest włączona, liczba całkowita0-1
Mapowanie odczytów¶
mConfig¶
Ustawia mapowanie odczytów (Modbus lub dodatkowych czujników I2C) do zmiennych m1-m30, które można wykorzystać w kliencie HTTP, kliencie MQTT, OLED, VOLED, Moc i energia oraz Zdarzeniach.
mConfig[A]=[B]*[C]
A– numer zmiennej m, liczba całkowita1-30B– numer slotu, liczba całkowita0-100– brak wyboru1-5– sloty modułów Modbus6-10– sloty dodatkowych czujników I2C
C– numer odczytu, liczba całkowita:0– brak wyboru (w parze zB=0)1-30– numer odczytu dla Modbus1-5– numer odczytu dla dodatkowych czujników I2C
Wartość mConfig[A]=0*0 powoduje dezaktywację mapowania dla danej zmiennej m.
Moc i energia¶
powerName¶
Ustawia nazwę dla pomiaru mocy i energii.
powerName[A]=[B]
A- numer pomiaru, liczba całkowita1-6B- ciąg do 15 znaków
powerIOption¶
Ustawia źródło mierzonej mocy lub składową I.
powerIOption[A]=[B]
A- numer pomiaru, liczba całkowita1-6-
B- źródło pomiaru, liczba całkowita0-10{ 0: 'INPA1', 1: 'INPA2', 2: 'INPA3', 3: 'INPD1', 4: 'INPD2', 5: 'INPD3', 6: 'INPD4', 7: 'm1', 8: 'm2', 9: 'm3', 10: 'm4', }
Opcje m1–m4 są traktowane jako bezpośrednia wartość mocy (a nie jako składowa I). W takim przypadku pole powerUOption nie ma zastosowania.
powerUOption¶
Ustawia składową U dla pomiaru mocy.
powerUOption[A]=[B]
A- numer pomiaru, liczba całkowita1-6-
B- składowa U, liczba całkowita0-6{ 0: 'INPA1', 1: 'INPA2', 2: 'INPA3', 3: '225V', 4: '230V', 5: '235V', 6: 'VCC', }Od wersji SW 1.39 opcje
m1–m4nie są już dostępne wpowerUOption, ponieważ ich działanie było identyczne jak w przypadku wyboru ich wpowerIOption. Zmiana ta upraszcza konfigurację i eliminuje niejednoznaczność.
Opcja powerUOption jest aktywna wyłącznie wtedy, gdy powerIOption ma wartość 0–2 (INPA1–INPA3).
Dla pozostałych wartości powerIOption parametr powerUOption jest ignorowany.
powerUnit¶
Ustawia jednostkę dla odczytu mocy/energii.
Informacja o wpływie tej opcji na wartość mocy.
powerUnit[A]=[B]
A- numer pomiaru, liczba całkowita1-6-
B- jednostka do użycia, liczba całkowita0-5{ 0: { power: 'kW', energy: 'kWh' }, 1: { power: 'W', energy: 'kWh' }, 2: { power: 'l/min', energy: 'm3' }, 3: { power: 'm3/h', energy: 'm3' }, 4: { power: 'kW -> W', energy: 'kWh' }, 5: { power: 'W -> kW', energy: 'kWh' }, }
powerImpulses¶
Ustawia współczynnik konwersji impulsów na jednostki mocy.
powerImpulses[A]=[B]
A- numer pomiaru, liczba całkowita1-6B- ilość impulsów, liczba całkowita
energySet¶
Ustawia stan pomiaru energii.
energySet[A]=[B]
A- numer pomiaru, liczba całkowita1-6B- wartość energii (z jednostką podyktowaną wyborem powerIOption), liczba rzeczywista
Note
Wartość energii w energy zmienia się tylko wtedy, gdy włączone jest powerCounting.
powerCounting¶
Aktywuje pomiar energii. Może być kontrolowana w Harmonogramie w celu pomiaru energii w rożnych przedziałach czasowych (rożne taryfy).
powerCounting[A]=[B]
A- numer pomiaru, liczba całkowita1-6B- liczba całkowita0-1
powerSaveToMem¶
Aktywuje funkcję zapamiętywania wartości energii po restarcie urządzenia (cykliczny zapis stanu energii do pamięci stałej).
powerSaveToMem=[A]
A- liczba całkowita0-1
powerPriceEnbl¶
Dostępne od SW 1.24
Włącza lub wyłącza funkcję dynamicznych cen energii.
powerPriceEnbl=[A]
A- liczba całkowita0-10- funkcja wyłączona1- funkcja włączona
powerPriceMode¶
Dostępne od SW 1.24
Określa tryb pracy funkcji cen energii – czy cena ma być pobierana cyklicznie z API, czy ma być używana stała wartość zdefiniowana w zmiennej powerPriceFVal.
powerPriceMode=[A]
-
A- liczba całkowita0-1{ 0: 'Ceny dynamiczne (API)', 1: 'Ceny stałe', }
powerPriceDVal¶
Dostępne od SW 1.24
Ustawia wartość offsetu dodawaną do ceny pobieranej z API.
powerPriceDVal=[A]
A- liczba rzeczywista
powerPriceDAPI¶
Dostępne od SW 1.24
Ustawia źródło API, z którego pobierana jest dynamiczna cena energii.
powerPriceDAPI=[A]
-
A- liczba całkowita0-2{ 0: 'PSE RCE (api.raporty.pse.pl)', 1: 'Instrat RDN (energy-api.instrat.pl)', 2: 'spotovaelektrina.cz/api', // dodane w SW 1.38 }
powerPriceFVal¶
Dostępne od SW 1.24
Przechowuje aktualną wartość ceny energii.
- W trybie Ceny stałe (
powerPriceMode=1) ustawia stałą wartość ceny energii. - W trybie Ceny dynamiczne (
powerPriceMode=0) przechowuje ostatnio pobraną wartość ceny z API.
Jeżeli funkcja dynamicznych cen energii jest włączona (powerPriceEnbl=1), aktualna wartość ceny energii jest również zapisywana w zmiennej m1.
powerPriceFVal=[A]
A- liczba rzeczywista
Zdarzenia¶
event¶
Ustawia wpis zdarzenia na danej pozycji.
event[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]*[M]*[N]*[O]*[P]*[R]*[S]*[T]
A- pozycja, liczba całkowita1-20B- określa, czy wpis jest ustawiony (1- ustawiony), liczba całkowita0-1C- określa, czy wpis jest aktywny, liczba całkowita0-1-
D,J- źródła (dane wejściowe) warunków (kolejno pierwszego i drugiego), liczba całkowita0-51, 100-121{ // Analogowe 0: 'VCC', 1: 'TEMP', 2: 'HUM', 3: 'INPA1', 4: 'INPA2', 5: 'INPA3', 6: 'T1', 7: 'H1', 8: 'P1', 9: 'DS1', 10: 'DS2', 11: 'DS3', 12: 'DS4', 13: 'DS5', 14: 'DS6', 15: 'DS7', 16: 'DS8', 17: 'DIFF1', 18: 'DIFF2', 19: 'DIFF3', 20: 'DIFF4', 21: 'DIFF5', 22: 'DIFF6', 23: 'CO2', 24: 'PM1.0', 25: 'PM2.5', 26: 'PM4.0', 27: 'PM10.0', 28: 'POWER1', 29: 'POWER2', 30: 'POWER3', 31: 'POWER4', 32: 'POWER5', 33: 'POWER6', 34: 'ENERGY1', 35: 'ENERGY2', 36: 'ENERGY3', 37: 'ENERGY4', 38: 'ENERGY5', 39: 'ENERGY6', 40: 'm1', 41: 'm2', 42: 'm3', 43: 'm4', 44: 'm5', 45: 'm6', 46: 'm7', 47: 'm8', 48: 'm9', 49: 'm10', 50: 'Dew Point', 51: 'Distance sensor', // Cyfrowe 100: 'INPD1', 101: 'INPD2', 102: 'INPD3', 103: 'INPD4', 104: 'VAR1', 105: 'VAR2', 106: 'VAR3', 107: 'VAR4', 108: 'VAR5', 109: 'VAR6', 110: 'VAR7', 111: 'VAR8', 112: 'OUT1', 113: 'OUT2', 114: 'OUT3', 115: 'OUT4', 116: 'OUT5', 117: 'OUT6', 118: 'PWM1', 119: 'PWM2', 120: 'PWM3', 121: 'MQTT CONNECTION', } -
E,K- operator warunku dla źródeł analogowych (dla cyfrowych zawsze używane=), liczba całkowita0-1{ 0: '>=', 1: '<', } -
F,L- wartości odniesienia dla warunków, liczba rzeczywista (dla źródła cyfrowego liczba całkowita0-1) G,M- wartości histerezy dla warunków, liczba rzeczywista-
H- operator między warunkami, liczba całkowita0-5{ 0: '-', 1: 'AND', 2: 'OR', 3: 'NAND', 4: 'NOR', 5: 'XOR', } -
I- działanie do wykonania, liczba całkowita0-59{ 0: 'OUT1', 1: 'OUT2', 2: 'OUT3', 3: 'OUT4', 4: 'OUT5', 5: 'OUT6', 6: 'PWM1', 7: 'PWM2', 8: 'PWM3', 9: 'VAR1', 10: 'VAR2', 11: 'VAR3', 12: 'VAR4', 13: 'VAR5', 14: 'VAR6', 15: 'VAR7', 16: 'VAR8', 17: 'AutoSwitch OUT1', 18: 'AutoSwitch OUT2', 19: 'AutoSwitch OUT3', 20: 'AutoSwitch OUT4', 21: 'AutoSwitch OUT5', 22: 'AutoSwitch OUT6', 23: 'HTTP1', 24: 'HTTP2', 25: 'HTTP3', 26: 'HTTP4', 27: 'eMail 1', 28: 'eMail 2', 29: 'eMail 3', 30: 'eMail 4', 31: 'SMS1', 32: 'SMS2', 33: 'SMS3', 34: 'SMS4', 35: 'RESET ENERGY1', 36: 'RESET ENERGY2', 37: 'RESET ENERGY3', 38: 'RESET ENERGY4', 39: 'RESET ENERGY5', 40: 'RESET ENERGY6', 41: 'SNMP trap', 42: 'MQTT', 43: 'OLED ON/NEXT SCREEN', 44: 'OLED - SET SCREEN 1', 45: 'OLED - SET SCREEN 2', 46: 'OLED - SET SCREEN 3', 47: 'OLED - SET SCREEN 4', 48: 'ENABLE PID', 49: 'RESTART', // dodane w SW 1.24 50: 'Modbus command 1', // dodane w SW 1.42 51: 'Modbus command 2', // dodane w SW 1.42 52: 'Modbus command 3', // dodane w SW 1.42 53: 'Modbus command 4', // dodane w SW 1.42 54: 'Modbus command 5', // dodane w SW 1.42 55: 'Modbus command 6', // dodane w SW 1.42 56: 'Modbus command 7', // dodane w SW 1.42 57: 'Modbus command 8', // dodane w SW 1.42 58: 'Modbus command 9', // dodane w SW 1.42 59: 'Modbus command 10', // dodane w SW 1.42 } -
N- określa, czy dla wpisu zdarzenia jest włączona funkcja Permanent (Per). Ma wpływ tylko na działania OUT i VAR. Sprawia, że działanie jest wykonywane przy każdym sprawdzeniu warunków, zamiast tylko przy zmianie stanu warunków (zaczynają być spełnione lub przestają, czyli niejako przy przejściu progu). Liczba całkowita0-1 O- opóźnienie wyłączenia, czyli czas w sekundach o jaki zostanie opóźniona dezaktywacja działania, po tym jak warunek przestanie być spełniany. Do ustawienia tylko dla działań OUT, VAR. Liczba całkowita.-
P- wartość dla działań typu OUT, VAR (dla pozostałych nie ma wpływu). Liczba całkowita0-2.{ 0: '0', 1: '1', 2: 'Reverse', } -
R- opóźnienie włączenia, czyli czas w sekundach o jaki zostanie opóźniona aktywacja działania, po tym jak warunek zacznie być spełniany. Do ustawienia tylko dla działań OUT, VAR. Liczba całkowita. S- zależność od wyniku warunków innego zdarzenia, np. uzależnienie wpisu 2 od wyniku warunków wpisu 1. Liczba całkowita0-40(0- nieaktywne,1-20- niespełnione warunki odpowiednio EV 1 - EV 20,21-40- spełnione warunki odpowiednio EV 1 - EV 20).-
T- tryb działania. Pozwala określić, kiedy zostanie wykonana akcja zdarzenia – kiedy warunek zacznie być spełniany, kiedy przestanie być spełniany, lub w obu przypadkach (zachowanie domyślne). Liczba całkowita0-2.{ "0": "Akcja, gdy warunek zaczyna lub przestaje być spełniony", "1": "Akcja tylko wtedy, gdy warunek zaczyna być spełniany", "2": "Akcja tylko wtedy, gdy warunek przestaje być spełniony" }
Usuwanie wpisu
Aby wpis był niewidoczny (nieustawiony) na liście w interfejsie webowym musi mieć ustawione 0 w polu B.
Harmonogramy (Scheduler)¶
schedule¶
Ustawia wpis harmonogramu (Scheduler).
schedule[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]*[M]*[N]
A- numer wpisu, liczba całkowita1-50B- określa, czy wpis jest ustawiony (1- ustawiony), liczba całkowita0-1C- nazwa wpisu, ciąg do 15 znaków-
D- działanie do wykonania, liczba całkowita0-40{ 0: 'OUT1', 1: 'OUT2', 2: 'OUT3', 3: 'OUT4', 4: 'OUT5', 5: 'OUT6', 6: 'PWM1', 7: 'PWM2', 8: 'PWM3', 9: 'VAR1', 10: 'VAR2', 11: 'VAR3', 12: 'VAR4', 13: 'VAR5', 14: 'VAR6', 15: 'VAR7', 16: 'VAR8', 17: 'RESTART', 18: 'RESET ENERGY1', 19: 'RESET ENERGY2', 20: 'RESET ENERGY3', 21: 'RESET ENERGY4', 22: 'RESET ENERGY5', 23: 'RESET ENERGY6', 24: 'OLED ON/NEXT SCREEN', 25: 'COUNT ENERGY1', 26: 'COUNT ENERGY2', 27: 'COUNT ENERGY3', 28: 'COUNT ENERGY4', 29: 'COUNT ENERGY5', 30: 'COUNT ENERGY6', 31: 'Modbus command 1', // dodane w SW 1.42 32: 'Modbus command 2', // dodane w SW 1.42 33: 'Modbus command 3', // dodane w SW 1.42 34: 'Modbus command 4', // dodane w SW 1.42 35: 'Modbus command 5', // dodane w SW 1.42 36: 'Modbus command 6', // dodane w SW 1.42 37: 'Modbus command 7', // dodane w SW 1.42 38: 'Modbus command 8', // dodane w SW 1.42 39: 'Modbus command 9', // dodane w SW 1.42 40: 'Modbus command 10', // dodane w SW 1.42 } -
E- wartość działania, liczba całkowita0-2{ 0: '0', 1: '1', 2: 'Reverse', } -
F- binarny zapis 32 kolejnych sekund (0-31, dla każdej wartość0-1), liczba całkowita0-4294967295 G- binarny zapis 28 kolejnych sekund (32-59, dla każdej wartość0-1), liczba całkowita0-268435455H- binarny zapis 32 kolejnych minut (0-31, dla każdej wartość0-1), liczba całkowita0-4294967295I- binarny zapis 28 kolejnych minut (32-59, dla każdej wartość0-1), liczba całkowita0-268435455J- binarny zapis 24 kolejnych godzin (0-23, dla każdej wartość0-1), liczba całkowita0-16777215K- binarny zapis 31 kolejnych dni miesiąca (0-30, dla każdej wartość0-1), liczba całkowita0-2147483647L- binarny zapis 12 kolejnych miesięcy (0-11, dla każdej wartość0-1), liczba całkowita0-4095M- binarny zapis 7 kolejnych dni tygodnia (0-6, Poniedziałek - Niedziela, dla każdej wartość0-1), liczba całkowita0-127N- określa, czy wpis jest aktywny, liczba całkowita0-1
Watchdog¶
wdConfig¶
Ustawia parametry dla funkcji Watchdog na danej pozycji.
wdConfig[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]
A- numer wpisu, liczba całkowita1-7B- określa, czy wpis jest włączony, liczba całkowita0-1C- określa, czy wysyłanie wiadomości e-mail jest włączone, liczba całkowita0-1-
D- określa, które wyjście jest sterowane, liczba całkowita0-16{ 0: 'OUT1', 1: 'OUT2', 2: 'OUT3', 3: 'OUT4', 4: 'OUT5', 5: 'OUT6', 6: 'PWM1', 7: 'PWM2', 8: 'PWM3', 9: 'VAR1', 10: 'VAR2', 11: 'VAR3', 12: 'VAR4', 13: 'VAR5', 14: 'VAR6', 15: 'VAR7', 16: 'VAR8', } -
E- adres IP/domena do monitorowania, ciąg znaków F- ilość kolejnych niepowodzeń ping przed restartem wyjścia, liczba całkowitaG- limit czasu w sekundach dla polecenia ping, liczba całkowitaH- czas w sekundach między testami ping, liczba całkowitaI- opóźnienie wznowienia polecenia ping po restarcie wyjścia, w sekundach, liczba całkowitaJ- czas restartowania wyjścia w sekundach, liczba całkowitaK- ilość kolejnych restartów przed zatrzymaniem funkcji watchdog (wartość 0 oznacza brak limitu), liczba całkowitaL- opóźnienie uruchomienia funkcji watchdog po uruchomieniu urządzenia w sekundach, liczba całkowita
Zdalne sterowanie¶
remoteEnabled¶
Aktywuje funkcje zdalnego sterowania.
remoteEnabled=[A]
A- liczba całkowita0-1
remoteHost¶
Ustawia adres kontrolowanego LAN Kontrolera.
remoteHost=[A]
A- ciąg do 48 znaków
remotePort¶
Ustawia port do komunikacji z innym LAN Kontrolerem.
remotePort=[A]
A- liczba całkowita1-65535
remotePassword¶
Ustawia hasło do komunikacji.
remotePassword=[A]
A- ciąg do 16 znaków
remoteNegation¶
Określa, czy na wyjściu ma być ustawiony stan wejścia, czy jego zanegowana wartość. Na przykład INPD1 = 0 bez negacji spowoduje ustawienie OUT1 na 0, ale z włączoną negacją na 1.
remoteNegation=[A]
A- liczba całkowita0-4095(12 bitów kolejno dla INPD1-INPD4, VAR1-VAR8)
remoteInputs¶
Określa, które wyjścia będą sterowane przy zmianach wejść INPD1-INPD4, VAR1-VAR8.
remoteInputs[A]=[B]
A- numer wejścia, liczba całkowita1-12(kolejno INPD1-INPD4, VAR1-VAR8)B- wyjścia, które będą sterowane, gdy zmieni się stan wejścia, liczba całkowita0-131071(17 bitów kolejno dla OUT1-OUT6, PWM1-PWM3, VAR1-VAR8)
Klient HTTP¶
httpModem¶
Usunięte w wersji SW 1.18a. Urządzenie automatycznie określa priorytety interfejsów.
Sprawia, że zapytania HTTP będą wysyłane za pośrednictwem modemu, zamiast połączenia Ethernet.
httpModem=[A]
A- liczba całkowita0-1
httpReadingCode¶
Zmienia format do wstawiania odczytów z urządzenia z %XXXA na %%XXXA, czyli wymaga podwójnego znaku %.
httpReadingCode=[A]
A- liczba całkowita0-1
httpDigestAuth¶
Sprawia, że przy zapytaniu HTTP jest używana metoda Digest Authentication po nieudanej próbie z Basic Authentication.
httpDigestAuth=[A]
A- liczba całkowita0-1
httpPerEnabled¶
Dostępne od SW 1.06
Aktywuje okresowe wysyłanie żądania HTTP.
httpPerEnabled=[A]
A- liczba całkowita0-1
httpPerPeriod¶
Dostępne od SW 1.06
Ustawia okres wysyłania w sekundach dla funkcji okresowego wysyłania.
httpPerPeriod=[A]
A- liczba całkowita5-...
httpPerURL¶
Dostępne od SW 1.06
Ustawia adres URL żądania w funkcji wysyłania okresowego.
httpPerURL=[A]
-
A- ciąg do 1000 znaków w formaciehttp(s)://([NAZWA_UŻYTKOWNIKA]:[HASŁO]@)[HOST(DOMENA LUB IP):[PORT][ŚCIEŻKA], np.http://admin:admin@192.168.1.100:80/api/v1/save/?out=out1Może zawierać kody odczytów - dowiedz się więcej.
httpPerMethod¶
Dostępne od SW 1.38
Ustawia metodę żądania w funkcji wysyłania okresowego.
httpPerMethod=[A]
-
A- określa metodę żądania, liczba całkowita0-3{ 0: 'GET', 1: 'POST', 2: 'PUT', 3: 'PATCH', }
httpPerHeaders¶
Dostępne od SW 1.38
Ustawia nagłówki żądania dla funkcji okresowego wysyłania.
httpPerHeaders=[A]
A- Nagłówki żądania HTTP w formacie tekstowymNazwa: wartość, przy czym każdy nagłówek powinien być zdefiniowany w osobnej linii (oddzielone znakiem nowej linii\n), ciąg do 1023 znaków
httpPerBody¶
Dostępne od SW 1.38
Ustawia treść żądania dla funkcji wysyłania okresowego.
- obsługiwana jest wyłącznie treść tekstowa (np. JSON, XML),
- nie są obsługiwane dane binarne.
Dotyczy tylko metod żądania innych niż GET.
httpPerBody=[A]
-
A- Treść żądania, ciąg do 1023 znakówMoże zawierać kody odczytów - dowiedz się więcej.
httpURLEv¶
Dostępne od SW 1.06
Ustawia adres URL żądania dla akcji w funkcji Zdarzenia (działanie HTTP z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony).
httpURLEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania HTTP, liczba całkowita1-4-
C- ciąg znaków w formaciehttp(s)://([NAZWA_UŻYTKOWNIKA]:[HASŁO]@)[HOST(DOMENA LUB IP):[PORT][ŚCIEŻKA], np.http://admin:admin@192.168.1.100:80/api/v1/save/?out=out1Może zawierać kody odczytów - dowiedz się więcej.
httpMethodEv¶
Dostępne od SW 1.38
Ustawia metodę żądania dla akcji w funkcji Zdarzenia.
httpMethodEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania HTTP, liczba całkowita1-4-
C- określa metodę żądania, liczba całkowita0-3{ 0: 'GET', 1: 'POST', 2: 'PUT', 3: 'PATCH', }
httpHeadersEv¶
Dostępne od SW 1.38
Ustawia nagłówki żądania dla akcji w funkcji Zdarzenia.
httpHeadersEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania HTTP, liczba całkowita1-4C- Nagłówki żądania HTTP w formacie tekstowymNazwa: wartość, przy czym każdy nagłówek powinien być zdefiniowany w osobnej linii (oddzielone znakiem nowej linii\n), ciąg do 1023 znaków
httpBodyEv¶
Dostępne od SW 1.38
Ustawia treść żądania dla akcji w funkcji Zdarzenia.
- obsługiwana jest wyłącznie treść tekstowa (np. JSON, XML),
- nie są obsługiwane dane binarne.
Dotyczy tylko metod żądania innych niż GET.
httpBodyEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania HTTP, liczba całkowita1-4-
C- Treść żądania, ciąg do 1023 znakówMoże zawierać kody odczytów - dowiedz się więcej.
httpEnabled¶
Usunięte w wersji SW 1.06. Zamiast należy używać httpPerEnabled.
Aktywuje okresowe wysyłanie pierwszego ustawionego wpisu zapytania HTTP GET.
httpEnabled=[A]
A- liczba całkowita0-1
httpPeriod¶
Usunięte w wersji SW 1.06. Zamiast należy używać httpPerPeriod.
Ustawia okres wysyłania w sekundach dla funkcji okresowego wysyłania.
httpPeriod=[A]
A- liczba całkowita5-...
httpHost¶
Usunięte w wersji SW 1.06. Zamiast należy używać httpPerURL i httpURLEv.
Ustawia adres IP / domenę z opcjonalnymi danymi uwierzytelniania metodą Basic Authentication/Digest Authentication. Musi również zawierać wybór http lub https.
httpHost[A]=[B]
A- numer pozycji do ustawienia, liczba całkowita1-4B- protokół, adres IP/domena i opcjonalne dane uwierzytelniania, ciąg znaków, np.http://admin:admin@192.168.1.100
httpPort¶
Usunięte w wersji SW 1.06. Zamiast należy używać httpPerURL i httpURLEv.
Ustawia port, na który będzie wysłane zapytanie.
httpPort[A]=[B]
A- numer pozycji do ustawienia, liczba całkowita1-4B- port, liczba całkowita1-65535
httpPath¶
Usunięte w wersji SW 1.06. Zamiast należy używać httpPerURL i httpURLEv.
Ustawia ścieżkę zapytania.
httpPath[A]=[B]
A- numer pozycji do ustawienia, liczba całkowita1-4B- ścieżka zapytania, z początkowym/, ciąg znaków, np./api/v1/save/?out1=1
Klient MQTT¶
mqttEnabled¶
Aktywuje klienta MQTT.
mqttEnabled=[A]
A- liczba całkowita0-1
mqttAuth¶
Sprawia, że klient będzie używał danych uwierzytelniania (login i hasło).
mqttAuth=[A]
A- liczba całkowita0-1
mqttHost¶
Ustawia adres IP/domenę serwera MQTT do połączenia.
mqttHost=[A]
A- ciąg do 128 znaków
mqttPort¶
Ustawia port serwera MQTT.
mqttPort=[A]
A- port, liczba całkowita1-65535
mqttLogin¶
Ustawia nazwę użytkownika do uwierzytelnienia.
mqttLogin=[A]
A- ciąg do 99 znaków
mqttPassword¶
Ustawia hasło do uwierzytelnienia.
mqttPassword=[A]
A- ciąg do 199 znaków
mqttPrefix¶
Ustawia prefix dla tematów używanych przez urządzenie (subskrypcja i publikowanie).
mqttPrefix=[A]
A- ciąg do 32 znaków (przed wersją SW 1.38 do 13 znaków)
mqttPeriod¶
Ustawia okres wysyłania danych w sekundach.
mqttPeriod=[A]
A- liczba całkowita5-...
mqttKeepAlive¶
Ustawia wartość dla parametru Keep Alive.
mqttKeepAlive=[A]
A- liczba całkowita5-...
mqttTLS¶
Sprawia, że klient będzie używał szyfrowanego połączenia (funkcja musi być oferowana przez serwer).
mqttTLS=[A]
A- liczba całkowita0-1
mqttLWT¶
Sprawia, że klient będzie używał funkcji LWT. W efekcie przy połączeniu z serwerem będzie publikował wiadomość 1 na temat [mqttPrefix]/connected, a w razie gdy klient utraci połączenie z serwerem, to on opublikuje wiadomość 0 na wcześniej wymieniony temat.
mqttLWT=[A]
A- liczba całkowita0-1
mqttModem¶
Usunięte w wersji SW 1.18a. Urządzenie automatycznie określa priorytety interfejsów.
Sprawia, że połączenie MQTT będzie nawiązane za pośrednictwem modemu, zamiast połączenia Ethernet.
mqttModem=[A]
A- liczba całkowita0-1
mqttSend¶
Ustawia, które odczyty będą cyklicznie wysyłane.
mqttSend=[A]
-
A- łańcuch 97 liczb całkowitych0-1, odpowiadający kolejnym odczytom zgodnie z poniższą listą{ 0: 'VCC', 1: 'TEMP', 2: 'HUM', 3: 'INPA1', 4: 'INPA2', 5: 'INPA3', 6: 'DS1', 7: 'DS2', 8: 'DS3', 9: 'DS4', 10: 'DS5', 11: 'DS6', 12: 'DS7', 13: 'DS8', 14: 'T1', 15: 'H1', 16: 'P1', 17: 'DIFF1', 18: 'DIFF2', 19: 'DIFF3', 20: 'DIFF4', 21: 'DIFF5', 22: 'DIFF6', 23: 'INPD1', 24: 'INPD2', 25: 'INPD3', 26: 'INPD4', 27: 'OUT1', 28: 'OUT2', 29: 'OUT3', 30: 'OUT4', 31: 'OUT5', 32: 'OUT6', 33: 'PWM1', 34: 'PWM2', 35: 'PWM3', 36: 'PWM1 Duty', 37: 'PWM2 Duty', 38: 'PWM3 Duty', 39: 'POWER1', 40: 'POWER2', 41: 'POWER3', 42: 'POWER4', 43: 'POWER5', 44: 'POWER6', 45: 'ENERGY1', 46: 'ENERGY2', 47: 'ENERGY3', 48: 'ENERGY4', 49: 'ENERGY5', 50: 'ENERGY6', 51: 'VAR1', 52: 'VAR2', 53: 'VAR3', 54: 'VAR4', 55: 'VAR5', 56: 'VAR6', 57: 'VAR7', 58: 'VAR8', 59: 'PM1.0', 60: 'PM2.5', 61: 'PM4.0', 62: 'PM10.0', 63: 'CO2', 64: 'Distance sensor', 65: 'IAQ', 66: 'm1', 67: 'm2', 68: 'm3', 69: 'm4', 70: 'm5', 71: 'm6', 72: 'm7', 73: 'm8', 74: 'm9', 75: 'm10', 76: 'm11', 77: 'm12', 78: 'm13', 79: 'm14', 80: 'm15', 81: 'm16', 82: 'm17', 83: 'm18', 84: 'm19', 85: 'm20', 86: 'm21', 87: 'm22', 88: 'm23', 89: 'm24', 90: 'm25', 91: 'm26', 92: 'm27', 93: 'm28', 94: 'm29', 95: 'm30', 96: 'UPTIME', 97: 'IP', // dodane w SW 1.06 98: 'Time', // dodane w SW 1.06 99: 'Date', // dodane w SW 1.06 100: 'Dew Point', // dodane w SW 1.06 101: 'Wi-Fi IP', // dodane w SW 1.38 }
mqttSendChanges¶
Ustawia, które odczyty będą wysyłane przy zmianie stanu.
mqttSendChanges=[A]
-
A- łańcuch 3 liczb całkowitych0-1, odpowiadający kolejnym odczytom zgodnie z poniższą listą{ 0: "INPT1", 1: "INPT2", 2: "BARCODE", }
SNMP¶
snmpTrapEnabled¶
Aktywuje funkcję Trap.
snmpTrapEnabled=[A]
A- liczba całkowita0-1
snmpV2Enabled¶
Aktywuje obsługę SNMPv2c.
snmpV2Enabled=[A]
A- liczba całkowita0-1
snmpV3Enabled¶
Aktywuje obsługę SNMPv3.
snmpV3Enabled=[A]
A- liczba całkowita0-1
snmpCommRead¶
Ustawia hasło odczytu.
snmpCommRead=[A]
A- ciąg do 31 znaków
snmpCommWrite¶
Ustawia hasło zapisu.
snmpCommWrite=[A]
A- ciąg do 31 znaków
snmpCommTrap¶
Ustawia hasło Trap.
snmpCommTrap=[A]
A- ciąg do 31 znaków
snmpTrapReceive¶
Ustawia adres odbiornika Trap.
snmpTrapReceive=[A]
A- ciąg znaków
snmpUser¶
Ustawia nazwę użytkownika do uwierzytelnienia (SNMPv3).
snmpUser=[A]
A- ciąg do 31 znaków
snmpAuthPass¶
Ustawia hasło uwierzytelniające (SNMPv3).
snmpAuthPass=[A]
A- ciąg do 19 znaków
snmpPrivacyPass¶
Ustawia hasło prywatności (SNMPv3).
snmpPrivacyPass=[A]
A- ciąg do 19 znaków
Sieć - Ogólne¶
netHostname¶
Ustawia nazwę hosta urządzenia, używana też jako nazwa urządzenia na stronie, np. w tytule.
netHostname=[A]
A- nazwa hosta, ciąg znaków
netHttpPort¶
Ustawia port na którym serwer HTTP urządzenia będzie nasłuchiwał na zapytania (oraz udostępniał stronę).
netHttpPort=[A]
A- liczba całkowita1-65535
netHttpsOn¶
Aktywuje szyfrowanie połączenia HTTP z interfejsem webowym, czyli HTTPS.
Uwaga
Nasłuch HTTPS jest zawsze realizowany na standardowym porcie 443.
netHttpsOn=[A]
A- liczba całkowita0-1
Sieć - Ethernet¶
netMac¶
Ustawia adres MAC urządzenia.
netMac=[A]
A- adres MAC, ciąg znaków
netDhcp¶
Aktywuje pobieranie adresu za pomocą DHCP.
netDhcp=[A]
A- liczba całkowita0-1
netIp¶
Ustawia adres IP urządzenia.
netIp=[A]
A- adres IP, ciąg znaków
netMask¶
Ustawia maskę podsieci.
netMask=[A]
A- maska podsieci, ciąg znaków
netGateway¶
Ustawia adres bramy domyślnej.
netGateway=[A]
A- adres IP, ciąg znaków
netDns1¶
Ustawia adres podstawowego serwera DNS.
netDns1=[A]
A- adres IP, ciąg znaków
netDns2¶
Ustawia adres dodatkowego serwera DNS.
netDns2=[A]
A- adres IP, ciąg znaków
Sieć - Wi-Fi¶
netWifi¶
Aktywuje Wi-Fi.
netWifi=[A]
A- liczba całkowita0-1
netWifiMode¶
Ustawia tryb pracy.
netWifiMode=[A]
A- liczba całkowita0-1(AP lub STA)
netWifiSSID¶
Ustawia SSID sieci, którą chcesz utworzyć lub z którą chcesz się połączyć.
netWifiSSID=[A]
A- ciąg do 32 znaków
netWifiSecurity¶
Ustawia metodę zabezpieczania sieci.
netWifiSecurity=[A]
-
A- liczba całkowita0-9{ 0: 'open', 1: 'WEP', 2: 'WPA_PSK', 3: 'WPA2_PSK', 4: 'WPA_WPA2_PSK', 5: 'WPA2_ENTERPRISE', 6: 'WPA3_PSK', 7: 'WPA2_WPA3_PSK', 8: 'WAPI_PSK', 9: 'OWE', }
netWifiPass¶
Ustawia hasło dostępu do sieci.
netWifiPass=[A]
A- ciąg do 63 znaków
netWifiDhcp¶
Aktywuje pobieranie adresu za pomocą DHCP.
netWifiDhcp=[A]
A- liczba całkowita0-1
netWifiIp¶
Ustawia adres IP urządzenia.
netWifiIp=[A]
A- adres IP, ciąg znaków
netWifiMask¶
Ustawia maskę podsieci.
netWifiMask=[A]
A- maska podsieci, ciąg znaków
netWifiGateway¶
Ustawia adres bramy domyślnej.
netWifiGateway=[A]
A- adres IP, ciąg znaków
netWifiDns1¶
Ustawia adres podstawowego serwera DNS.
netWifiDns1=[A]
A- adres IP, ciąg znaków
netWifiDns2¶
Ustawia adres dodatkowego serwera DNS.
netWifiDns2=[A]
A- adres IP, ciąg znaków
netWifiReload¶
Przeładowuje ustawienia Wi-Fi, aby zaczęły obowiązywać, bez ponownego uruchamiania urządzenia.
netWifiReload=1
Czas¶
timeNTP¶
Aktywuje synchronizację czasu za pomocą NTP.
timeNTP=[A]
A- liczba całkowita0-1
timeManual¶
Ustawia czas systemowy urządzenia.
timeManual=[A]
A- znacznik czasu UNIX (liczba sekund od początku 1970 roku UTC), liczba całkowita
timeNTPHost¶
Ustawia adres serwera NTP.
timeNTPHost=[A]
A- adres IP/domena, ciąg znaków
timeNTPPort¶
Ustawia port serwera NTP.
timeNTPPort=[A]
A- port, liczba całkowita1-65535
timeTimezone¶
Ustawia strefę czasową.
timeTimezone=[A]
-
A- numer strefy czasowej, liczba całkowitaLista opcji
{ 0: 'Africa/Abidjan', 1: 'Africa/Accra', 2: 'Africa/Addis_Ababa', 3: 'Africa/Algiers', 4: 'Africa/Asmara', 5: 'Africa/Bamako', 6: 'Africa/Bangui', 7: 'Africa/Banjul', 8: 'Africa/Bissau', 9: 'Africa/Blantyre', 10: 'Africa/Brazzaville', 11: 'Africa/Bujumbura', 12: 'Africa/Cairo', 13: 'Africa/Casablanca', 14: 'Africa/Ceuta', 15: 'Africa/Conakry', 16: 'Africa/Dakar', 17: 'Africa/Dar_es_Salaam', 18: 'Africa/Djibouti', 19: 'Africa/Douala', 20: 'Africa/El_Aaiun', 21: 'Africa/Freetown', 22: 'Africa/Gaborone', 23: 'Africa/Harare', 24: 'Africa/Johannesburg', 25: 'Africa/Juba', 26: 'Africa/Kampala', 27: 'Africa/Khartoum', 28: 'Africa/Kigali', 29: 'Africa/Kinshasa', 30: 'Africa/Lagos', 31: 'Africa/Libreville', 32: 'Africa/Lome', 33: 'Africa/Luanda', 34: 'Africa/Lubumbashi', 35: 'Africa/Lusaka', 36: 'Africa/Malabo', 37: 'Africa/Maputo', 38: 'Africa/Maseru', 39: 'Africa/Mbabane', 40: 'Africa/Mogadishu', 41: 'Africa/Monrovia', 42: 'Africa/Nairobi', 43: 'Africa/Ndjamena', 44: 'Africa/Niamey', 45: 'Africa/Nouakchott', 46: 'Africa/Ouagadougou', 47: 'Africa/Porto-Novo', 48: 'Africa/Sao_Tome', 49: 'Africa/Tripoli', 50: 'Africa/Tunis', 51: 'Africa/Windhoek', 52: 'America/Adak', 53: 'America/Anchorage', 54: 'America/Anguilla', 55: 'America/Antigua', 56: 'America/Araguaina', 57: 'America/Argentina/Buenos_Aires', 58: 'America/Argentina/Catamarca', 59: 'America/Argentina/Cordoba', 60: 'America/Argentina/Jujuy', 61: 'America/Argentina/La_Rioja', 62: 'America/Argentina/Mendoza', 63: 'America/Argentina/Rio_Gallegos', 64: 'America/Argentina/Salta', 65: 'America/Argentina/San_Juan', 66: 'America/Argentina/San_Luis', 67: 'America/Argentina/Tucuman', 68: 'America/Argentina/Ushuaia', 69: 'America/Aruba', 70: 'America/Asuncion', 71: 'America/Atikokan', 72: 'America/Bahia', 73: 'America/Bahia_Banderas', 74: 'America/Barbados', 75: 'America/Belem', 76: 'America/Belize', 77: 'America/Blanc-Sablon', 78: 'America/Boa_Vista', 79: 'America/Bogota', 80: 'America/Boise', 81: 'America/Cambridge_Bay', 82: 'America/Campo_Grande', 83: 'America/Cancun', 84: 'America/Caracas', 85: 'America/Cayenne', 86: 'America/Cayman', 87: 'America/Chicago', 88: 'America/Chihuahua', 89: 'America/Costa_Rica', 90: 'America/Creston', 91: 'America/Cuiaba', 92: 'America/Curacao', 93: 'America/Danmarkshavn', 94: 'America/Dawson', 95: 'America/Dawson_Creek', 96: 'America/Denver', 97: 'America/Detroit', 98: 'America/Dominica', 99: 'America/Edmonton', 100: 'America/Eirunepe', 101: 'America/El_Salvador', 102: 'America/Fort_Nelson', 103: 'America/Fortaleza', 104: 'America/Glace_Bay', 105: 'America/Godthab', 106: 'America/Goose_Bay', 107: 'America/Grand_Turk', 108: 'America/Grenada', 109: 'America/Guadeloupe', 110: 'America/Guatemala', 111: 'America/Guayaquil', 112: 'America/Guyana', 113: 'America/Halifax', 114: 'America/Havana', 115: 'America/Hermosillo', 116: 'America/Indiana/Indianapolis', 117: 'America/Indiana/Knox', 118: 'America/Indiana/Marengo', 119: 'America/Indiana/Petersburg', 120: 'America/Indiana/Tell_City', 121: 'America/Indiana/Vevay', 122: 'America/Indiana/Vincennes', 123: 'America/Indiana/Winamac', 124: 'America/Inuvik', 125: 'America/Iqaluit', 126: 'America/Jamaica', 127: 'America/Juneau', 128: 'America/Kentucky/Louisville', 129: 'America/Kentucky/Monticello', 130: 'America/Kralendijk', 131: 'America/La_Paz', 132: 'America/Lima', 133: 'America/Los_Angeles', 134: 'America/Lower_Princes', 135: 'America/Maceio', 136: 'America/Managua', 137: 'America/Manaus', 138: 'America/Marigot', 139: 'America/Martinique', 140: 'America/Matamoros', 141: 'America/Mazatlan', 142: 'America/Menominee', 143: 'America/Merida', 144: 'America/Metlakatla', 145: 'America/Mexico_City', 146: 'America/Miquelon', 147: 'America/Moncton', 148: 'America/Monterrey', 149: 'America/Montevideo', 150: 'America/Montreal', 151: 'America/Montserrat', 152: 'America/Nassau', 153: 'America/New_York', 154: 'America/Nipigon', 155: 'America/Nome', 156: 'America/Noronha', 157: 'America/North_Dakota/Beulah', 158: 'America/North_Dakota/Center', 159: 'America/North_Dakota/New_Salem', 160: 'America/Nuuk', 161: 'America/Ojinaga', 162: 'America/Panama', 163: 'America/Pangnirtung', 164: 'America/Paramaribo', 165: 'America/Phoenix', 166: 'America/Port-au-Prince', 167: 'America/Port_of_Spain', 168: 'America/Porto_Velho', 169: 'America/Puerto_Rico', 170: 'America/Punta_Arenas', 171: 'America/Rainy_River', 172: 'America/Rankin_Inlet', 173: 'America/Recife', 174: 'America/Regina', 175: 'America/Resolute', 176: 'America/Rio_Branco', 177: 'America/Santarem', 178: 'America/Santiago', 179: 'America/Santo_Domingo', 180: 'America/Sao_Paulo', 181: 'America/Scoresbysund', 182: 'America/Sitka', 183: 'America/St_Barthelemy', 184: 'America/St_Johns', 185: 'America/St_Kitts', 186: 'America/St_Lucia', 187: 'America/St_Thomas', 188: 'America/St_Vincent', 189: 'America/Swift_Current', 190: 'America/Tegucigalpa', 191: 'America/Thule', 192: 'America/Thunder_Bay', 193: 'America/Tijuana', 194: 'America/Toronto', 195: 'America/Tortola', 196: 'America/Vancouver', 197: 'America/Whitehorse', 198: 'America/Winnipeg', 199: 'America/Yakutat', 200: 'America/Yellowknife', 201: 'Antarctica/Casey', 202: 'Antarctica/Davis', 203: 'Antarctica/DumontDUrville', 204: 'Antarctica/Macquarie', 205: 'Antarctica/Mawson', 206: 'Antarctica/McMurdo', 207: 'Antarctica/Palmer', 208: 'Antarctica/Rothera', 209: 'Antarctica/Syowa', 210: 'Antarctica/Troll', 211: 'Antarctica/Vostok', 212: 'Arctic/Longyearbyen', 213: 'Asia/Aden', 214: 'Asia/Almaty', 215: 'Asia/Amman', 216: 'Asia/Anadyr', 217: 'Asia/Aqtau', 218: 'Asia/Aqtobe', 219: 'Asia/Ashgabat', 220: 'Asia/Atyrau', 221: 'Asia/Baghdad', 222: 'Asia/Bahrain', 223: 'Asia/Baku', 224: 'Asia/Bangkok', 225: 'Asia/Barnaul', 226: 'Asia/Beirut', 227: 'Asia/Bishkek', 228: 'Asia/Brunei', 229: 'Asia/Chita', 230: 'Asia/Choibalsan', 231: 'Asia/Colombo', 232: 'Asia/Damascus', 233: 'Asia/Dhaka', 234: 'Asia/Dili', 235: 'Asia/Dubai', 236: 'Asia/Dushanbe', 237: 'Asia/Famagusta', 238: 'Asia/Gaza', 239: 'Asia/Hebron', 240: 'Asia/Ho_Chi_Minh', 241: 'Asia/Hong_Kong', 242: 'Asia/Hovd', 243: 'Asia/Irkutsk', 244: 'Asia/Jakarta', 245: 'Asia/Jayapura', 246: 'Asia/Jerusalem', 247: 'Asia/Kabul', 248: 'Asia/Kamchatka', 249: 'Asia/Karachi', 250: 'Asia/Kathmandu', 251: 'Asia/Khandyga', 252: 'Asia/Kolkata', 253: 'Asia/Krasnoyarsk', 254: 'Asia/Kuala_Lumpur', 255: 'Asia/Kuching', 256: 'Asia/Kuwait', 257: 'Asia/Macau', 258: 'Asia/Magadan', 259: 'Asia/Makassar', 260: 'Asia/Manila', 261: 'Asia/Muscat', 262: 'Asia/Nicosia', 263: 'Asia/Novokuznetsk', 264: 'Asia/Novosibirsk', 265: 'Asia/Omsk', 266: 'Asia/Oral', 267: 'Asia/Phnom_Penh', 268: 'Asia/Pontianak', 269: 'Asia/Pyongyang', 270: 'Asia/Qatar', 271: 'Asia/Qyzylorda', 272: 'Asia/Riyadh', 273: 'Asia/Sakhalin', 274: 'Asia/Samarkand', 275: 'Asia/Seoul', 276: 'Asia/Shanghai', 277: 'Asia/Singapore', 278: 'Asia/Srednekolymsk', 279: 'Asia/Taipei', 280: 'Asia/Tashkent', 281: 'Asia/Tbilisi', 282: 'Asia/Tehran', 283: 'Asia/Thimphu', 284: 'Asia/Tokyo', 285: 'Asia/Tomsk', 286: 'Asia/Ulaanbaatar', 287: 'Asia/Urumqi', 288: 'Asia/Ust-Nera', 289: 'Asia/Vientiane', 290: 'Asia/Vladivostok', 291: 'Asia/Yakutsk', 292: 'Asia/Yangon', 293: 'Asia/Yekaterinburg', 294: 'Asia/Yerevan', 295: 'Atlantic/Azores', 296: 'Atlantic/Bermuda', 297: 'Atlantic/Canary', 298: 'Atlantic/Cape_Verde', 299: 'Atlantic/Faroe', 300: 'Atlantic/Madeira', 301: 'Atlantic/Reykjavik', 302: 'Atlantic/South_Georgia', 303: 'Atlantic/St_Helena', 304: 'Atlantic/Stanley', 305: 'Australia/Adelaide', 306: 'Australia/Brisbane', 307: 'Australia/Broken_Hill', 308: 'Australia/Currie', 309: 'Australia/Darwin', 310: 'Australia/Eucla', 311: 'Australia/Hobart', 312: 'Australia/Lindeman', 313: 'Australia/Lord_Howe', 314: 'Australia/Melbourne', 315: 'Australia/Perth', 316: 'Australia/Sydney', 317: 'Etc/GMT', 318: 'Etc/GMT+0', 319: 'Etc/GMT+1', 320: 'Etc/GMT+10', 321: 'Etc/GMT+11', 322: 'Etc/GMT+12', 323: 'Etc/GMT+2', 324: 'Etc/GMT+3', 325: 'Etc/GMT+4', 326: 'Etc/GMT+5', 327: 'Etc/GMT+6', 328: 'Etc/GMT+7', 329: 'Etc/GMT+8', 330: 'Etc/GMT+9', 331: 'Etc/GMT-0', 332: 'Etc/GMT-1', 333: 'Etc/GMT-10', 334: 'Etc/GMT-11', 335: 'Etc/GMT-12', 336: 'Etc/GMT-13', 337: 'Etc/GMT-14', 338: 'Etc/GMT-2', 339: 'Etc/GMT-3', 340: 'Etc/GMT-4', 341: 'Etc/GMT-5', 342: 'Etc/GMT-6', 343: 'Etc/GMT-7', 344: 'Etc/GMT-8', 345: 'Etc/GMT-9', 346: 'Etc/GMT0', 347: 'Etc/Greenwich', 348: 'Etc/UCT', 349: 'Etc/UTC', 350: 'Etc/Universal', 351: 'Etc/Zulu', 352: 'Europe/Amsterdam', 353: 'Europe/Andorra', 354: 'Europe/Astrakhan', 355: 'Europe/Athens', 356: 'Europe/Belgrade', 357: 'Europe/Berlin', 358: 'Europe/Bratislava', 359: 'Europe/Brussels', 360: 'Europe/Bucharest', 361: 'Europe/Budapest', 362: 'Europe/Busingen', 363: 'Europe/Chisinau', 364: 'Europe/Copenhagen', 365: 'Europe/Dublin', 366: 'Europe/Gibraltar', 367: 'Europe/Guernsey', 368: 'Europe/Helsinki', 369: 'Europe/Isle_of_Man', 370: 'Europe/Istanbul', 371: 'Europe/Jersey', 372: 'Europe/Kaliningrad', 373: 'Europe/Kiev', 374: 'Europe/Kirov', 375: 'Europe/Lisbon', 376: 'Europe/Ljubljana', 377: 'Europe/London', 378: 'Europe/Luxembourg', 379: 'Europe/Madrid', 380: 'Europe/Malta', 381: 'Europe/Mariehamn', 382: 'Europe/Minsk', 383: 'Europe/Monaco', 384: 'Europe/Moscow', 385: 'Europe/Oslo', 386: 'Europe/Paris', 387: 'Europe/Podgorica', 388: 'Europe/Prague', 389: 'Europe/Riga', 390: 'Europe/Rome', 391: 'Europe/Samara', 392: 'Europe/San_Marino', 393: 'Europe/Sarajevo', 394: 'Europe/Saratov', 395: 'Europe/Simferopol', 396: 'Europe/Skopje', 397: 'Europe/Sofia', 398: 'Europe/Stockholm', 399: 'Europe/Tallinn', 400: 'Europe/Tirane', 401: 'Europe/Ulyanovsk', 402: 'Europe/Uzhgorod', 403: 'Europe/Vaduz', 404: 'Europe/Vatican', 405: 'Europe/Vienna', 406: 'Europe/Vilnius', 407: 'Europe/Volgograd', 408: 'Europe/Warsaw', 409: 'Europe/Zagreb', 410: 'Europe/Zaporozhye', 411: 'Europe/Zurich', 412: 'Indian/Antananarivo', 413: 'Indian/Chagos', 414: 'Indian/Christmas', 415: 'Indian/Cocos', 416: 'Indian/Comoro', 417: 'Indian/Kerguelen', 418: 'Indian/Mahe', 419: 'Indian/Maldives', 420: 'Indian/Mauritius', 421: 'Indian/Mayotte', 422: 'Indian/Reunion', 423: 'Pacific/Apia', 424: 'Pacific/Auckland', 425: 'Pacific/Bougainville', 426: 'Pacific/Chatham', 427: 'Pacific/Chuuk', 428: 'Pacific/Easter', 429: 'Pacific/Efate', 430: 'Pacific/Enderbury', 431: 'Pacific/Fakaofo', 432: 'Pacific/Fiji', 433: 'Pacific/Funafuti', 434: 'Pacific/Galapagos', 435: 'Pacific/Gambier', 436: 'Pacific/Guadalcanal', 437: 'Pacific/Guam', 438: 'Pacific/Honolulu', 439: 'Pacific/Kiritimati', 440: 'Pacific/Kosrae', 441: 'Pacific/Kwajalein', 442: 'Pacific/Majuro', 443: 'Pacific/Marquesas', 444: 'Pacific/Midway', 445: 'Pacific/Nauru', 446: 'Pacific/Niue', 447: 'Pacific/Norfolk', 448: 'Pacific/Noumea', 449: 'Pacific/Pago_Pago', 450: 'Pacific/Palau', 451: 'Pacific/Pitcairn', 452: 'Pacific/Pohnpei', 453: 'Pacific/Port_Moresby', 454: 'Pacific/Rarotonga', 455: 'Pacific/Saipan', 456: 'Pacific/Tahiti', 457: 'Pacific/Tarawa', 458: 'Pacific/Tongatapu', 459: 'Pacific/Wake', 460: 'Pacific/Wallis', }
timeNTPPeriod¶
Ustawia interwał aktualizacji czasu w trybie z NTP.
timeNTPPeriod=[A]
A- interwał aktualizacji w sekundach, liczba całkowita
timeSetRTC¶
Zapisuje zadany czas i datę w RTC.
timeSetRTC=[A]
A- ciąg liczb całkowitych rozdzielonych,([ROK],[MIESIĄC],[DZIEŃ MIESIĄCA],[GODZINA],[MINUTA],[SEKUNDA], np.2023,03,13,12,43,00)
Dostęp¶
auth¶
Aktywuje uwierzytelnianie Basic Authentication przy dostępie HTTP.
auth=[A]
A- liczba całkowita0-1
upgr¶
Określa czy oprogramowanie układowe może być aktualizowane po HTTP.
upgr=[A]
A- liczba całkowita0-1
adminLogin¶
Ustawia nazwę użytkownika administratora.
adminLogin=[A]
A- ciąg do 15 znaków (zakodowane w Base64)
adminPass¶
Ustawia hasło administratora.
adminPass=[A]
A- ciąg do 15 znaków (zakodowane w Base64)
userLogin¶
Ustawia nazwę użytkownika (z dostępem tylko do strony Status).
userLogin=[A]
A- ciąg do 15 znaków (zakodowane w Base64)
userPass¶
Ustawia hasło użytkownika (z dostępem tylko do strony Status).
userPass=[A]
A- ciąg do 15 znaków (zakodowane w Base64)
authUser¶
Ustawia kombinacje nazwy użytkownika i hasła, którzy będą mieli dostęp do sterowania wyjściami przy włączonym Basic Authentication.
authUser[A]=[B]*[C]*[D]*[E]
A- numer wpisu, liczba całkowita1-50B- określa, czy wpis jest ustawiony (1- ustawiony), liczba całkowita0-1C- określa, czy wpis jest aktywny, liczba całkowita0-1D- nazwa użytkownika, ciąg do 15 znakówE- hasło użytkownika, ciąg do 15 znaków
E-mail¶
emailHost¶
Ustawia adres serwera SMTP.
emailHost=[A]
A- ciąg do 64 znaków
emailPort¶
Ustawia port serwera SMTP.
emailPort=[A]
A- port, liczba całkowita1-65535
emailTLS¶
Zmienione w SW 1.13
Aktywuje obsługę szyfrowania TLS przy połączeniu z serwerem.
emailTLS=[A]
-
A- liczba całkowita0-2{ 0: "No encryption", 1: "SSL/TLS", 2: "StartTLS", }
A- liczba całkowita0-1
emailUser¶
Ustawia nazwę użytkownika (dane dostępowe).
emailUser=[A]
A- ciąg do 64 znaków
emailPassword¶
Ustawia hasło użytkownika (dane dostępowe).
emailPassword=[A]
A- ciąg do 64 znaków
emailSender¶
Ustawia adres nadawcy (zwykle taki sam jak emailUser).
emailSender=[A]
A- ciąg do 64 znaków
emailWdTo¶
Dostępne od SW 1.06
Ustawia adres odbiorcy dla funkcji Watchdog.
emailWdTo=[A]
A- ciąg do 64 znaków
emailWdSubj¶
Dostępne od SW 1.06
Ustawia temat wiadomości email dla funkcji Watchdog.
emailWdSubj=[A]
A- ciąg do 64 znaków
emailWdText¶
Dostępne od SW 1.06
Ustawia treść wiadomości email dla funkcji Watchdog.
emailWdText=[A]
-
A- ciąg do 256 znakówMoże zawierać kody odczytów - dowiedz się więcej.
emailToEv¶
Dostępne od SW 1.06
Ustawia adres odbiorcy dla funkcji Zdarzenia (działanie Email z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony).
emailToEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania Email, liczba całkowita1-4C- ciąg do 64 znaków
emailSubjEv¶
Dostępne od SW 1.06
Ustawia temat wiadomości email dla funkcji Zdarzenia (działanie Email z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony).
emailSubjEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania Email, liczba całkowita1-4C- ciąg do 64 znaków
emailTextEv¶
Dostępne od SW 1.06
Ustawia treść wiadomości email dla funkcji Zdarzenia (działanie Email z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony).
emailTextEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania Email, liczba całkowita1-4-
C- ciąg do 256 znakówMoże zawierać kody odczytów - dowiedz się więcej.
testemail¶
Wysyła testowy email zgodnie z obecną konfiguracją.
testemail=1
emailReceiver¶
Ustawia adres odbiorcy.
emailReceiver=[A]
A- ciąg do 64 znaków
emailSubject¶
Usunięte w wersji SW 1.06. Zamiast należy używać emailWdSubj i emailSubjEv.
Ustawia temat wiadomości email.
emailSubject=[A]
A- ciąg do 64 znaków
emailTextOn¶
Usunięte w wersji SW 1.06. Zamiast należy używać emailWdText i emailTextEv.
Ustawia treść wiadomości, używaną przy spełnieniu warunku zdarzenia.
emailTextOn[A]=[B]
A- numer pary tekstów, liczba całkowita1-4B- ciąg do 256 znaków
emailTextOff¶
Usunięte w wersji SW 1.06. Zamiast należy używać emailWdText i emailTextEv.
Ustawia treść wiadomości, używaną przy wygaśnięciu warunku zdarzenia.
emailTextOff[A]=[B]
A- numer pary tekstów, liczba całkowita1-4B- ciąg do 256 znaków
OLED¶
oledEnabled¶
Aktywuje funkcję OLED.
oledEnabled=[A]
A- liczba całkowita0-1
oledTime¶
Ustawia czas wyświetlania, czyli czas przez jaki wyświetlacz będzie włączony po wystąpieniu zdarzenia aktywującego (działania OLED ON/NEXT SCREEN i OLED - SET SCREEN X w Zdarzeniach i Harmonogramie). Dla wartości 0 wyświetlacz zawsze włączony.
oledTime=[A]
A- czas w sekundach, liczba całkowita
oledSize¶
Ustawia rozmiar obsługiwanego wyświetlacza.
oledSize=[A]
-
A- numer opcji, liczba całkowita0-1{ 0: '128 x 64', 1: '128 x 32', }
oledFrequency¶
Ustawia częstotliwość komunikacji I2C z wyświetlaczem.
oledFrequency=[A]
A- częstotliwość w kHz, liczba całkowita50-400
oledScreen¶
Aktywuje wybraną konfigurację ekranu do wyświetlania (elementy nieaktywne zostaną pominięte przez akcje OLED ON/NEXT SCREEN).
oledScreen[A]=[B]
A- numer ekranu, liczba całkowita1-4B- określenie czy aktywny, liczba całkowita0-1
oledLine¶
Ustawia tekst wybranej lini w wybranej konfiguracji ekranu.
oledLine[A][B]=[C]
A- numer ekranu, liczba całkowita1-4B- numer linii, liczba całkowita1-4-
C- ciąg do 159 znakówMoże zawierać kody odczytów - dowiedz się więcej.
Modem¶
modemCmd¶
Wysyła polecenie AT do modemu. Odpowiedź będzie dostępna w zmiennej modemConsole.
modemCmd=[A]
A- ciąg znaków
modemCode¶
Ustawia kod dostępu dla poleceń SMS (każde polecenie musi byc nim poprzedzone [modemCode]:[polecenie]).
modemCode=[A]
A- ciąg do 4 znaków, tylko cyfry
modemAPN¶
Ustawia APN, nazwę użytkownika i hasło.
modemAPN=[A]
A- ciąg do 63 znaków, w formacie"[APN]","[USERNAME]","[PASSWORD]", np."internet","",""
modemReturnSMS¶
Aktywuje odsyłanie potwierdzeń SMS na polecenia SMS.
modemReturnSMS=[A]
A- liczba całkowita0-1
modemNumberEv¶
Dostępne od SW 1.06
Ustawia numer(y) odbiorcy, do którego akcja SMS wyśle wiadomość w funkcji Zdarzenia. Zestaw numerów jest taki sam dla obu wariantów akcji, tj. gdy warunek jest spełniony i gdy warunek przestaje być spełniony.
modemNumberEv[A]=[B]
A- numer działania SMS, liczba całkowita1-4B- numery telefonów rozdzielone:(maksymalnie 4 numery), ciąg znaków
modemTextEv¶
Dostępne od SW 1.06
Ustawia treść wiadomości w akcji SMS w funkcji Zdarzenia (z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony).
modemTextEv[A][B]=[C]
A- znakTlubF, wariant po spełnieniu lub gdy warunek przestaje być spełnionyB- numer działania SMS, liczba całkowita1-4-
C- ciąg do 256 znakówMoże zawierać kody odczytów - dowiedz się więcej.
modemSendSMS¶
Wysyła testowy SMS zgodnie z obecną konfiguracją (pierwszą pozycją).
modemSendSMS=1
modemCLIP¶
Dostępne od SW 1.38
Aktywuje funkcję CLIP - reakcję na połączenie przychodzące.
modemCLIP=[A]
A- liczba całkowita0-1
modemCLIPNumber¶
Dostępne od SW 1.38
Ustawia zaufane numery do korzystania z funkcji CLIP.
modemCLIPNumber=[A]
A- numery telefonów o długości od 9 do 13 cyfr (zalecany jest format międzynarodowy, w tym numer kierunkowy) rozdzielone,, ciąg do 1023 znaków
modemCLIPOutput¶
Dostępne od SW 1.38
Ustawia wyjście, które będzie przełączane na stan przeciwny w odpowiedzi na połączenie przychodzące z numeru telefonu znajdującego się na liście numerów zaufanych w funkcji CLIP.
modemCLIPOutput=[A]
-
A- liczba całkowita0-13{ 0: 'OUT1', 1: 'OUT2', 2: 'OUT3', 3: 'OUT4', 4: 'OUT5', 5: 'OUT6', 6: 'VAR1', 7: 'VAR2', 8: 'VAR3', 9: 'VAR4', 10: 'VAR5', 11: 'VAR6', 12: 'VAR7', 13: 'VAR8', }
modemNumber¶
Usunięte w wersji SW 1.06. Zamiast należy używać modemNumberEv.
Ustawia numer odbiorcy na danej pozycji.
modemNumber[A]=[B]
A- numer pozycji, liczba całkowita1-4B- numery telefonów rozdzielone:, ciąg znaków
modemTextOn¶
Usunięte w wersji SW 1.06. Zamiast należy używać modemTextEv.
Ustawia treść wiadomości, używaną przy spełnieniu warunku zdarzenia.
modemTextOn[A]=[B]
A- numer pozycji, liczba całkowita1-4B- ciąg do 256 znaków
modemTextOff¶
Usunięte w wersji SW 1.06. Zamiast należy używać modemTextEv.
Ustawia treść wiadomości, używaną przy wygaśnięciu warunku zdarzenia.
modemTextOff[A]=[B]
A- numer pary tekstów, liczba całkowita1-4B- ciąg do 256 znaków
Inne ustawienia¶
Niektóre parametry można skonfigurować tylko przy pomocy zapytań HTTP POST, a nie HTTP GET czy MQTT. Są one opisane poniżej.
Logowanie (weryfikacja danych)¶
Adres API umożliwia sprawdzenie poprawności danych logowania poprzez wysłanie loginu i hasła w formacie JSON.
Aby wykonać weryfikację, należy wysłać zapytanie HTTP POST na adres:
[IP]/api/v1/post_data/signin
Treść żądania musi być w formacie JSON, np.:
{"username":"admin","password":"admin"}
Odpowiedź ma postać:
{"access":X}
gdzie X oznacza poziom dostępu:
0– brak dostępu (niepoprawne dane logowania),1– dostęp admin,2– dostęp user.
Adres ten nie wymaga nagłówka Authorization i działa niezależnie od stanu metody Basic Authentication.
Adres ten jest wykorzystywany przez interfejs WWW, który przy użyciu mechanizmów JavaScript weryfikuje poprawność loginu i hasła bez wywoływania mechanizmu przeglądarki obsługującego Basic Authentication.
Obraz na Status użytkownika¶
Aby ustawić obraz należy go wysłać w postaci binarnej jako dane zapytania POST na adres [IP]/api/v1/post_data/pictureupload.
Aktualizacja firmware¶
Aby zaktualizować firmware należy go wysłać w postaci binarnej jako dane zapytania POST na adres [IP]/api/v1/upload_firmware/new_firmware.
Wgranie kopi zapasowej¶
Aby wgrać kopie zapasową należy ją wysłać w postaci binarnej jako dane zapytania POST na adres [IP]/api/v1/upload_firmware/backupSettings.