View source for ADAS Communication Protocol

__TOC__

==Server side configuration source code==
'''NOTE: This is a "test server" version, dedicated for initial functionality testing (which could also be done via cloudview platform) with 1-2 cameras. Multithreaded (and multiple device) handling on the server side is up to the client to do additional development and/or necessary optimizations and modifications, to support more than 1-2 cameras at the same server instance.'''

Optionally - platforms that already support camera integrations could be used.
 
Together with the communication protocol, this server side source code can be downloaded and implemented upon personal servers for the ease of use and configuration, please see index.js, debug.js and protocol.js which can be copied into the server. 

Server files & source code can be downloaded [https://drive.teltonika.lt/f/e2a91c1a5f714123a544/?dl=1 here]. 

Please see index.js, debug.js and protocol.js files. These files contain required support for camera downloads and they can be inserted straight into server. The folder can also be run as server and will work with file downloads, so if personal server is not available, there is always a possibility to use this default server. 

[[File:Server123.png|center]]

All that is required is an open Port on the computer and that port has to be written in run_server.bat file. Also by clicking on Readme file, you will be able to see the settings which you can enter into that run_server.bat file by right clicking the mouse button on it and choosing edit option. These settings include choices like DualCam download, ADAS file download or Auto mode, Metadata inclusion and etc.

[[File:Server edit.png|center]]

In this case, Notepad++ is chosen but you can choose any text editor in order to update the file.

==General command structure==
General communication packet structure is as in table below. It consists of CMD_ID (2 bytes), Data length of command and payload.
{| class="wikitable"
| colspan="18" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="14" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="17" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data
|-
| colspan="18" |2 bytes
| colspan="14" |2 bytes
| colspan="17" |[data length] bytes
|}

==Modified file transfer protocol==

'''Initialization packet'''
On connection, the device sends an initialization packet.
{| class="wikitable"
| colspan="15" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Header (0x0000)
| colspan="18" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Protocol ID
| colspan="10" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |IMEI
| colspan="13" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Settings
|-
| colspan="15" |2 bytes
| colspan="18" |2 bytes
| colspan="10" |8 bytes
| colspan="13" |4 bytes
|}
Protocol ID – just a reference for the protocol version that is running on device (for server cross compatibility with older versions).

Settings flag contains information on what is available for download. Structure provided:
{| class="wikitable"
| colspan="57" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Settings, 4 B
|-
| colspan="18" |Byte 3
| colspan="16" |Byte 2
| colspan="10" |Byte 1
| colspan="13" |Byte 0
|-
| colspan="2" |
| colspan="2" |
| colspan="3" |
| colspan="2" |
| colspan="3" |
| colspan="2" |
| colspan="2" |*
| colspan="2" |
| colspan="3" |
| colspan="3" |
| colspan="2" |
| colspan="2" |
|
|
| colspan="2" |
| colspan="2" |
|
| colspan="2" |
|
|
|
|
| colspan="2" |
|
| colspan="2" |
|
| colspan="3" |
|
|
| colspan="2" |
| colspan="2" |
|
|}

'''Close session command (CMD_ID 0x0000)'''
In case when device connects to the server, but server does not expect it to connect, server will respond by sending CLOSE command after which connection will be terminated. This command is also used then device connect to server for custom file sending and server finishes to send all custom files to device.
{| class="wikitable"
| colspan="20" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="13" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
|-
| colspan="20" |0x0000
| colspan="13" |0x0000
|}

==Request file path (CMD_ID 0x000C)==
First after connecting to server and seeing bit set in init packet the server should send file path request command.
{| class="wikitable"
!rowspan="1" style="width: 350px; background: #0054A6; color: white;"|Command ID
!rowspan="1" style="width: 350px; background: #0054A6; color: white;"|Data length
!rowspan="1" style="width: 350px; background: #0054A6; color: white;"|Blank field (2 bytes)
|-
|0x000C
|0x0002
|0x0000 (always same value)
|}

==File path response (CMD_ID 0x000D)==
This is a response to file path request (0x000C) command.
{| class="wikitable"
| colspan="14" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="13" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Blank field (Variable)
|-
| colspan="14" |0x000D
| colspan="11" |1-512
| colspan="13" |<file path, or \0>
|}

==File request command (CMD_ID 0x0008)==
After device is connected for file upload server initiates file transfer by sending FILE REQ command.
{| class="wikitable"
| colspan="9" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="10" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="19" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |File Identifier
|-
| colspan="9" |0x0008
| colspan="10" |2 bytes
| colspan="19" |File path has to be  requested first via 0x000C command.
|}
Device should answer with START command described above indicating size and CRC of requested file.

==Start file transfer command (CMD_ID 0x0001)==
After device received file request command from server (0x0008) device sends START command with file data (file size in bytes).
{| class="wikitable"
| colspan="12" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="12" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="12" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |File Size (4 bytes)
| colspan="17" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Blank field (2 bytes)
|-
| colspan="12" |0x0001
| colspan="12" |0x0006
| colspan="12" |0x12345678
| colspan="17" |0x0000 (always same value)
|}

==Resume file transfer command (CMD_ID 0x0002)==
In a response to the START command a RESUME command must be sent from server.
{| class="wikitable"
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="7" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="12" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Packet offset (4 bytes)
|-
| colspan="11" |0x0002
| colspan="7" |0x0004
| colspan="12" |0x00000000
|}
To begin file transfer from the start, offset should be set to 0 (4 bytes value). In case when the file transfer was interrupted, to resume file transfer, offset can be set to the desired value (1 ≤ [offset] ≤ [file packets]).

==Synchronize file transfer command (CMD_ID 0x0003)==
In a response to the RESUME command SYNC command is sent from device.
{| class="wikitable"
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="8" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="9" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |File offset (4 bytes)
|-
| colspan="11" |0x0003
| colspan="8" |0x0004
| colspan="9" |0x00000000
|}
By sending SYNC command it is ensured that next data command will contain file data starting from the specified offset.

==File data transfer command (CMD_ID 0x0004)==
After sending SYNC command file data transfer is started by sending DATA commands.
{| class="wikitable"
| colspan="9" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="14" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |File data (up to 1024  bytes)
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data CRC (2 bytes)
|-
| colspan="9" |0x0004
| colspan="11" |0x0402
| colspan="14" |...
| colspan="11" |…
|}
File data is split into 1024-byte parts, each part wrapped into DATA command and sent.

''Note: if command with a bad CRC is received, RESUME command should be sent with last valid file offset, after receiving RESUME command, server will stop sending DATA commands and continue communication from “Resume file transfer command (CMD_ID 0x0002)” step.''

''CRC polynomial expression: '''0x8408'''''

''Initial value, when calculating CRC, is previously received packet (CMD ID 0x0004) CRC value.''

==File transfer status command (CMD_ID 0x0005)==
After file transfer is completed and no more files are required from device, server should send COMPLETED command to the device (this command doesn’t work after executing repeat init command 0x0009 – in this case the server should send close session 0x0000 command mentioned before).
{| class="wikitable"
| colspan="17" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Command ID
| colspan="14" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Data length
| colspan="12" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Status (4 bytes)
|-
| colspan="17" |0x0005
| colspan="14" |0x0004
| colspan="12" |0x00000000
|}
In case of server using invalid arguments, commands or not following the file request flow, the device will send this command with Status field set to one of the few possible error codes. List of possible ones provided below.
{| class="wikitable"
| colspan="11" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Status value (hexadecimal)
| colspan="20" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Description
| colspan="22" rowspan="1" style="width: 350px; background: #0054A6; color: white;" |Notes
|-
| colspan="11" |0x00000000
| colspan="20" |File transfer process  completed
| colspan="22" |Sent from server
|-
| colspan="11" |0x00000002
| colspan="20" |Failed to close GPRS
| colspan="22" |Sent from device
|-
| colspan="11" |0x00000003
| colspan="20" |Failed to close socket
| colspan="22" |Sent from device
|-
| colspan="11" |0x00000005
| colspan="20" |Invalid response from  server to init packet
| colspan="22" |Sent from device
|-
| colspan="11" |0x00000011
| colspan="20" |This error code forces the  device to disconnect from server
| colspan="22" |Sent from device. Possible  causes:
· „MDAS-9“ special ID (1039) is not active
· The requested file is not available by camera
|}
After COMPLETED command device should disconnect from the server.

==Initialization packet repeat command (CMD_ID 0x0009)==
When sent, the initialization packet is repeated. This is used, when all of the files are downloaded and additional check is carried out for any additional files, that may have been captured during the download operation.

==File transfer visual flow==
[[File:Flow.png|center|frameless|867x867px]]
[[Category: Teltonika ADAS]]