Editing device settings is performed using the *!EDITS command, while reading the current settings is done with the *!READ command. Configuration parameters are addressed using the following hierarchy: page -> tag -> parameters.
The *!SETFM command is used to modify the FLEX protocol field mask.
Configuration Parameters Configuration structure reference for all devices¶ Edit Settings
Command for editing device settings and saving the configuration.
The device will reboot after executing this command.
Multiple pages, tags, and parameters can be included in a single 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>(...) |
|
| Parameter | Description |
<s> |
Parameter separator – space. |
<pX> |
Name of the Page containing the tag. Must end with the : character. |
<tX> |
Name of the Tag to be edited. Must end with the ( character. |
<aX> |
Parameter values to be written to the device. The last parameter in the tag must end with the ) character. |
¶ 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 execution result: OK - command completed successfully; FAIL - command error. |
<pX> |
Name of the Page containing the modified tag. |
<tX> |
Name of the Tag that was modified. |
<aX> |
Values of all parameters in the modified tag. |
¶ Read Settings
Read the current configuration values.
Multiple pages and tags can be included 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 containing the tag. Must end with the : character. |
<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> |
Command execution result: OK - command completed successfully; FAIL - command error. |
<pX> |
Name of the Page containing the tag. |
<tX> |
Name of the Tag that was read. |
<aX> |
Parameter values read from the device. |
¶ Modify FLEX Parameters
Command for editing the FLEX protocol field mask.
Field numbers and descriptions are provided in the data exchange protocol, Appendix A.1. The latest protocol specification is available here.
This command causes the device to reboot.
¶ Request / Command
The example ENABLES fields 6, 7, 8, 9, 20, and 22, while DISABLING field 21.
*!SETFM 6:1111,20:101
| Format | |
*!SETFM<s><n>:<m>,... |
|
| Parameter | Description |
<s> |
Parameter separator – space. |
<n> |
Index of the first field to modify, starting from 1. (corresponds to the FLEX protocol field number) |
<m> |
Bit mask consisting of 0 and 1 characters.(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 of the first modified field, starting from 1. |
<m> |
Bit mask. |
¶ Rules and Examples
Below are several important rules and useful examples for the *!EDITS command.
¶ Rule 1
Parameters must follow the exact order defined in the configuration structure. Pages and tags may appear in any order.
*!EDITS TRANS:SRV1(FLEX,0,1,193.193.165.165,21626,TCP)
¶ Rule 2
If the ! character is used instead of a parameter value, the corresponding parameter is cleared.
*!EDITS TRANS:SRV1(,,,!,!)
When a parameter is cleared, text values are erased, while numeric values are set to 0.
¶ Rule 3
If a command is incomplete, specified parameters are updated, while omitted parameters (represented by two consecutive commas) remain unchanged.
*!EDITS TRANS:SRV1(,,,,21626)
¶ Rule 4
To modify or read multiple parameters located in different tags or pages, combine them into a single request.
*!READ TRANS:SRV1,AP1,SYSTEM:PASS
*!EDITS TRANS:SRV1(,,,193.193.165.165,21626),AP1(internet),SYSTEM:PASS(1234,1234)