Commands¶

tcPDU can be controlled by commands that can be sent via HTTP or MQTT.

Additionally, the version with an LTE modem also supports SMS commands.

How to use commands¶

Almost every tcPDU command has the structure NAME=VALUE.

HTTP¶

To send a command via HTTP, send an HTTP GET request to the address /api/v1/save/, e.g.

http://[IP]/api/v1/save/?out1=1
http://[IP]/api/v1/save/?out=out1
http://[IP]/api/v1/save/?outName1=Lampa%20Biurko

Multiple commands can be sent in one query, e.g.

http://[IP]/api/v1/save/?out1=1&out2=1&out3=1&out4=1&out5=1&out6=1&out7=1

Special characters in parameter values

Please note that spaces and special characters in the GET parameter value must be replaced with their hex ASCII codes, e.g. space = %20, % = %25.

MQTT¶

To send commands via MQTT, you need an MQTT client, e.g. a web client on our website . If you are testing with a local broker, you can use the MQTTX application or the command line tools included with the mosquitto server.

After configuring MQTT client and successfully connecting to the MQTT server, you can send commands on [Topic prefix]/cmd with content similar to HTTP commands, e.g.

out1=1
out=out1
outName1=Lampa Biurko

With MQTT, you also can send multiple commands in one message, e.g.

out1=1&out2=1&out3=1&out4=1&out5=1&out6=1&out7=1

It is worth noting that there is no need for character encoding as in the case of HTTP.

Each command is confirmed with a reply 1 on the subject [Topic prefix]/cmdr. In the case of messages with multiple commands, there will be multiple replies - one for each command.

SMS¶

Only for tcPDU with LTE modem

Commands in SMS messages must have the appropriate structure:

[ACCESS CODE]:cmd:[COMMAND]

For example:

1234:cmd:out=out1

Unlike HTTP and MQTT, only single commands can be sent via SMS, they cannot be combined using &.

In the modem configuration, you can enable the Send return SMS after SMS command option to receive reply SMS messages with the content, e.g. cmd ack SMS from tcPDU uptime=1874.

List of commands¶

UI settings¶

webRefresh¶

How often values from the device are refreshed on the page, value in seconds.

webRefresh=[A]

A - real number 0.3 - 3276.

webLanguage¶

User interface language.

webLanguage=[A]

A - integer

{
    0: 'PL',
    1: 'EN',
    2: 'FR',
    3: 'HU',
    4: 'CZ',
}

webUserSetNames¶

When enabled, the reading names will be displayed as just user-set names without standard names, e.g. Inside temp instead of DS1 - Inside temp.

webUserSetNames=[A]

A - integer 0-1

webReadOnlyUser¶

The user will only be able to read the data, not able to control the outputs on the page Status for user.

webReadOnlyUser=[A]

A - integer 0-1

webAutoSignIn¶

Automatically sign in as administrator when visiting the index page (skip the login page). When this option is enabled, logout has no effect and user sign in is disabled.

webAutoSignIn=[A]

A - integer 0-1

webHomepage¶

The page that will be loaded after signing in.

webHomepage=[A]

A - integer 0-1

{
    0: 'Status',
    1: 'StatusUser',
}

webVisibility¶

Specifies the visibility of elements on the Status and User Status pages.

webVisibility=[A]

A - a sequence of 140 digits 0-1 (currently the first 69 are used), where subsequent digits correspond to the visibility of elements.

{
    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: 'OUT7 showValue',
    13: 'OUT7 showName',
    14: 'DS1 showName',
    15: 'DS1 showValue',
    16: 'DS2 showName',
    17: 'DS2 showValue',
    18: 'DS3 showName',
    19: 'DS3 showValue',
    20: 'DS4 showName',
    21: 'DS4 showValue',
    22: 'DS5 showName',
    23: 'DS5 showValue',
    24: 'DS6 showName',
    25: 'DS6 showValue',
    26: 'DS7 showName',
    27: 'DS7 showValue',
    28: 'DS8 showName',
    29: 'DS8 showValue',
    30: 'T1 showName',
    31: 'T1 showValue',
    32: 'H1 showName',
    33: 'H1 showValue',
    34: 'DewPoint show',
    35: 'DIFF1 showValue',
    36: 'DIFF2 showValue',
    37: 'DIFF3 showValue',
    38: 'DIFF4 showValue',
    39: 'DIFF5 showValue',
    40: 'DIFF6 showValue',
    41: 'INPD1 show',
    42: 'INPD2 show',
    43: 'POWER1 showName',
    44: 'POWER1 showValueP',
    45: 'POWER1 showValueE',
    46: 'POWER2 showName',
    47: 'POWER2 showValueP',
    48: 'POWER2 showValueE',
    49: 'POWER3 showName',
    50: 'POWER3 showValueP',
    51: 'POWER3 showValueE',
    52: 'POWER4 showName',
    53: 'POWER4 showValueP',
    54: 'POWER4 showValueE',
    55: 'POWER5 showName',
    56: 'POWER5 showValueP',
    57: 'POWER5 showValueE',
    58: 'POWER6 showName',
    59: 'POWER6 showValueP',
    60: 'POWER6 showValueE',
    61: 'VAR1 show',
    62: 'VAR2 show',
    63: 'VAR3 show',
    64: 'VAR4 show',
    65: 'VAR5 show',
    66: 'VAR6 show',
    67: 'VAR7 show',
    68: 'VAR8 show',
}

webPositionTop¶

Specifies the positions of elements on the Status for user page, specifically the offset from the top in px relative to the default position.

webPositionTop=[A]

A - sequence of 84 integers -1024 - 1024 (currently the first 40 are used) separated by a * character.

webPositionLeft¶

Specifies the positions of elements on the Status for user page, specifically the offset from the left in px relative to the default position.

webPositionLeft=[A]

A - sequence of 84 integers -1024 - 1024 (currently the first 40 are used) separated by a * character.

General¶

restartFlag¶

Sets a flag that is reset on device startup. This allows you to quickly check whether there has been a restart of the device since the last flag setting.

restartFlag=1

eeprom_reset¶

Restores settings to default values.

eeprom_reset=1

restart¶

Restarts the device.

restart=1

Others¶

varName¶

Added in SW 1.14

Sets the name for the VAR (1-8) variable.

varName[A]=[B]

A - variable number, integer 1-8
B - string up to 15 characters

var¶

Sets the state of the VAR (1-8) variable.

var[A]=[B]

A - variable number, integer 1-8
B - state to set, integer 0-1

Outputs¶

out¶

Sets the state of the output. The command has two variants - one to change the state to the opposite and the other to set a specific state (syntax of both variants below).

out=out[A]

A - output number, integer 1-7

out[A]=[B]

A - output number, integer 1-7
B - state to set, integer 0-1

outName¶

Sets the name of the output.

outName[A]=[B]

A - output number, integer 1-7
B - string up to 15 characters

outResetTime¶

Sets the return time. It causes that after turning on the output, it will turn off automatically after a set time.

outResetTime[A]=[B]

A - output number, integer 1-7
B - time in seconds, integer 0-65535

outAutoSwitch¶

Activates periodic switching of the output state with preset on and off times.

outAutoSwitch[A]=[B]

A - output number, integer 1-7
B - integer 0-1

outAutoSwitchH¶

Sets the output ON time for periodic switching.

outAutoSwitchH[A]=[B]

A - output number, integer 1-7
B - time in seconds, integer 0-65535

outAutoSwitchL¶

Sets the output OFF time for periodic switching.

outAutoSwitchL[A]=[B]

A - output number, integer 1-7
B - time in seconds, integer 0-65535

outStartOn¶

Activates the function to turn on the output with a specified delay after starting the device.

outStartOn[A]=[B]

A - output number, integer 1-7
B - integer 0-1

outStartOnTime¶

Sets the delay time after which the output will be turned on.

outStartOnTime[A]=[B]

A - output number, integer 1-7
B - time in seconds, integer 0-65535

outSaveState¶

Activates the function of saving the output state so that it is restored after restarting the device.

outSaveState[A]=[B]

A - output number, integer 1-7
B - integer 0-1

outNegation¶

Activates the negation of the outputs. Makes 1 appear as OFF and 0 as ON.

outNegation=[A]

A - integer 0-1

outLock¶

Activates outputs state blocking from the level of HTTP/MQTT commands. The status will only be driven by device features such as Schedules, Events, Watchdog.

outLock=[A]

A - integer 0-1

Inputs¶

dsName¶

Sets the name of the DS read.

dsName[A]=[B]

A - DS sensor number, integer 1-8
B - string up to 15 characters

i2cTempName¶

Sets the name of the I2C sensor temperature reading.

i2cTempName=[A]

A - string up to 15 characters

i2cHumName¶

Sets the name of the I2C sensor humidity reading.

i2cHumName=[A]

A - string up to 15 characters

diffName¶

Added in SW 1.14

Sets the name of DIFF reading.

diffName[A]=[B]

A - DIFF measurement number, integer 1-6
B - string up to 15 characters

diffConfig1S¶

Sets the first input for a DIFF operation.

diffConfig1S[A]=[B]

A - DIFF measurement number, integer 1-6

B - input number, integer 0-29

{
    0: 'DS1',
    1: 'DS2',
    2: 'DS3',
    3: 'DS4',
    4: 'DS5',
    5: 'DS6',
    6: 'DS7',
    7: 'DS8',
    8: 'T1',
    9: 'H1',
    10: 'Dew Point',
    11: 'POWER1',
    12: 'POWER2',
    13: 'POWER3',
    14: 'POWER4',
    15: 'POWER5',
    16: 'POWER6',
    17: 'ENERGY1',
    18: 'ENERGY2',
    19: 'ENERGY3',
    20: 'ENERGY4',
    21: 'ENERGY5',
    22: 'ENERGY6',
    23: 'UAC',
    24: 'DIFF1',
    25: 'DIFF2',
    26: 'DIFF3',
    27: 'DIFF4',
    28: 'DIFF5',
    29: 'DIFF6',
}

diffConfig2S¶

Sets the second input for the DIFF operation.

diffConfig2S[A]=[B]

A - DIFF measurement number, integer 1-6
B - input number, integer 0-29, list of values

diffConfigO¶

Sets the operator for the DIFF operation.

diffConfigO[A]=[B]

A - DIFF measurement number, integer 1-6

B - operator number, integer 0-3

{
    0: '-',
    1: '+',
    2: '*',
    3: '/',
}

iDName¶

Sets the name for the digital input.

iDName[A]=[B]

A - digital input number, integer 1-2
B - string up to 15 characters

iDNegation¶

Activates negation for digital input. Makes 1 appear as OFF and 0 as ON.

iDNegation[A]=[B]

A - digital input number, integer 1-2
B - integer 0-1

iDBistable¶

Activates bistable operation mode for the input.

iDBistable[A]=[B]

A - digital input number, integer 1-2
B - integer 0-1

iDBistableTime¶

Sets the time for the bistable operation mode.

iDBistableTime[A]=[B]

A - digital input number, integer 1-2
B - time in seconds, integer 0-65535

Sensors¶

dsReadID¶

Reads the next DS ID and places it in the dsReadID variable for reading.

dsReadID=0

dsID¶

Sets the DS sensor ID to the given position.

dsID[A]=[B]

A - DS sensor number, integer 1-8
B - ID to be set, a string of characters in the form of XX:XX:XX:XX:XX:XX:XX:XX, where X is 0-9, A-F

dsOffset¶

Sets the offset for DS reading.

dsOffset[A]=[B]

A - DS sensor number, integer 1-8
B - offset to be set, real number

i2cFrequency¶

Sets the frequency of I2C communication with the sensor.

i2cFrequency=[A]

A - frequency in kHz, integer 5-100

i2cSensor¶

Sets the type of primary I2C sensor.

i2cSensor=[A]

A - sensor number, integer 0-1

{
    0: 'None',
    1: 'AM2301B/AHT25/AHT20',
}

i2cDetect¶

Detects connected I2C sensor.

i2cDetect=1

Power and energy¶

powerName¶

Sets the name for power and energy measurement.

powerName[A]=[B]

A - measurement number, integer 1-6
B - string up to 15 characters

powerIOption¶

Sets the source of the measured power.

powerIOption[A]=[B]

A - measurement number, integer 1-6

B - measurement source, integer 0-2

{
    0: 'Active power',
    1: 'Reactive power',
    2: 'Apparent power',
}

energySet¶

Sets the state of the energy measurement.

energySet[A]=[B]

A - measurement number, integer 1-6
B - the value of energy (with the unit dictated by the choice of powerIOption), real number

Note

The energy value in energy changes only when powerCounting is activated.

powerCounting¶

Activates energy measurement. It can be controlled in the Schedule to measure energy in different time intervals (different tariffs).

powerCounting[A]=[B]

A - measurement number, integer 1-6
B - integer 0-1

powerSaveToMem¶

Activates the function of saving the energy values after restarting the device (cyclic saving of the energy state to the permanent memory).

powerSaveToMem=[A]

A - integer 0-1

Events¶

event¶

Sets the event entry to the given position.

event[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]*[M]*[N]*[O]*[P]*[R]*[S]*[T]

A - position, integer 1-20
B - determines whether the entry is set (1 - set), integer 0-1
C - determines whether the entry is active, integer 0-1

D, J - sources (input data) of conditions (first and second, respectively), integer 0-30, 100-117

{
    // Analog
    0: 'UAC',
    1: 'IAC',
    2: 'T1',
    3: 'H1',
    4: 'DS1',
    5: 'DS2',
    6: 'DS3',
    7: 'DS4',
    8: 'DS5',
    9: 'DS6',
    10: 'DS7',
    11: 'DS8',
    12: 'DIFF1',
    13: 'DIFF2',
    14: 'DIFF3',
    15: 'DIFF4',
    16: 'DIFF5',
    17: 'DIFF6',
    18: 'POWER1',
    19: 'POWER2',
    20: 'POWER3',
    21: 'POWER4',
    22: 'POWER5',
    23: 'POWER6',
    24: 'ENERGY1',
    25: 'ENERGY2',
    26: 'ENERGY3',
    27: 'ENERGY4',
    28: 'ENERGY5',
    29: 'ENERGY6',
    30: 'Dew Point',
    // Digital
    100: 'INPD1',
    101: 'INPD2',
    102: 'VAR1',
    103: 'VAR2',
    104: 'VAR3',
    105: 'VAR4',
    106: 'VAR5',
    107: 'VAR6',
    108: 'VAR7',
    109: 'VAR8',
    110: 'OUT1',
    111: 'OUT2',
    112: 'OUT3',
    113: 'OUT4',
    114: 'OUT5',
    115: 'OUT6',
    116: 'OUT7',
    117: 'MQTT CONNECTION',
}

E, K - condition operator for analog sources (for digital = is always used), integer 0-1
```
{
    0: '>=',
    1: '<',
}
```
F, L - reference values for conditions, real number (for a digital source, an integer 0-1)
G, M - hysteresis values for conditions, real number

H - operator between conditions, integer 0-5

{
    0: '-',
    1: 'AND',
    2: 'OR',
    3: 'NAND',
    4: 'NOR',
    5: 'XOR',
}

I - action to be performed, integer 0-46

{
    0: 'OUT1',
    1: 'OUT2',
    2: 'OUT3',
    3: 'OUT4',
    4: 'OUT5',
    5: 'OUT6',
    6: 'OUT7',
    7: 'VAR1',
    8: 'VAR2',
    9: 'VAR3',
    10: 'VAR4',
    11: 'VAR5',
    12: 'VAR6',
    13: 'VAR7',
    14: 'VAR8',
    15: 'AutoSwitch OUT1',
    16: 'AutoSwitch OUT2',
    17: 'AutoSwitch OUT3',
    18: 'AutoSwitch OUT4',
    19: 'AutoSwitch OUT5',
    20: 'AutoSwitch OUT6',
    21: 'AutoSwitch OUT7',
    22: 'HTTP1',
    23: 'HTTP2',
    24: 'HTTP3',
    25: 'HTTP4',
    26: 'eMail 1',
    27: 'eMail 2',
    28: 'eMail 3',
    29: 'eMail 4',
    30: 'SMS1',
    31: 'SMS2',
    32: 'SMS3',
    33: 'SMS4',
    34: 'RESET ENERGY1',
    35: 'RESET ENERGY2',
    36: 'RESET ENERGY3',
    37: 'RESET ENERGY4',
    38: 'RESET ENERGY5',
    39: 'RESET ENERGY6',
    40: 'SNMP trap',
    41: 'MQTT',
    42: 'OLED ON/NEXT SCREEN',
    43: 'OLED - SET SCREEN 1',
    44: 'OLED - SET SCREEN 2',
    45: 'OLED - SET SCREEN 3',
    46: 'OLED - SET SCREEN 4',
}

N - specifies whether Permanent (Per) is enabled for the event entry. Affects only OUT and VAR actions. It causes the action to be performed every time the conditions are checked, instead of only when the outcome of conditions change (they start to be met or stop being met, i.e. when a threshold is passed, so to speak). Integer 0-1
O - off delay (deactivation delay), i.e. the time in seconds by which the deactivation of the operation will be delayed, after the condition is no longer met. To be set only for OUT, VAR actions. Integer.

P - value for OUT, VAR actions (no effect for others). Integer 0-2.

{
    0: '0',
    1: '1',
    2: 'Reverse',
}

R - on delay (activation delay), i.e. the time in seconds by which the activation of the action will be delayed, after the condition begins to be met. To be set only for OUT, VAR actions. Integer.
S - dependence on the outcome of the conditions of another event, e.g. entry 2 dependent on the outcome of the conditions of entry 1. Integer 0-40 (0 - inactive, 1-20 - conditions not met, respectively EV 1 - EV 20, 21-40 - conditions met, respectively EV 1 - EV 20).

T Mode option for Action in Events. It allows you to specify when the event action will be performed - when the condition begins to be met, when it stops being met, or both (default behavior). An integer 0-2.

{
    "0": "Action when the condition starts or stops to be met",
    "1": "Action only when the condition starts to be met",
    "2": "Action only when the condition stops to be met",
}

Deleting the entry

In order for an entry to be invisible (not set) on the list in the web interface, it must have 0 set in the B field.

Schedules (Scheduler)¶

schedule¶

Sets a schedule entry (Scheduler).

schedule[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]*[M]*[N]

A - entry number, integer 1-50
B - determines whether the entry is set (1 - set), integer 0-1
C - the name of the entry, string up to 15 characters

D - action to be performed, integer 0-28

{
    0: 'OUT1',
    1: 'OUT2',
    2: 'OUT3',
    3: 'OUT4',
    4: 'OUT5',
    5: 'OUT6',
    6: 'OUT7',
    7: 'VAR1',
    8: 'VAR2',
    9: 'VAR3',
    10: 'VAR4',
    11: 'VAR5',
    12: 'VAR6',
    13: 'VAR7',
    14: 'VAR8',
    15: 'RESTART',
    16: 'RESET ENERGY1',
    17: 'RESET ENERGY2',
    18: 'RESET ENERGY3',
    19: 'RESET ENERGY4',
    20: 'RESET ENERGY5',
    21: 'RESET ENERGY6',
    22: 'OLED ON/NEXT SCREEN',
    23: 'COUNT ENERGY1',
    24: 'COUNT ENERGY2',
    25: 'COUNT ENERGY3',
    26: 'COUNT ENERGY4',
    27: 'COUNT ENERGY5',
    28: 'COUNT ENERGY6',
}

E - the value of the action, integer 0-2

{
    0: '0',
    1: '1',
    2: 'Reverse',
}

F - binary notation of 32 consecutive seconds (0-31, for each value 0-1), integer 0-4294967295
G - binary notation of 28 consecutive seconds (32-59, for each value 0-1), integer 0-268435455
H - binary notation of 32 consecutive minutes (0-31, for each value 0-1), integer 0-4294967295
I - binary notation of 28 consecutive minutes (32-59, for each value 0-1), integer 0-268435455
J - binary notation of 24 consecutive hours (0-23, for each value 0-1), integer 0-16777215
K - binary notation of 31 consecutive days of the month (0-30, for each value 0-1), integer 0-2147483647
L - binary notation of 12 consecutive months (0-11, for each value 0-1), integer 0-4095
M - binary notation of 7 consecutive days of the week (0-6, Poniedziałek-Wtorek, for each value 0-1), integer 0-127
N - determines whether the entry is active, integer 0-1

Watchdog¶

wdConfig¶

Sets parameters for the watchdog function at the selected position.

wdConfig[A]=[B]*[C]*[D]*[E]*[F]*[G]*[H]*[I]*[J]*[K]*[L]

A - entry number, integer 1-7
B - determines whether the entry is enabled, integer 0-1
C - determines whether email sending is enabled, integer 0-1

D - determines which output is controlled, integer 0-14

{
    0: 'OUT1',
    1: 'OUT2',
    2: 'OUT3',
    3: 'OUT4',
    4: 'OUT5',
    5: 'OUT6',
    6: 'OUT7',
    7: 'VAR1',
    8: 'VAR2',
    9: 'VAR3',
    10: 'VAR4',
    11: 'VAR5',
    12: 'VAR6',
    13: 'VAR7',
    14: 'VAR8',
}

E - IP address/domain to monitor, a string of characters
F - number of consecutive ping failures before restarting the output, integer
G - timeout in seconds for the ping command, integer
H - time in seconds between ping tests, integer
I - ping resumption delay after output restart, in seconds, integer
J - output restart time in seconds, integer
K - number of consecutive restarts before stopping the watchdog function (value 0 means no limit), integer
L - watchdog start delay after device start up in seconds, integer

HTTP Client¶

httpModem¶

Causes HTTP requests to be sent over a modem instead of an Ethernet connection.

httpModem=[A]

A - integer 0-1

httpReadingCode¶

Changes the format for inserting readings from the device from %XXXA to %%XXXA, i.e. requires double %.

httpReadingCode=[A]

A - integer 0-1

httpDigestAuth¶

Causes the HTTP request to use Digest Authentication after a failed attempt with Basic Authentication.

httpDigestAuth=[A]

A - integer 0-1

httpPerEnabled¶

Available from SW 1.14

Activates periodic sending of the first set HTTP GET query entry.

httpPerEnabled=[A]

A - integer 0-1

httpPerPeriod¶

Available from SW 1.14

Sets the sending period in seconds for the periodic sending function.

httpPerPeriod=[A]

A - integer 5-...

httpPerURL¶

Available from SW 1.14

Sets the GET query URL for the periodic sending function.

httpPerURL=[A]

A - a string of characters in the format http(s)://([USERNAME]:[PASSWORD]@)[HOST(DOMAIN OR IP):[PORT][PATH], e.g. http://admin:admin@192.168.1.100:80/api/v1/save/?out=out1

httpURLEv¶

Available from SW 1.14

Sets the GET query URL for the Events function (HTTP action with variants: T - when the condition starts to be met, F - when the condition stops to be met).

httpURLEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of HTTP action, integer 1-4
C - a string of characters in the format http(s)://([USERNAME]:[PASSWORD]@)[HOST(DOMAIN OR IP):[PORT][PATH], e.g. http://admin:admin@192.168.1.100:80/api/v1/save/?out=out1

httpEnabled¶

Removed in SW 1.14. Instead, use httpPerEnabled.

Activates periodic sending of the first set HTTP GET query entry.

httpEnabled=[A]

A - integer 0-1

httpPeriod¶

Removed in SW 1.14. Instead, use httpPerPeriod.

Sets the sending period in seconds for the periodic sending function.

httpPeriod=[A]

A - integer 5-...

httpHost¶

Removed in SW 1.14. Instead, use httpPerURL and httpURLEv.

Sets the IP address / domain with optional Basic Authentication/Digest Authentication authentication information. It must also contain a choice of http or https.

httpHost[A]=[B]

A - position number, integer 1-4
B - protocol, IP address/domain and optional credentials, string, e.g. http://admin:admin@192.168.1.100

httpPort¶

Removed in SW 1.14. Instead, use httpPerURL and httpURLEv.

Sets the port to which the query will be sent.

httpPort[A]=[B]

A - position number, integer 1-4
B - port, integer 1-65535

httpPath¶

Removed in SW 1.14. Instead, use httpPerURL and httpURLEv.

Sets the query path.

httpPath[A]=[B]

A - position number, integer 1-4
B - query path, with a leading /, string, e.g. /api/v1/save/?out1=1

MQTT Client¶

mqttEnabled¶

Activates the MQTT client.

mqttEnabled=[A]

A - integer 0-1

mqttAuth¶

Makes the client use the authentication data (login and password).

mqttAuth=[A]

A - integer 0-1

mqttHost¶

Sets the IP address/domain of the MQTT server to connect to.

mqttHost=[A]

A - string up to 128 characters

mqttPort¶

Sets the MQTT server port.

mqttPort=[A]

A - port, integer 1-65535

mqttLogin¶

Sets the username to authenticate.

mqttLogin=[A]

A - string up to 99 characters

mqttPassword¶

Sets the password for authentication.

mqttPassword=[A]

A - string up to 199 characters

mqttPrefix¶

Sets the prefix for the topics used by the device (subscribe and publish).

mqttPrefix=[A]

A - string up to 13 characters

mqttPeriod¶

Sets the data sending period in seconds.

mqttPeriod=[A]

A - integer 5-...

mqttKeepAlive¶

Sets the value for the Keep Alive parameter.

mqttKeepAlive=[A]

A - integer 5-...

mqttTLS¶

Causes the client to use an encrypted connection (the feature must be offered by the server).

mqttTLS=[A]

A - integer 0-1

mqttLWT¶

Causes the client to use LWT. As a result, when connected to the server, it will publish a message 1 on the topic [mqttPrefix]/connected, and if the client loses connection with the server, the server will publish a message 0 on the previously mentioned topic.

mqttLWT=[A]

A - integer 0-1

mqttModem¶

Causes the MQTT connection to be established via a modem instead of an Ethernet connection.

mqttModem=[A]

A - integer 0-1

mqttSend¶

Sets which readings will be periodically sent.

mqttSend=[A]

A - a string of 48 integers 0-1, corresponding to consecutive readings as listed below

{
    0: 'UAC',
    1: 'IAC',
    2: 'DS1',
    3: 'DS2',
    4: 'DS3',
    5: 'DS4',
    6: 'DS5',
    7: 'DS6',
    8: 'DS7',
    9: 'DS8',
    10: 'T1',
    11: 'H1',
    12: 'DIFF1',
    13: 'DIFF2',
    14: 'DIFF3',
    15: 'DIFF4',
    16: 'DIFF5',
    17: 'DIFF6',
    18: 'INPD1',
    19: 'INPD2',
    20: 'OUT1',
    21: 'OUT2',
    22: 'OUT3',
    23: 'OUT4',
    24: 'OUT5',
    25: 'OUT6',
    26: 'OUT7',
    27: 'POWER1',
    28: 'POWER2',
    29: 'POWER3',
    30: 'POWER4',
    31: 'POWER5',
    32: 'POWER6',
    33: 'ENERGY1',
    34: 'ENERGY2',
    35: 'ENERGY3',
    36: 'ENERGY4',
    37: 'ENERGY5',
    38: 'ENERGY6',
    39: 'VAR1',
    40: 'VAR2',
    41: 'VAR3',
    42: 'VAR4',
    43: 'VAR5',
    44: 'VAR6',
    45: 'VAR7',
    46: 'VAR8',
    47: 'UPTIME',
    48: 'IP', // added in SW 1.14
    49: 'Time', // added in SW 1.14
    50: 'Date', // added in SW 1.14
    51: 'Dew Point', // added in SW 1.14
}

SNMP¶

snmpTrapEnabled¶

Activates the Trap function.

snmpTrapEnabled=[A]

A - integer 0-1

snmpV2Enabled¶

Activates SNMPv2c support.

snmpV2Enabled=[A]

A - integer 0-1

snmpV3Enabled¶

Activates SNMPv3 support.

snmpV3Enabled=[A]

A - integer 0-1

snmpCommRead¶

Sets the read password.

snmpCommRead=[A]

A - string up to 31 characters

snmpCommWrite¶

Sets the save password.

snmpCommWrite=[A]

A - string up to 31 characters

snmpCommTrap¶

Sets the Trap password.

snmpCommTrap=[A]

A - string up to 31 characters

snmpTrapReceive¶

Sets the Trap receiver address.

snmpTrapReceive=[A]

A - a string of characters

snmpUser¶

Sets the user name to be authenticated (SNMPv3).

snmpUser=[A]

A - string up to 31 characters

snmpAuthPass¶

Sets the authentication password (SNMPv3).

snmpAuthPass=[A]

A - string up to 19 characters

snmpPrivacyPass¶

Sets the privacy password (SNMPv3).

snmpPrivacyPass=[A]

A - string up to 19 characters

Network¶

netHostname¶

Sets the hostname of the device, also used as the device name on the page, e.g. in the title.

netHostname=[A]

A - hostname, a string of characters

netHttpPort¶

Sets the port on which the device's HTTP server will listen for requests (and host the page).

netHttpPort=[A]

A - integer 1-65535

netHttpsOn¶

Activates encryption of the HTTP connection to the web interface, i.e. HTTPS.

Attention

HTTPS listening is always performed on the standard port 443.

netHttpsOn=[A]

A - integer 0-1

netMac¶

Sets the device's MAC address.

netMac=[A]

A - MAC address, a string of characters

netDhcp¶

Activates address retrieval via DHCP.

netDhcp=[A]

A - integer 0-1

netIp¶

Sets the IP address of the device.

netIp=[A]

A - IP address, a string of characters

netMask¶

Sets the subnet mask.

netMask=[A]

A - subnet mask, a string of characters

netGateway¶

Sets the default gateway address.

netGateway=[A]

A - IP address, a string of characters

netDns1¶

Sets the primary DNS server address.

netDns1=[A]

A - IP address, a string of characters

netDns2¶

Sets the secondary DNS server address.

netDns2=[A]

A - IP address, a string of characters

Time¶

timeNTP¶

Activates time synchronization using NTP.

timeNTP=[A]

A - integer 0-1

timeManual¶

Sets the device's system time.

timeManual=[A]

A - UNIX timestamp (number of seconds since early 1970 UTC), integer

timeNTPHost¶

Sets the address of the NTP server.

timeNTPHost=[A]

A - IP address/domain, a string of characters

timeNTPPort¶

Sets the NTP server port.

timeNTPPort=[A]

A - port, integer 1-65535

timeTimezone¶

Sets the time zone.

timeTimezone=[A]

A - time zone number, integer

List of options

{
    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¶

Sets the time update interval in NTP mode.

timeNTPPeriod=[A]

A - update interval in seconds, integer

timeSetRTC¶

Saves the given time and date in the RTC.

timeSetRTC=[A]

A - sequence of integers separated by , ([YEAR],[MONTH],[DAY OF THE MONTH],[HOUR],[MINUTE],[SECOND], e.g. 2023,03,13,12,43,00 )

Access¶

auth¶

Activates Basic Authentication for HTTP access.

auth=[A]

A - integer 0-1

upgr¶

Specifies whether the firmware can be updated over HTTP.

upgr=[A]

A - integer 0-1

adminLogin¶

Sets the administrator username.

adminLogin=[A]

A - string up to 15 characters (Base64 encoded)

adminPass¶

Sets the administrator password.

adminPass=[A]

A - string up to 15 characters (Base64 encoded)

userLogin¶

Sets the username (with access to the Status page only).

userLogin=[A]

A - string up to 15 characters (Base64 encoded)

userPass¶

Sets the user's password (with access to the Status page only).

userPass=[A]

A - string up to 15 characters (Base64 encoded)

authUser¶

Sets the username and password combinations that will have access to output control when Basic Authentication is enabled.

authUser[A]=[B]*[C]*[D]*[E]

A - entry number, integer 1-50
B - determines whether the entry is set (1 - set), integer 0-1
C - determines whether the entry is active, integer 0-1
D - username, string up to 15 characters
E - user password, string up to 15 characters

E-mail¶

emailHost¶

Sets the address of the SMTP server.

emailHost=[A]

A - a string up to 64 characters

emailPort¶

Sets the SMTP server port.

emailPort=[A]

A - port, integer 1-65535

emailUser¶

Sets the username (access data).

emailUser=[A]

A - a string up to 64 characters

emailPassword¶

Sets the user's password (access data).

emailPassword=[A]

A - a string up to 64 characters

emailSender¶

Sets the sender's address (usually the same as emailUser).

emailSender=[A]

A - a string up to 64 characters

emailTLS¶

Activates support for TLS encryption when connecting to the server.

emailTLS=[A]

A - integer 0-1

emailWdTo¶

Available from SW 1.14

Sets the recipient's address for Watchdog function.

emailWdTo=[A]

A - a string up to 64 characters

emailWdSubj¶

Available from SW 1.14

Sets the subject of the email for Watchdog function.

emailWdSubj=[A]

A - a string up to 64 characters

emailWdText¶

Available from SW 1.14

Sets the email content for Watchdog function.

emailWdText=[A]

A - string up to 256 characters

emailToEv¶

Available from SW 1.14

Sets the recipient's address for the Events function (Email action with variants: T - when the condition starts to be met, F - when the condition stops to be met).

emailToEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of Email action, integer 1-4
C - a string up to 64 characters

emailSubjEv¶

Available from SW 1.14

Sets the subject of the email for the Events function (Email action with variants: T - when the condition starts to be met, F - when the condition stops to be met).

emailSubjEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of Email action, integer 1-4
C - a string up to 64 characters

emailTextEv¶

Available from SW 1.14

Sets the email content for the Events function (Email action with variants: T - when the condition starts to be met, F - when the condition stops to be met).

emailTextEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of Email action, integer 1-4
C - a string up to 256 characters

testemail¶

Sends a test email according to the current configuration.

testemail=1

emailReceiver¶

Removed in SW 1.14. Instead, use emailWdTo and emailToEv.

Sets the recipient's address.

emailReceiver=[A]

A - a string up to 64 characters

emailSubject¶

Removed in SW 1.14. Instead, use emailWdSubj and emailSubjEv.

Sets the subject of the email.

emailSubject=[A]

A - a string up to 64 characters

emailTextOn¶

Removed in SW 1.14. Instead, use emailWdText and emailTextEv.

Sets the content of the message used when the event condition is met.

emailTextOn[A]=[B]

A - number of the text pair, integer 1-4
B - string up to 256 characters

emailTextOff¶

Removed in SW 1.14. Instead, use emailWdText and emailTextEv.

Sets the content of the message used when the event condition expires.

emailTextOff[A]=[B]

A - number of the text pair, integer 1-4
B - string up to 256 characters

OLED¶

oledEnabled¶

Activates the OLED function.

oledEnabled=[A]

A - integer 0-1

oledTime¶

Sets the display time, i.e. the time for which the display will be on after an activation event occurs (actions OLED ON/NEXT SCREEN and OLED - SET SCREEN X in Events and Schedule). For value 0 the display is always on.

oledTime=[A]

A - time in seconds, integer

oledSize¶

Sets the size of the supported display.

oledSize=[A]

A - option number, integer 0-1

{
    0: '128 x 64',
    1: '128 x 32',
}

oledFrequency¶

Sets the frequency of I2C communication with the display.

oledFrequency=[A]

A - frequency in kHz, integer 50-400

oledScreen¶

Activates the selected screen configuration for display (inactive items will be skipped by the OLED ON/NEXT SCREEN actions).

oledScreen[A]=[B]

A - screen number, integer 1-4
B - determine whether it is active, integer 0-1

oledLine¶

Set the text of the selected line in the selected screen configuration.

oledLine[A][B]=[C]

A - screen number, integer 1-4
B - line number, integer 1-4
C - string up to 159 characters

Modem¶

modemCmd¶

Sends an AT command to the modem. The response will be available in the modemConsole variable.

modemCmd=[A]

A - a string of characters

modemCode¶

Sets the access code for SMS commands (every command must be preceded by [modemCode]:[command]).

modemCode=[A]

A - string up to 4 characters, digits only

modemAPN¶

Sets the APN, username and password.

modemAPN=[A]

A - string up to 63 characters, in the format "[APN]","[USERNAME]","[PASSWORD]", e.g. "internet","",""

modemReturnSMS¶

Activates sending SMS confirmations to SMS commands.

modemReturnSMS=[A]

A - integer 0-1

modemNumberEv¶

Available from SW 1.14

Sets the recipient number for the Events function (SMS action with variants: T - when the condition starts to be met, F - when the condition stops to be met). .

modemNumberEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of SMS action, integer 1-4
C - phone numbers separated by :, string

modemTextEv¶

Available from SW 1.14

Ustawia treść wiadomości dla funkcji Zdarzenia (działanie SMS z wariantami: T - po spełnieniu warunku, F - gdy warunek przestaje być spełniony). .

modemTextEv[A][B]=[C]

A - T or F character, for when the condition starts or stops to be met
B - number of SMS action, integer 1-4
C - string up to 256 characters

modemSendSMS¶

Sends a test SMS according to the current configuration (first position).

modemSendSMS

modemNumber¶

Removed in SW 1.14. Instead, use modemNumberEv.

Sets the recipient number for the position.

modemNumber[A]=[B]

A - position number, integer 1-4
B - phone numbers separated by :, string

modemTextOn¶

Removed in SW 1.14. Instead, use modemTextEv.

Sets the content of the message used when the event condition is met.

modemTextOn[A]=[B]

A - position number, integer 1-4
B - string up to 256 characters

modemTextOff¶

Removed in SW 1.14. Instead, use modemTextEv.

Sets the content of the message used when the event condition expires.

modemTextOff[A]=[B]

A - position number, integer 1-4
B - string up to 256 characters

Other settings¶

Some parameters can only be configured using HTTP POST requests, not HTTP GET or MQTT. They are described below.

Image for Status for user¶

To set an image, it must be sent in binary form as POST query data to the address [IP]/api/v1/post_data/pictureupload.

Firmware update¶

To update the firmware, it should be sent in binary form as POST query data to the address [IP]/api/v1/upload_firmware/new_firmware.

Uploading a backup¶

To upload a backup, send it in binary form as POST request data to the address [IP]/api/v1/upload_firmware/backupSettings.