Changes

1,085 bytes added , 7 May

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 512 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,290: Line 2,290:

|-

|}

−

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

+

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

+

'''Note:''' UDP commands are sent the same exact way as TCP commands.

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

Line 2,568: Line 2,569:

*'''<big>About Codec13</big>'''

−

Codec13 is original Teltonika protocol for device-server communication over GPRS messages ~~and it~~ is ~~based on Codec12 protocol. Main differences of Codec13 are that~~ timestamp is ~~using~~ in messages ~~and communication is~~ one way only (~~Codec13 is used for~~ Device -> Server sending).

+

Codec13 is original Teltonika protocol for device-server communication over GPRS messages. This protocol is necessary for using following FM features: COM TCP Link Mode (binary/ASCII/binary buffered/ASCII buffered) if message timestamp parameter is enabled in device configuration. Codec13 messages are one way only (Device → Server sending).

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

Line 2,578: Line 2,579:

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

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

−

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

+

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

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

−

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

+

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

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

−

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

+

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

−

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

+

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

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

|-

Line 2,601: Line 2,602:

'''Preamble''' – the packet starts with preamble field (four zero bytes).

−

'''Data Size''' – size is calculated from Codec ID field to the second ~~Command~~ Quantity field.

+

'''Data Size''' – size is calculated from Codec ID field to the second Response Quantity field.

'''Codec ID''' – in Codec13 it is always <code>0x0D</code>.

−

'''~~Command~~ Quantity 1''' – <code>0x01</code>, it is ignored when parsing the message.

+

'''Response Quantity 1''' – <code>0x01</code>, it is ignored when parsing the message.

−

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

+

'''Response Type''' – it is always <code>0x06</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.

+

'''Response Size''' – response 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.

+

'''Response''' – 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.

+

'''Response Quantity 2''' – a byte which defines how many records (responses) is in the packet. This byte will not be parsed but it’s recommended that it should contain same value as Response Quantity 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:''' Codec13 packets are used only when “Message Timestamp” parameter in RS232 settings is enabled.

Line 2,615: Line 2,616:

Hexadecimal stream of GPRS command in this example is given in hexadecimal form. The different fields of message are separate into different table columns for better readability and some of them are converted to ASCII values for better understanding.

−

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

+

Receiving "hello lets test" SMS response via GPRS Codec13

Hexadecimal stream:

−

+

Parsed:

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

|+

−

! colspan="2" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |~~Server Command~~

+

! colspan="2" style="border-bottom: 2px solid #0054A6; vertical-align: middle; text-align: center;" |Device answer

|-

−

! rowspan="1" style="width:50%; vertical-align: middle; text-align: center;" |~~Server Command Part~~

+

! rowspan="1" style="width:50%; vertical-align: middle; text-align: center;" |Device answer part

! rowspan="1" style="width:50%; vertical-align: middle; text-align: center;" |HEX Code Part

|-

Line 2,630: Line 2,631:

|-

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

−

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

+

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

|-

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

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

|-

−

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

+

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

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

|-

−

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

+

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

−

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

+

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

|-

−

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

+

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

−

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

+

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

|-

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

−

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

+

| style="vertical-align: middle; text-align: center;" |64 E8 32 81

|-

−

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

+

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

−

| style="vertical-align: middle; text-align: center;" |67 65 74 ~~69 6E 66 6F~~

+

| style="vertical-align: middle; text-align: center;" |68 65 6C 6C 6F 20 6C 65 74 73 20 74 65 73 74 0D 0A

|-

−

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

+

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

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

|-

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

−

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

+

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

|-

|}

−

Note that Server ~~Command~~ converted from HEX to ASCII means ~~''[[FMB getinfo|getinfo]]''~~

+

Note that Server Response converted from HEX to ASCII means "hello lets test"

=='''<big>Codec 14</big>'''==

Line 2,890: Line 2,891:

|-

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

−

| style="vertical-align: middle; text-align: center;" |Server - Device Communication

+

| style="vertical-align: middle; text-align: center;" |Server ⇄ Device Communication

−

| style="vertical-align: middle; text-align: center;" |One-way (Device -> Server communication)

+

| style="vertical-align: middle; text-align: center;" |One-way (Device → Server communication)

−

| style="vertical-align: middle; text-align: center;" |Server - Device Communication

+

| style="vertical-align: middle; text-align: center;" |Server ⇄ Device Communication

|-

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

Line 2,898: Line 2,899:

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

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

+

|-

+

! style="vertical-align: middle; text-align: center;" |command message type

+

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

+

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

+

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

|-

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

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

−

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

+

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

| style="vertical-align: middle; text-align: center;" |0x06 (if it is ACK) or 0x11 (if it is nACK)

|-

! rowspan="1" style="width:10%; vertical-align: middle; text-align: center;" |Command / Response size

−

| style="vertical-align: middle; text-align: center;" |~~Only~~ Command/Response

+

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

−

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

+

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

| style="vertical-align: middle; text-align: center;" |Command/Response + IMEI

|-

Einius.vienazindis

Administrators

8

edits

Changes

Codec (view source)

Revision as of 17:32, 7 May 2024