Changes

Codec (view source)

Revision as of 15:32, 1 August 2023

2,673 bytes added , 15:32, 1 August 2023

no edit summary

Line 19: Line 19:

|-

|}

−

Also, there are using two data transport protocols: TCP and UDP. But it is not important which one will be ~~use~~ in Codec.

+

Also, there are using two data transport protocols: TCP and UDP. But it is not important which one will be used in Codec.

='''<big>Codec for device data sending</big>'''=

Line 65: Line 65:

'''Number of Data 2''' – a number which defines how many records is in the packet. This number must be the same as “Number of Data 1”.

'''CRC-16''' – calculated from Codec ID to the Second Number of Data. CRC (Cyclic Redundancy Check) is an error-detecting code using for detect accidental changes to RAW data. For calculation we are using [[Codec#CRC-16|CRC-16/IBM]].

−

'''Note:''' for [[FMB630]], [[FMB640]] and [[FM6300|FM63XY]], minimum AVL ~~packet~~ size is 45 bytes (all IO elements disabled). Maximum AVL packet size is ~~255~~ bytes. For other devices, minimum AVL ~~packet~~ size is 45 bytes (all IO elements disabled). Maximum AVL packet size is 1280 bytes.

+

'''Note:''' for [[FMB630]], [[FMB640]] and [[FM6300|FM63XY]], minimum AVL record size is 45 bytes (all IO elements disabled). Maximum AVL record size is 255 bytes. Maximum AVL packet size is 512 bytes. For other devices, minimum AVL record size is 45 bytes (all IO elements disabled). Maximum AVL packet size is 1280 bytes.

*AVL Data

Line 135: Line 135:

'''Satellites''' – number of visible satellites.

'''Speed''' – speed calculated from satellites.

−

'''Note:''' ~~Speed will be <code>0x0000</code> if~~ GPS data ~~is invalid~~.

+

'''Note:''' If record are without valid coordinates – (there were no GPS fix in the moment of data acquisition) – Longitude, Latitude and Altitude values are last valid fix, and Angle, Satellites and Speed are 0.

Longitude and latitude are integer values built from degrees, minutes, seconds and milliseconds by formula:

[[Image:GPS.png]]

Line 305: Line 305:

| rowspan="24" style="vertical-align: middle; text-align: center;" |AVL Data

| style="vertical-align: middle; text-align: center;" |Timestamp

−

| style="vertical-align: middle; text-align: center;" |00 00 00 01 6B 40 D8 EA 30 (GMT: Monday, June 10, 2019 10:04:46 AM)

+

| style="vertical-align: middle; text-align: center;" |00 00 01 6B 40 D8 EA 30 (GMT: Monday, June 10, 2019 10:04:46 AM)

|-

| style="vertical-align: middle; text-align: center;" |Priority

Line 466: Line 466:

|-

| style="vertical-align: middle; text-align: center;" |1’st IO Value

−

| style="vertical-align: middle; text-align: center;" |5E 0F

+

| style="vertical-align: middle; text-align: center;" |5E 10

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 556: Line 556:

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 606: Line 606:

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 626: Line 626:

*'''<big>Codec8 protocol sending over UDP</big>'''

−

UDP is a transport layer protocol above UDP/IP to add reliability to plain UDP/IP using acknowledgment packets.

+

Codec8 protocol over UDP is a transport layer protocol above UDP/IP to add reliability to plain UDP/IP using acknowledgment packets.

*'''AVL Data Packet'''

Line 857: Line 857:

| style="vertical-align: middle; text-align: center;" |5D BC

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 1,038: Line 1,038:

'''Satellites''' – number of visible satellites.

'''Speed''' – speed calculated from satellites.

−

'''Note:''' ~~Speed will be <code>0x0000</code> if~~ GPS data ~~is invalid~~.

+

'''Note:''' If record are without valid coordinates – (there were no GPS fix in the moment of data acquisition) – Longitude, Latitude and Altitude values are last valid fix, and Angle, Satellites and Speed are 0.

Longitude and latitude are integer values built from degrees, minutes, seconds and milliseconds by formula:

[[Image:GPS.png]]

Line 1,057: Line 1,057:

| style="vertical-align: middle; text-align: center;" |2 bytes

| rowspan="33" style=" width:5%; vertical-align: middle; text-align: left;" |

−

| rowspan="33" style=" width:65%; vertical-align: middle; text-align: left;" |'''Event IO ID''' – if data is acquired on event – this field defines which IO property has changed and generated an event. For example, when if Ignition state changed and it generate event, Event IO ID will be ~~0xEF~~ (AVL ID: 239). If it’s not eventual record – the value is 0.

+

| rowspan="33" style=" width:65%; vertical-align: middle; text-align: left;" |'''Event IO ID''' – if data is acquired on event – this field defines which IO property has changed and generated an event. For example, when if Ignition state changed and it generate event, Event IO ID will be 0x00EF (AVL ID: 239). If it’s not eventual record – the value is 0x0000.

'''N''' – a total number of properties coming with record (N = N1 + N2 + N4 + N8).

'''N1''' – number of properties, which length is 1 byte.

Line 1,273: Line 1,273:

| style="vertical-align: middle; text-align: center;" |00 1D

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00 01

|-

Line 1,282: Line 1,282:

| style="vertical-align: middle; text-align: center;" |01 5E 2C 88

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00 02

|-

Line 1,316: Line 1,316:

*'''UDP channel protocol'''

−

AVL data packet is the same as with Codec8, except Codec ID is changed to <code>0x8E</code>.

+

AVL data packet is the same as with Codec8, except Codec ID is changed to <code>0x8E</code>. AVL Data encoding performed according to Codec8 Extended protocol.

*'''Communication with server'''

Line 1,455: Line 1,455:

| style="vertical-align: middle; text-align: center;" |00 1D

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00 01

|-

Line 1,464: Line 1,464:

| style="vertical-align: middle; text-align: center;" |01 5E 2C 88

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00 02

|-

Line 1,649: Line 1,649:

'''Satellites''' – number of visible satellites.

'''Speed''' – speed calculated from satellites.

−

'''Note:''' ~~Speed will be <code>0x0000</code> if~~ GPS data ~~is invalid~~.

+

'''Note:''' If record are without valid coordinates – (there were no GPS fix in the moment of data acquisition) – Longitude, Latitude and Altitude values are last valid fix, and Angle, Satellites and Speed are 0.

Longitude and latitude are integer values built from degrees, minutes, seconds and milliseconds by formula:

[[Image:GPS.png]]

Line 1,912: Line 1,912:

| style="vertical-align: middle; text-align: center;" |56 3A

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 1,983: Line 1,983:

| style="vertical-align: middle; text-align: center;" |56 3A

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 2,001: Line 2,001:

Server response: <code>00000002</code>

−

*'''<big>Codec16 ~~Extended~~ protocol sending over UDP</big>'''

+

*'''<big>Codec16 protocol sending over UDP</big>'''

*'''UDP channel protocol'''

−

AVL data packet is the same as with Codec8, except Codec ID is changed to <code>0x10</code>.

+

AVL data packet is the same as with Codec8, except Codec ID is changed to <code>0x10</code>. AVL Data encoding performed according to Codec16 protocol.

*'''Communication with server'''

Line 2,164: Line 2,164:

| style="vertical-align: middle; text-align: center;" |11 1A

|-

−

| style="vertical-align: middle; text-align: center;" |N4 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N4 of Four Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

−

| style="vertical-align: middle; text-align: center;" |N8 of ~~Two~~ Bytes IO

+

| style="vertical-align: middle; text-align: center;" |N8 of Eight Bytes IO

| style="vertical-align: middle; text-align: center;" |00

|-

Line 2,177: Line 2,177:

Server response in hexadecimal stream:

−

+

Parsed:

{| class="nd-othertables_2" style="width:100%;"

Line 2,201: Line 2,201:

|-

| style="vertical-align: middle; text-align: center;" |Number of Accepted Data

−

| style="vertical-align: middle; text-align: center;" |00

+

| style="vertical-align: middle; text-align: center;" |01

|-

|}

Line 2,230: Line 2,230:

|-

! rowspan="1" style="width:10%; vertical-align: middle; text-align: center;" |Generation Type

−

| style="vertical-align: middle; text-align: center;" |Is Using

+

| style="vertical-align: middle; text-align: center;" |Not Using

| style="vertical-align: middle; text-align: center;" |Is Using

Line 2,258: Line 2,258:

*'''<big>About Codec12</big>'''

−

Codec12 is original and main Teltonika protocol for device-server communication over GPRS messages. Codec12 GPRS commands can be used for sending configuration, debug, digital outputs control commands or other (special purpose command on special firmware versions). This protocol is also necessary for using [[FMB630]]/[[FM6300]]/FM5300/FM5500/FM4200 features like: Garmin, LCD communication, COM TCP Link Mode.

+

Codec12 is the original and main Teltonika protocol for device-server communication over GPRS messages. Codec12 GPRS commands can be used for sending configuration, debug, digital outputs control commands or other (special purpose command on special firmware versions). This protocol is also necessary for using [[FMB630]]/[[FM6300]]/FM5300/FM5500/FM4200 features like: Garmin, LCD communication, COM TCP Link Mode.

+

*'''<big>FM firmware requirements</big>'''

+

Supported GPRS commands on each device depending on the firmware version. For available GPRS commands on each device, please refer to the table below.

+

{| class="nd-othertables" style="width:75%;"

+

|+

+

! rowspan="1" style="width:25%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Device

+

! rowspan="1" style="width:25%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |SMS over GPRS via TCP

+

! rowspan="1" style="width:25%; border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |SMS over GPRS via UDP

+

|-

+

| style="vertical-align: middle; text-align: left;" |FM36YX

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

| style="vertical-align: middle; text-align: center;" |Since base firmware 01.06.01

+

|-

+

| style="vertical-align: middle; text-align: left;" |FM63YX

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

| style="vertical-align: middle; text-align: center;" |Since base firmware 00.02.19

+

|-

+

| style="vertical-align: middle; text-align: left;" |FMB, FMC, FMM, FMU family devices (exclude FMB6YX, [[FMC640]], [[FMM640]])

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

|-

+

| style="vertical-align: middle; text-align: left;" |FMB6YX

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

| style="vertical-align: middle; text-align: center;" |Since base firmware 00.02.19

+

|-

+

| style="vertical-align: middle; text-align: left;" |[[FMC640]], [[FMM640]]

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

| style="vertical-align: middle; text-align: center;" |Available in base firmware

+

|-

+

|}

+

'''Note:''' “SMS over GPRS” means that all standard SMS commands text can be sent to the device via GPRS in Codec12 format.

*'''<big>GPRS command session</big>'''

−

~~Following~~ figure shows how GRPS command session is started over TCP.

+

The following figure shows how the GRPS command session is started over TCP.

[[File:Codec12.png|1150px]]

−

First, Teltonika device opens GPRS session and sends AVL data to server (refer device protocols). Once all records are sent and correct sent data array acknowledgment is received by device then GPRS commands in Hex can be sent to device.

+

First, the Teltonika device opens the GPRS session and sends AVL data to the server (refer device protocols). Once all records are sent and correct sent data array acknowledgment is received by device then GPRS commands in Hex can be sent to the device.

−

The ACK (acknowledge of IMEI from server) is a one byte constant 0x01. The ~~acknowledgement~~ of each data array send from device is four bytes integer – number of records received.

+

The ACK (acknowledge of IMEI from server) is a one-byte constant 0x01. The acknowledgment of each data array send from the device is four bytes integer – the number of records received.

−

Note, that GPRS session should remain active between device and server, while GPRS commands are sent. For this reason, active datalink timeout (global parameters in device configuration) is recommended to be set to 259200 (maximum value).

+

Note, that the GPRS session should remain active between device and server, while GPRS commands are sent. For this reason, active datalink timeout (global parameters in device configuration) is recommended to be set to 259200 (maximum value).

*'''<big>General Codec12 message structure</big>'''

Line 2,341: Line 2,373:

*'''<big>Command parsing example</big>'''

−

Hexadecimal stream of command and answer in this example ~~are~~ given in hexadecimal form. The different fields of message are ~~separate~~ into different table columns for better readability and understanding.

+

Hexadecimal stream of command and answer in this example is given in hexadecimal form. The different fields of the message are separated into different table columns for better readability and understanding.

*'''<big>GPRS commands examples</big>'''

Line 2,530: Line 2,562:

*'''COM TCP Link Mode'''

−

All information is provided in “FMxx TCP Link mode test instructions.pdf” document.

+

All information is provided in “FMxx TCP Link mode test instructions.pdf” document.

=='''<big>Codec 13</big>'''==

Line 2,560: Line 2,592:

| style="vertical-align: middle; text-align: center;" |1 byte

| style="vertical-align: middle; text-align: center;" |4 bytes

−

| style="vertical-align: middle; text-align: center;" |8 bytes

+

| style="vertical-align: middle; text-align: center;" |4 bytes

| style="vertical-align: middle; text-align: center;" |X bytes

| style="vertical-align: middle; text-align: center;" |1 byte

Line 2,574: Line 2,606:

'''Command Type''' – it is always <code>0x05</code> since the packet is direction is FM->Server.

'''Command Size''' – command size field includes size of timestamp too, so it is equal to size of payload + size of timestamp.

−

'''Timestamp''' – a difference, in ~~milliseconds~~, between the current time and midnight, January, 1970 UTC (UNIX time).

+

'''Timestamp''' – a difference, in seconds, between the current time and midnight, January, 1970 UTC (UNIX time).

'''Command''' – actual received data.

'''Command Quantity 2''' – a byte which defines how many records (commands) is in the packet. This byte will not be parsed but it’s recommended that it should contain same value as Command/Response Quantity 1.

Line 2,585: Line 2,617:

Sending ''[[FMB getinfo|getinfo]]'' SMS command via GPRS Codec13.

Hexadecimal stream:

−

+

Parsed:

{| class="nd-othertables_2" style="width:100%;"

Line 2,613: Line 2,645:

|-

| style="vertical-align: middle; text-align: center;" |Timestamp

−

| style="vertical-align: middle; text-align: center;" |~~00 00 01 6C~~ 0A 81 C3 20

+

| style="vertical-align: middle; text-align: center;" |0A 81 C3 20

|-

| style="vertical-align: middle; text-align: center;" |Command

Line 2,747: Line 2,779:

|-

| style="vertical-align: middle; text-align: center;" |IMEI

−

| style="vertical-align: middle; text-align: center;" |~~00 00 00 0E~~

+

| style="vertical-align: middle; text-align: center;" |03 52 09 30 81 45 22 51

|-

| style="vertical-align: middle; text-align: center;" |Command

−

| style="vertical-align: middle; text-align: center;" |~~03 52 09 30 81 45 22 51~~

+

| style="vertical-align: middle; text-align: center;" |67 65 74 76 65 72

|-

| style="vertical-align: middle; text-align: center;" |Command Quantity 2

Vladimir.sirotenko

Administrators

633

edits