*!EDITS command is provided for editing settings, and *!READ command for reading settings. Parameters are accessed according to the scheme: page -> tag -> parameters.
*!SETFM command is provided to change the composition of the parameters in the message.
List of Settings Description of configuration structure for all devices¶ Edit Settings
Command for editing settings with saving
Сommand causes reboot of the device.
It is possible to use multiple parameters, tags, and pages in one command.
¶ Request/Command
*!EDITS TRANS:SRV1(,,,193.193.165.165,20966),AP1(internet,,,),SYSTEM:PASS(,222)
| Format | |
*!EDITS<s><p1>:<t1>(<a1>,<a2>,...<aX>),<t2>(<aX>,...),<p2>:<t3>(...) |
|
| Description | Example |
<s> |
Parameter separator - space. |
<pX> |
Name of the Page, where tag is located, must end with :. |
<tX> |
Name of the Tag to be edited, must end with (. |
<aX> |
Parameter values to set in the device, the last parameter of the tag must end with ). |
¶ Response
*@EDITS OK,TRANS:SRV1(FLEX,0,1,193.193.165.165,21626,TCP),AP1(internet,,,),SYSTEM:PASS(1234,222)
| Format | |
*@EDITS<s><result>,<p1>:<t1>(<a1>,<a2>,...<aX>),<t2>(<aX>,...),<p2>:<t3>(...) |
|
| Parameter | Description |
<s> |
Parameter separator - space. |
<result> |
Command processing result: OK - command executed; FAIL - command execution error. |
<pX> |
Name of the Pahe where tag is located. |
<tX> |
Name of the edited Tag. |
<aX> |
Values of ALL parameters of the tag that has been edited. |
¶ Read Settings
Request current settings
It is possible to read multiple parameters and tags in a single request.
¶ Request/Command
*!READ TRANS:SRV1,AP1,SYSTEM:PASS
| Format | |
*!READ<s><p1>:<t1>,<t2>, ... ,<p2>:<t3>, ... |
|
| Parameter | Description |
<s> |
Parameter separator - space. |
<pX> |
Name of the Page, where tag is located, must end with :. |
<tX> |
Name of the Tag to be read. |
¶ Response
*@READ OK,TRANS:SRV1(FLEX,0,1,193.193.165.165,21626,TCP),AP1(internet,,,),SYSTEM:PASS(1234,222)
| Format | |
*@READ<s><result>,<p1>:<t1>(<a1>,<a2>,...<aX>),<t2>(<aX>,...),<p2>:<t3>(...) |
|
| Parameter | Description |
<s> |
Parameter separator - space. |
<result> |
Сommand processing result: OK - command executed; FAIL - command execution error. |
<pX> |
Name of the Page, where tag is located. |
<tX> |
Name of the read Tag. |
<aX> |
Values of the parameters read from the device. |
¶ Change FLEX Options
Command to edit FLEX mask bits.
Numbers and descriptions of the FLEX protocol fields are given in the Communication Protocol in the Annex A.1 section. You can find the protocol at this link.
Сommand causes reboot of the device.
¶ Request/Command
in the example turn on fields 6, 7, 8, 9, 20, 22 and turn off field 21
*!SETFM 6:1111,20:101
| Format | |
*!SETFM<s><n>:<m>,... |
|
| Parameter | Description |
<s> |
Parameter separator - space. |
<n> |
Index from which the bits will be set starts from 1. (index corresponds to the field number in the FLEX protocol) |
<m> |
bitmask consisting of characters 0 and 1.(from 1 to 4 bits, for example: 1 or 101) |
¶ Response
*@SETFM 6:1111,20:101
| Format | |
*@SETFM<s><n>:<m>,... |
|
| Parameter | Description |
<s> |
Parameter separator - space. |
<n> |
Index from which the bits are set, starts at 1. |
<m> |
Bitmask. |
¶ Rules and Examples
Here are some important features and useful examples for the *!EDITS command.
¶ Rule No. 1
If ! symbol is entered instead of a parameter in the command, then the parameter in the device configuration is reset.
*!EDITS TRANS:SRV1(,,,!,!)
On reset, the text parameters are removed and the numeric parameters are set to 0.
¶ Rule No. 2
Parameters are arranged in strict order according to the configuration structure. Tags and pages can be placed in any order.
*!EDITS TRANS:SRV1(FLEX,0,1,193.193.165.165,21626,TCP)
¶ Rule No. 3
If the command is incomplete, then filled fields will be replaced and empty ones (two commas in a row) will be skipped.
*!EDITS TRANS:SRV1(,,,,21626)
¶ Rule No. 4
If you need to change or request multiple settings in different tags on different configuration pages at the same time, you can compose a request that consists of multiple pages or tags.
*!READ TRANS:SRV1,AP1,SYSTEM:PASS
*!EDITS TRANS:SRV1(,,,193.193.165.165,21626),AP1(internet),SYSTEM:PASS(1234,1234)