Description of Binary Exchange Protocol Commands
Format of Binary Protocol Messages
All the commands of the binary communication protocol have the same standardized format which is given in the Table:
| Sequential number of the field | Field name | Field size, byte | Description |
|---|---|---|---|
| 1 | Prefix | 1 | The field is a marker of the message beginning shall have prefix 31h, and an outcoming messages shall be displayed with 3Eh prefix by the program. |
| 2 | Network address | 1 | For prefix 31h specify the network address of the recipient For prefix 3Eh specify the network address of the sender |
| 3 | Operation code | 1 | For prefix 31h specify the code of operation which the program shall perform For Eh prefix specify the code of operation to which the response is given |
| 4 | Data | It depends on the operation code | Data composition and format of the field depends on the operation code |
| 5 | Checksum | 1 | The field is used to control over data integrity |
Single-Stage Data Reading (command 06h)
The command is designed for reading of the current data: relative level, temperature, frequency. The data are transmitted with a lower byte ahead.
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h..FFh | Network address of the recipient |
| +2 | 1 | 06h | Operation code |
| +3 | 1 | 00h..FFh | The checksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h..FFh | Network address of recipient |
| +2 | 1 | 06h | Operation code |
| +3 | 1 | -128…127 | Temperature in in degrees Celsius |
| +4 | 2 | 0000h…FFFFh | Relative level |
| +6 | 2 | 0000h…FFFFh | Frequency value |
| +8 | 1 | 00h..FFh | Checksum |
Periodic Data Output (command 07h)
Command is designed to switch on periodic data output.
After the command is processed, the sensor starts sending data periodically — level, temperature, and frequency — with the time interval prescribed by the 13h command.
Turning off of the periodic data output is performed after receipt of any true command, reset of the processor or disconnection of power power supply (if the data output mode is not istalled by default).
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h..FFh | The Network address of the sender |
| +2 | 1 | 07h | Operation code |
| +3 | 1 | 00h..FFh | Checksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h..FFh | Network address of recipient |
| +2 | 1 | 07h | Operation code |
| +3 | 1 | 00h | The command has been executed successfully |
| The command cannot be executed | |||
| +4 | 1 | 00h..FFh | Checksum |
Periodic data output format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h..FFh | The Network address of the sender |
| +2 | 1 | 07h | Operation code |
| +3 | 1 | -128…127 | Temperature in in degrees Celsius |
| +4 | 2 | 0000h…FFFFh | Relative level |
| +6 | 2 | 0000h…FFFFh | Frequency value |
| +8 | 1 | 00h..FFh | Checksum |
Periodic Data Output Interval Adjustment (13h command)
Command is designed to set up interval of periodic data output.
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h..FFh | Network address of the recipient |
| +2 | 1 | 13h | Operation code |
| +3 | 1 | 0…255 | Interval of the data output in seconds |
| +4 | 1 | 00h..FFh | Checksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h..FFh | The Network address of the sender |
| +2 | 1 | 13h | Operation code |
| +3 | 1 | 00h | The command has been executed successfully |
| +3 | 1 | 01h | The command cannot be executed |
| +4 | 1 | 00h..FFh | Checksum |
Default Data Output Mode (command 17h)
This command determines the order of data output after the sensor is powered on or the processor is reset. After the power is on or the processor is reset, the program will send data periodically via the interface at the time interval prescribed by the 13h command.
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h..FFh | Network address of the recipient |
| +2 | 1 | 17h | Operation code |
| +3 | 1 | 00h | No data output |
| +3 | 1 | 01h | The data are output in binary form |
| +3 | 1 | 02h | The data are output in character-coded form |
| +4 | 1 | 00h..FFh | Checksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h..FFh | Network address of the recipient |
| +2 | 1 | 17h | Operation code |
| +3 | 1 | 00h | The command has been executed successfully |
| +3 | 1 | 01h | The command cannot be executed |
| +4 | 1 | 00h…FFh | Checksum |
Change Tracking of the Sensor Configuration Settings (0Fh)
The command allows to download the entire memory space containing the configuration change records for Omnicomm LLS 30160 sensor. The records format is given in the table. Only the first 5 records are fixed in the Rom, other are rewritten according to the the circular buffer rule. the remaining elements can be overwritten according to the circular buffer rule.
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 31h | Prefix |
| +1 | 1 | 00h…FFh | The network address of the recipient |
| +2 | 1 | 0Fh | Operation code |
| +3 | 1 | 00h…FFh | Checksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h…FFh | The network address of the recipient |
| +2 | 1 | 0Fh | Operation code |
| +3 | 2 | 00h…FFFFh | The number of data bytes transmitted after the header (length) |
| +5 | length | 00h…FFh | Data |
| +5+length | 1 | 00h…FFh | Checksum |
Формат записи лога:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 4 | 0h…FFFFFFFFh | Sequential number of the record |
| +4 | 2 | 0 | The network address change |
| 1 | Exchange rate change | ||
| 2 | Nmin minimum value change | ||
| 3 | Nmax maximum value change | ||
| 4 | Filter length change | ||
| 5 | Automatic output mode change | ||
| 6 | Data output interval change | ||
| 7 | CNT 1 change — empty | ||
| 8 | CNT2 change — full | ||
| 0Аh | Programming the sensor | ||
| +6 | 4 | 0h…FFFFFFFFh | Configuration change time (unix time) |
| +10 | 4 | 0h…FFFFFFFFh | New parameter value |
| +14 | 1 | 00h…FFh | Checksum |
Format of response to an error:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h…FFh | The Network address of the sender |
| +2 | 1 | 0Fh | Operation code |
| +3 | 1 | 01h | The command cannot be executed |
| +4 | 1 | 00h…FFh | Checksum |
Filtration Rating Setting (10h command)
This command is intended to determine the value of the filter’s length on Omnicomm LLS 30160 sensor.
Command format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h..FFh | Network address of the recipient |
| +2 | 1 | 0Fh | Operation code |
| +3 | 1 | 00h..FFh | Cheksum |
Response format:
| Offset, bytes | Field size, bytes | Value | Description |
|---|---|---|---|
| 0 | 1 | 3Eh | Prefix |
| +1 | 1 | 00h…FFh | The network address of the recipient |
| +2 | 1 | 10h | Operation code |
| +3 | 16 | LLS 30160¹ | The name of the sensor. The type is a line constant. The value shall be set at the manufacturing plant during the PCB firmware. |
| +19 | 11 | LLS 1.0.0.0¹ | Designation of the program and its version |
| +30 | 1 | 00h…03h | Data output mode |
| +31 | 1 | 00h…FFh | Interval of measurement results output |
| +32 | 1 | 0…20 | Filter length |
| +33 | 2 | 0…4095 | The lower limit for changes in level |
| +35 | 2 | 1…4095 | Upper limit for changes in level |
| +37 | 3 | 000000h…FFFFFFh | CNT1 is the lower limit of the input signal period range |
| +40 | 3 | 000000h…FFFFFFh | CNT2 is the upper limit of the input signal period range |
| +43 | 1 | 00h…FFh | Checksum |
¹ the name of the sensor, version number and firmware designation can be different from the given in the table.
