Arknav
Arknav
Chapter 3
Page |1
< 3.1 > PROTOCOL FORMAT OVERVIEW
<Header>;<Message>;<Message>;<Message>;<Message>;
Symbol Delimiter Name Description
; semi-colon / semi-comma Delimiter among <Header> and <Message>
, comma Delimiter inside the <Header> / <Message>
Header GPS Body Message GPS Body Message GPS Body Message
Limitations:
Should be in ASCII
Heading (IMEI & Product Code) is 23 characters
One <Message Body> can’t be longer than 65 characters
One package can contain 2 messages via SMS
One package can contain 4 or more messages via TCP/UDP
Example:
351856040005407,240101;
1R,110509053244,A,2457.9141N,12126.3321E,220.0,315,10.0,00000000;
2R,110509053244,837493,,998372,,,;
1G,110509053245,A,2457.9141N,12126.3192E,3.1,35,2.0,00000001;
1G,110509053246,A,2457.9121N,12126.3415E,2.0,288,1.7,00000000;
1M,110509053247,A,2457.9118N,12126.3522E,1.0,55,2.2,00000000
Page |2
< 3.2 > PROTOCOL DEFINITION
Format:
In Detail:
<IMEI>,<Product ID>;<Message Type>,<Date & Time>,<GPS Status>,<Latitude with N/S Indicator>,<Longitude with E/W indicator>,<Speed>,<Course>,<HDOP>,<Status Code>
Example:
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,288,1.7,00000001
Page |3
<< 3.2.1 >> MESSAGE HEADER DEFINITION
Format:
<IMEI>,<Product ID>;<Message Type>,<Date & Time>,<GPS Status>,<Latitude with N/S Indicator>,<Longitude with E/W indicator>,<Speed>,<Course>,<HDOP>,<Status Code>;
Header
Example:
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,288,1.7,00000001
Sample Data Description Data Size (HEX)
351856040005407 <IMEI> 15 digits
Product ID 24
240101 <Product Code> 6 digits Version 00 ~ FF
Sub-Version 00 ~ FF
Page |4
<< 3.2.2 >> MESSAGE TYPE DEFINITION
Format:
<IMEI>,<Product ID>;<Message Type>,<Date & Time>,<GPS Status>,<Latitude with N/S Indicator>,<Longitude with E/W indicator>,<Speed>,<Course>,<HDOP>,<Status Code>;
Message Type
Syntax: Example:
#<security ID>,1; #0123456789,1;1* (Get Message Type 1 – GPS & Basic Status)
<Message Type>; #0123456789,1;2* (Get Message Type 2 – Extend Information)
<Message Type>* #0123456789,1;1;2;3;4;5* (Get Message Type 1, 2, 3, 4, 5)
Page |5
<<< 3.2.2.1 >>> MESSAGE TYPE 1: GPS & BASIC STATUS
Format:
<IMEI>,<Product ID>;<Message Type><Message Type>,<Date & Time>,<GPS Status>,<Latitude with N/S Indicator>,<Longitude with E/W indicator>,
<Speed>,<Course>,<HDOP>,<Status Code>;
Header
GPS Message Body
Example:
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,288,1.7,00000001
Sample Data Description Data Size (HEX)
351856040005407 <IMEI> 15 digits
240101 <Product Code> 6 digits
1G <Message Type 1> (with GPS clock) 2 digits
110509053245 <Date & Time> (YYMMDDhhmmss) 12 digits
A <GPS Status> (A or V) 1 digit
2457.9141N <Latitude with N/S Indicator> 9 digits
12126.3192E <Longitude with E/W Indicator> 10 digits
3.1 <Speed (knots)> 2~4 digits
288 <Course> 2~3 digits
1.7 <HDOP> (Horizontal Dilution of Precision) 2 digits
00000001 <Status Code> 8 digits
NOTE:
If GPS module is unable to establish connection with GPS satellite, GPS data will be unavailable for device. Missing data will be replaced by zero or display as null string separated by
comma ( , ) as follows:
1. Date & Time to be replaced by last know location time
2. GPS status will show as ‘ V ‘ for invalid GPS data (no connection)
3. Missing GPS data replace with ‘ 0 ‘ includes:
Latitude with N/S Indicator
Example:
Longitude with E/W Indicator 351856040005407,240101;1M,110509053245,V,0,0,,,,01000000
4. Missing GPS data display as null string includes:
Speed
Course
HDOP
Page |6
IMEI GPS Status
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1, 351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,
288,1.7,00000001 288,1.7,00000001
15 digits (all in numbers) 1 digit
Product Code A Valid GPS data
GPS Status
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1, V Invalid GPS data
.
288,1.7,00000001
Latitude with N/S Indicator
6 digits (all in HEX)
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,
Message Type 288,1.7,00000001
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1, 9 digits
288,1.7,00000001 Latitude ddMM.mmmm
2 digits N North
First Byte Description N/S Indicator
S South
1 GPS & Basic Status .
Page |7
Status Code
351856040005407,240101;1G,110509053245,A,2457.9141N,12126.3192E,3.1,288,1.7,00000010
1st 2nd 3rd 4th 5th 6th 7th & 8th
0 0 0 0 0 0 1 0
Status Code contains 8 digits for 32 events
Each digit contains 4 independent statuses (events)
Status Code Event Description:
First Code (00000010) Fourth Code (00000010)
Status Event HEX Binary Event Description Status Event HEX Binary Event Description
0 IN1 not activated 0 Backup battery power normal
Event #1 1 0001 Event #1 1 0001
1 IN1 activated 1 Backup battery power low
0 IN2 not activated 0 Disarmed
Event #2 2 0010 Event #2 2 0010
1 IN2 activated 1 Armed
0 OUT1 not activated 0 No extension board connected
Event #3 4 0100 Event #3 4 0100
1 OUT1 activated 1 Extension board connected
0 OUT2 not activated 0 G-Force sensor function normal
Event #4 8 1000 Event #4 8 1000
1 OUT2 activated 1 G-Force sensor no response
Second Code (00000010) Fifth Code (00000010)
Status Event HEX Binary Event Description Status Event HEX Binary Event Description
0 Offline Mode 0 EDR normal
Event #1 1 0001 Event #1 1 0001
1 Online Mode 1 EDR alert triggered
0 Roaming not activated 0 Speed limit alert not triggered
Event #2 2 0010 Event #2 2 0010
1 Roaming activated 1 Speed limit alert triggered
0 Schedule function not activated 0 Power input normal
Event #3 4 0100 Event #3 4 0100
1 Schedule function activated 1 Power input alert triggered
0 External power normal
Third Code (00000010) Event #4 8 1000
1 External power loss
Status Event HEX Binary Event Description
0 GPS module data output normal Sixth Code (00000010)
Event #1 1 0001
1 GPS module no data output Status Event HEX Binary Event Description
0 GPS module function normal 0 Angle base not triggered
Event #2 2 0010 Event #1 1 0001
1 Unexpected error for GPS 1 Angle base triggered
0 No GPS jamming detected 0 Distance base not triggered
Event #3 4 0100 Event #2 2 0010
1 GPS jamming detected 1 Distance base triggered
0 No data filtering
Event #3 4 0100
1 Data filtered
0 G-Force alert not triggered
Event #4 8 1000
1 G-Force alert triggered
.
Page |8
Seventh & Eighth Code (00000010) Sample:
01 GSM module no data output 3518560402847770,42005;1G,110721012427,A,2457.9091N,12126.3284E,0.0,138,
02 GSM low signal (CSQ < 10) 1.1,1309A70C
03 GSM no signal
04 GSM no network service 1st 2nd 3rd 4th 5th 6th 7th & 8th
05 GSM jamming detected 1 3 0 9 A 7 0 C
06 GPRS connection error Refer to ‘Status Code Event Chart’ and ‘Status Event Description to identify each
07 IP1 Socket connection error status code triggered.
08 IP2 Socket connection error
1. First Code: 1 (HEX)
09 IP1 Server no response
1 IN1 activated
0A IP2 Server no response
2. Second Code: 3 (HEX)
0B GSM unexpected error
1 Online mode
0C FTP connection fail
2 Roaming activated
0D Picture sending fail
3. Third Code: 0 (HEX)
20 Late message before shutdown
0 No status event
4. Fourth Code: 9 (HEX)
Status Code Event Chart:
1 Backup battery low
Status Code Status Event Trigger
8 G-Force no response
HEX DEC Binary Event #1 Event #2 Event #3 Event #4
5. Fifth Code: A (HEX)
0 0 0000 0 0 0 0
2 Over speed limit detected
1 1 0001 0 0 0 1
8 External power loss
2 2 0010 0 0 1 0
6. Sixth Code: 7 (HEX)
3 3 0011 0 0 1 1
1 Angle base triggered
4 4 0100 0 1 0 0
2 Distance base triggered
5 5 0101 0 1 0 1
4 G-Force alert triggered
6 6 0110 0 1 1 0
7. Seventh & Eighth Code: 0D (HEX)
7 7 0111 0 1 1 1
0C FTP connection fail
8 8 1000 1 0 0 0
9 9 1001 1 0 0 1
A 10 1010 1 0 1 0
B 11 1011 1 0 1 1
C 12 1100 1 1 0 0
D 13 1101 1 1 0 1
E 14 1110 1 1 1 0
F 15 1111 1 1 1 1
Page |9
<<< 3.2.2.2 >>> Message Type 2: Extend Information
Format:
<Message Type>,<Date & Time>,<Number of GPS Satellite Used>,<Altitude>,<External Power Input Reading>,<Internal Power Input Reading>,
<Odometer>,<Geo Fencing Trigger Information>;
Example:
2G,110509053244,08,132.4,013.9,04.18,100253165.3;
Sample Data Description Format Data Size (HEX)
2G <Message Type 2> (with GPS clock) -- 2 digits
110509053244 <Date & Time> YYMMDDhhmmss 12 digits
08 <Number of GPS Satellite in Use> -- 2 digits
132.4 <Altitude> meter – above sea level 5 digits
013.9 <External Power Input Reading> vehicle battery 5 digits
04.18 <Internal Power Input Reading> backup battery 5 digits
100253165.3 <Odometer> knots/second 11 digits
Format:
<Message Type>,<BCCH>,<BSIC>,<LAC>,<RAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
<Index of Cell>,<BCCH>,<BSIC>,<LAC>,<Rxlev>,<Cell ID>,<MCC>,<MNC>,
Example:
3G,684,58,3391,12,54,3162,466,97,
0,689,31,3391,33,0,466,97,
1,698,59,3391,35,3163,466,97,
2,705,29,3391,26,0,466,97,
3,708,27,3391,24,4ca6,466,97,
4,700,31,3391,20,0,466,97,
5,682,62,3391,18,0,466,9
Sample Data Description Format Data Size
3G <Message Type> -- 2 digits
0 <Index of Cell> -- 1 digit
684 <BCCH> – Broadcast Control Channel -- 3 digits
58 <BSIC> – Base Station Identification Code -- 2 digits
3391 <LAC> – Location Area Code -- 4 digits
12 <RAC> – Routing Area Code -- 1~3 digits
54 <Rxlev> – Reception Level Decimal 2 digits
3162 <Cell ID> – Cell Identifier Decimal 1~4 digits
466 <MCC> – Mobile Country Code HEX 3 digits
97 <MNC> - Mobile Network Code HEX 1~2 digits
P a g e | 11
Index of Cell
0,689,31,3391,33,0,466,97
Serving cell
0~5 index of the neighboring cell
BCCH
3G,684,58,3391,12,54,3162,466,97
BSIC
3G,684,58,3391,12,54,3162,466,97
LAC
3G,684,58,3391,12,54,3162,466,97
A decimal number else 4 digits (HEX)
RAC
3G,684,58,3391,12,54,3162,466,97
Routing area code from 0~255
Rxlev
3G,684,58,3391,12,54,3162,466,97
Decimal number
Reception level (dBm)
Cell ID
3G,684,58,3391,12,54,3162,466,97
A decimal number else 4 digits (HEX)
MCC
3G,684,58,3391,12,54,3162,466,97
Only serving cell have this information
MNC
3G,684,58,3391,12,54,3162,466,97
Only serving cell have this information
P a g e | 12
<<< 3.2.2.4 >>> MESSAGE TYPE 4: EDR DATA
To Be Defined
P a g e | 13
<<< 3.2.2.5 >>> MESSAGE TYPE 5: VERSION INFORMATION
Format:
<Message Type>,<Hardware Version>,<Firmware Version>,<GPS Hardware Version>,<GPS Firmware Version>,<GSM Hardware Version>,
<GSM Firmware Version>,<Extension Board Hardware Version>,<Extension Firmware Version>
P a g e | 14
<<< 3.2.2.6 >>> MESSAGE TYPE 6: PICTURE
Format:
<Message Type>,<Image ID>,<Total Number of Image Data Package>,<Current Number of Image Data Package>,
<Size of Current Image Data Package>,<Image Data>
To Be Defined
P a g e | 16
<<< 3.2.2.8 >>> MESSAGE TYPE 9: ONE-WIRE AND ANALOG DATA (I-BUTTON / TEMPERATURE SENSOR READING)
Format:
<Message Type>,<I-Button ID>,<Value 0>,<Value 1>,<Value 2>,<Value 3>,<Value 4>,<Value 5>,<Value 6>,<Value 7>,
<ADC 0 Reading>,<ADC 1 Reading>
Example:
9C,101C6F5501080027,-55,125,25,,,,,,03300,03300
Sample Data Description Format Data Size (HEX) Unit Support
9C <Message Type 2> (Custom Message) -- 2 digits Yes
101C6F5501080027 <I-Button ID> -- 16 digits Yes
-55 <Value 0 – Temperature Reading> HEX
125 <Value 1 – Temperature Reading> HEX 4 digits Degree Celsius
Yes
25 <Value 2 – Temperature Reading> HEX (-125 ~ 125) ( °C )
NULL String <Value 3~7 – Temperature Reading> HEX
03300 <ADC 0 Reading> -- 5 digits mA NO
03300 <ADC 1 Reading> -- 5 digits mA NO
I-Button ID
101C6F5501080027,-55,125,25,,,,,,03300,03300
16 digits Temperature Conversion Tutorial:
Numbers from 0 ~ 9; characters from A ~ F
Value 0 ~ Value 7 101C6F5501080027,-55,125,25,,,,,,03300,03300
101C6F5501080027,-55,125,25,,,,,,03300,03300
Temperature reading value of DS18S20 Digital Temperature Sensor Step 1 : Convert temperature reading from HEX to DEC
Supports up to 8 DS18S20 digital temperature sensor at the same time 55 (HEX) = 85 (DEC)
4 digits (range from -125 ~ 125 in °C) Step 2 : Temperature reading in DEC value divide by 2
Positive & Negative ‘ – ‘ reading (negative sign as 1 digit) 85 (DEC) / 2 = 42.5
ADC 0 ~ ADC 1 Reading (Not Supported by X-8 series models) Step 3 : Add negative sign ‘ – ‘ if original reading shows negative with unit in
101C6F5501080027,-55,125,25,,,,,,03300,03300 degrees Celsius
42.5 -42.5°C
5 digits
Hardware may support range from 0~3.3V or 0~24V of analog input
P a g e | 17
<<< 3.2.2.9 >>> MESSAGE TYPE A: REPLY TO COMMAND TYPE 2
Format:
<Message Type>,<Date & Time of Command Received>,<Output Number>,<Time Interval>
Message Body
P a g e | 18
<<< 3.2.2.10 >>> MESSAGE TYPE B: REPLY TO COMMAND TYPE 3 AND 4
Format:
<Message Type>,<Date & Time of Command Received>,<Memory Location>,<Value>
Message Body
P a g e | 19
<<< 3.2.2.11 >>> MESSAGE TYPE C: REPLY TO COMMAND TYPE 5
Format:
<Message Type>,<Date & Time of Command Received>,<Command ID>
Message Body
P a g e | 20
<<< 3.2.2.12 >>> MESSAGE TYPE 0: ERROR MESSAGE
Format:
<Message Type>,<Date & Time of Command Received>,<Error ID>,<Counter>
Message Body
P a g e | 21
< 3.3 > COMMAND MESSAGE
Format:
#<Security ID>,<Command Type>;<Instruction>,<Value>;<Instruction>,<Value>*
Limitation:
Should be in ASCII
Can’t be longer than 65 characters per message
Contains 2 messages via SMS in one package
Contains 4 or more messages via TCP/UDP in one package
Example:
Command Message Command Description
#,1;2* Get current message type 1 and 2 (Location and Extended Information)
#,2;01,03* Output activation
#0123456789,3;0001,1234;0002,$250;0003,$0060* Configuration message with security code
#,3;0001,1234;0002, 0002,$250;0003,$0060* Configuration message without security code
#,4;0001,$0001*
Get configuration value
#,4;0230;0011*
P a g e | 22
<< 3.3.1 >> COMMAND HEADER DEFINITION
Format:
#<Security ID (for Command Type 3 Only with delimiter ‘ , ‘)>,<Command Type>;<Instruction>,<Value>;<Instruction>,<Value>*
Header
Header Definition:
Header Body Description ASCII
<Security ID> Security code to upload/download configuration settings Must be 10 digits
1 Current Status
2 Output Activation
<Command Type> 3 Set Configuration 1~5
4 Get Configuration
5 Other Command
P a g e | 23
<<< 3.3.1.1 >>> COMMAND TYPE 1: CURRENT STATUS
Format:
#,<Command Type>;<Information ID>*
Command Body
Information ID Definition:
Command Body Parameter Description
1 GPS & Basic Status
2 Extend Information
<Command ID>
3 Cell ID Data
4 EDR Data
Example:
P a g e | 24
<<< 3.3.1.2 >>> COMMAND TYPE 2: OUTPUT ACTIVATION
Format:
#,<Command Type>,<Output Number>,<Time Interval>*
Command Body
Example:
Command Message Command Description
#,2,01,03* Activate output 1 for 3 seconds
#,2,02,FF* Activate output 2 permanently until reset
#,2,01,03;02,0* Activate output 1 for 3 seconds and de-activate output 2
P a g e | 25
<<< 3.3.1.3 >>> COMMAND TYPE 3: SET CONFIGURATION
Format:
#,<Command Type>;<Memory Location>,<Value>*
Command Body
Description:
Case Scenario Command Result
To store integer value ‘250’ at the beginning of memory location
#,3;0001,$00FA* Actual integer value of ‘250’ will be store at memory location ‘0001’
‘0001’
To store integer value ‘9578’ at the beginning of memory location
#,3;0010,$256A* Actual integer value of ‘9578’ will be store at memory location ‘0010’
‘0010’
To store ASCII value ‘arknav’ at the beginning of memory location
#,3;0003,arknav* Actual ASCII value of ‘arknav’ will be store at memory location ‘0003’
‘0003’
NOTE:
For multiple configuration, the memory location need to be in order from small to large
Example:
#,3;0001,1234;0002,abcd;0003,xyz*
If the memory location is not in order, the command may not be processed
Store illegal value for the field may cause unit to crash and only can be recovered by retrieving the unit
For numeric fields, the number must convert to HEX value
For control bit fields, need to convert the control bit to a HEX value and use ASCII to represent a HEX value
P a g e | 26
<<< 3.3.1.4 >>> COMMAND TYPE 4: GET CONFIGURATION
Format:
#,<Command Type>;<Memory Location>,<Value>*
Command Body
Description:
Case Scenario Command Result
To get 1 integer value at the beginning of memory location ‘0001’ #,4;0001,$0001* Get 1 integer value at memory location ‘0001’
To get 11 ASCII value at the beginning of memory location ‘0230’ #,4;0230,0011* Get 11 ASCII value at memory location ‘0230’
P a g e | 27
<<< 3.3.1.5 >>> COMMAND TYPE 5: OTHER COMMAND
Format:
#,<Command Type>,<Command ID>*
Command Body
Command ID Definition:
Command Body Parameter Description
01 Reset unit
02 Back to default setting
03 Firmware OTA
<Command ID> 04 Download configuration from FTP
05 Upload current configuration to FTP
06 Clean up all messages saved in flash
09 Request Google Map Hyperlink
Example:
Command Message Command Description
#,5,01* Reset unit
#,5,04* Download configuration from FTP
P a g e | 28
X8 SERIES
Command Setting
Appendix
Chapter 4
P a g e | 29
< 4.1 > CONTROL CENTER SETTING - I
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Setup the control station number
+ Sign / Digits Example:
0008 Phone Number 1 #,3;0008,<Phone Number 1>*
(16 digits with +)
16
#0123456789,3;0008,+11335577*
Set phone number 1 to ‘+11335577’ with security code if
required
Phone Number 1 Control Byte
Binary Description
00000000 0 Master
00000001 1 Slave
00000000 0 Receive SMS message (Disable)
00000010 1 Receive SMS message (Enable)
00000000 0 Send SMS message (Disable)
Phone Number 1 #,3;0026,$<PH 1 Control $0000~$001F
0026 Control Byte Byte>* (HEX)
1 00000100 1 Send SMS message (Enable)
00000000 0 Receive phone call (Disable)
00001000 1 Receive phone call (Enable)
00000000 0 Voice call out (Disable)
00010000 1 Voice call out (Enable)
Example:
#,3;0026,$0004*
Enable send SMS command to phone number 1
Description:
Configure IP or domain address for tracking server
NOTE:
After update, X8 SERIES will restart (reset)
ASCII String
0103 Server IP/Domain #,3;0103,<Server IP/Domain>*
(63 characters)
63 Will disconnect from current GPRS session
Example:
#,3;0103,track.arknavgps.com.tw*
Configure tracking server domain with
track.arknavgps.com.tw
P a g e | 30
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure tracking server port
NOTE:
Digits After update, X8 SERIES will restart (reset)
0167 Server Port #,3;0167,<Server Port>* (5 Digits)
(0 ~ 65535)
5 Will disconnect from current GPRS session
Example:
#0123456789,3;0167,6080*
Configure tracking server port to ‘6080’ with security
code if required
Gateway Control Byte
Binary Description
00000000 0 Master
00000001 1 Slave
00000000 0 Receive command (Disable)
#,3;0173,$<Gateway Control $0000~$0007 00000010 1 Receive command (Enable)
0173 Gateway Control Byte
Byte>* (HEX)
1
00000000 0 Send command (Disable)
00000100 1 Send command (Enable)
Example:
#,3;0173,$0004*
Receive command enabled
Send command enabled
P a g e | 31
< 4.2 > CONTROL CENTER SETTING - II
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure FTP server’s IP address
#,3;0256,<FTP Server ASCII String
0256 FTP Server IP/Domain
IP/Domain>* (63 characters)
63 Example:
#,3; 0256,ftp.arknavgps.com.tw*
Configure FTP IP to ftp.arknavgps.com.tw
Description:
Configure FTP server’s user name for login
ASCII String
0320 FTP User Name #,3;0320,<FTP User Name>*
(6 characters)
6 Example:
#,3;0320,rx8*
Configure FTP user name with ‘rx8’
Description:
Configure FTP server’s password for login
ASCII String
0327 FTP Password #,3;0327,<FTP Password>*
(6 characters)
6 Example:
#,3;0327,rx-8*
Configure FTP login password to ‘rx-8’
Description:
Digits Configure FTP server’s port number
0334 FTP Port #,3;0334,<FTP Port>* (5 Digits)
(0 ~ 65535)
5 Example:
#,3;0334,21*
Configure FTP port to 21
Description:
Configure FTP directory for firmware/configuration over the
air
NOTE:
FTP Directory & File #,3;0340,<FTP Directory & File ASCII String Make sure to configure the complete folder path and file
0340 Name Name>* (72 characters)
72
name with extension for correct download process.
Example:
#,3;0340,/rx8update/rx8.ark*
Configure FTP path/directory and file name with correct
extension to ‘/rx8update/rx8.ark’ for download
P a g e | 32
< 4.3 > GSM NETWORK SETTINGS
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
GSM Frequency Band Control Byte
HEX Description
$000F Auto select band
$0001 GSM Band 850 only
$0002 GSM Band 1900 only
$0003 GSM Band 850/1900
$0004 GSM Band 900 only
#,3;0426,$<GSM Frequency $0000~$000F
0426 GSM Frequency Band
Band>* (HEX)
1 $0008 GSM Band 1800 only
$000C GSM Band 900/1800
NOTE:
After update, X8 SERIES will restart (reset)
Will disconnect from current GPRS session
Example:
#,3;0426,$000C*
Configure GSM frequency band to 900/1800
P a g e | 33
Command Command
Limitation
Function Topic Syntax Format Function Topic Parameter Description
Syntax Format
Code Code max)
(bytes
GSM Control Byte - First Byte:
Binary Description
00000000 0 SMS (Disable)
00000001 1 SMS (Enable) ASCII String
0461 APN User Name
00000000 0 #,3;0461,<APN
GPRS (Disable) User Name>*
(15 characters)
00000010 1 GPRS (Enable)
00000000 0 UDP protocol
00000100 1 TCP protocol
00000000 0 Disallow Roaming
00001000 1 Allow Roaming
00000000 0 Roaming Partner Control (Disable)
00010000 1 Roaming Partner Control (Enable)
ASCII String
0477 00000000
APN Password
00100000
0
1
Heart Beat IntervalPassword>*
#,3;0477,<APN (Disable)
Heart Beat Interval (Enable) (15 characters)
$0000~$017F
0427 GSM Control Byte #,3;0427,<GSM Control Byte>*
(HEX)
2 00000000
01000000
0
1
Custom ACK (Disable)
Custom ACK (Enable)
GSM Control Byte - Second Byte:
Binary Description
00000000 0 SIM PIN (Disable)
00000001 1 SIM PIN (Enable)
NOTE: Digits
0493 SIM PIN #,3;0493,<SIM PIN>*
After update, X8 SERIES will restart (reset) (4 digits)
Will disconnect from current GPRS session
Example:
#,3;0427,$0106*
Enable GPRS
UDP protocol
Allow Roaming
Enable SIM card PIN code
Description:
HeartAccess Point Name for
Beat Interval GPRS data
#,3;0498,<Heart Beat $0001~$00FE
0498 (sec)NOTE: Interval>* (HEX)
ASCII String After update, X8 SERIES will restart (reset)
0429 GPRS APN #,3;0429,<GPRS APN>* (31 characters)
(Case Sensitive)
31
Will disconnect from current GPRS session
Example:
#,3;0429,internet*
Configure ‘internet’ as APN for GPRS
P a g e | 34
Command Command
Limitation
Function Topic Syntax Format Function Topic Parameter Description
Syntax Format
Code Code max)
(bytes
Description:
Configure speaker volume
NOTE:
#,3;0499,<Speaker Level $0000~$00FE 0 (DEC) = $0000 (HEX) -- (Disable speaker)
0499 Speaker Level Control
Control>* (HEX)
1
254 (DEC) = $00FE (HEX) -- (max volume)
Example:
#,3;0499,$0096*
Configure
ONLINE Power Savingspeaker volume to 150Power
#,3;0504,<ONLINE (max 254) $0000~$0003
0504 Control
Description: Saving Control>* (HEX)
Configure speaker volume
NOTE:
Microphone #,3;0500,<Microphone $0000~$00FE $0 (DEC) = $0000 (HEX) -- (Disable microphone)
0500 Sensitivity Control Sensitivity Control>* (HEX)
1
254 (DEC) = $00FE (HEX) -- (max microphone sensitivity)
Example:
#,3;0500,$0064*
Configure microphone sensitivity to 100 (max 254)
Description:
Enable to allow X8 SERIES to wait for server for server to
response when data #,3;0512,<Roaming Partner
is confirmed receive. Digits
0512 Roaming Partner #1
This function will #1>*
prevent incomplete message to be send (6 digits)
out.
NOTE:
Value from 0~255 (DEC) – MUST convert to HEX
value
With ‘Custom #,3;0519,<Roaming Partner the minimum
ACK’ function enabled, Digits
0503 Custom ACK Timeout #,3;0503,<Custom ACK $0002~$00FE 0519 1
Roaming Partner #2
#2>* interval is 3 seconds.
online tracking (6 digits)
(sec) Timeout>* (HEX)
Cannot be 0
Min 2 seconds (DEC) = $0002 (HEX)
Max 254 seconds (DEC) = $00FE (HEX)
Minimum sending interval >= Custom ACK timeout +
1 second #,3;0529,<Roaming Partner Digits
0526 Roaming Partner #3
Example: #3>* (6 digits)
#,3;0503,$001E*
Configure ‘Custom ACK’ timeout with 30 seconds;
Sending interval will be >= 31 seconds
P a g e | 35
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure GSM roaming partner priority #4
#,3;0533,<Roaming Partner Digits Example:
0533 Roaming Partner #4
#4>* (6 digits)
6
#,3;0533,50571*
Configure “Telstra” in Australia region as roaming
partner priority #4.
Description:
Configure GSM roaming partner priority #5
#,3;0540,<Roaming Partner Digits Example:
0540 Roaming Partner #5
#5>* (6 digits)
6
#,3;0540,23410*
Configure “O2” in UAE region as roaming partner priority
#5.
P a g e | 36
< 4.4 > WORKING MODE AND SENDING MODE SETTINGS
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Offline Mode Control Byte
Binary Description
00000000 0 Disable GSM module in Offline mode
00000001 1 Enable GSM module in Offline mode
00000000 0 Disable GPS module in Offline mode
00000010 1 Enable GPS module in Offline mode
00000000 0 MCU enters IDLE mode
00000100 1 MCU remains ON
Disable GPS to wake up from Offline mode
00000000 0
when IN2 is activated
Enable GPS to wake up from Offline mode
00001000 1
when IN2 is activated
Disable wake up from Offline mode when
00000000 0
motion is activated
Offline Mode Control #,3;0547,<Offline Mode $0000~$003F Enable wake up from Offline mode when
00010000 1
0547 Byte Control>* (HEX)
1 motion is activated
Disable wake up from Offline mode base on
00000000 0
scheduled time
Enable wake up from Offline mode base on
00100000 1
scheduled time
NOTE:
Wake up from Offline mode when IN2 is activated MUST
appoint to a specific Input
Wake up from Offline mode base on scheduled time
MUST configure ‘Time Schedule’
Example:
#,3;0547,$0013*
Enable GSM module in Offline mode
Enable GPS module in Offline mode
Enable wake up from Offline mode when motion is
activated
P a g e | 37
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Select activation level for G-Force detection to trigger event
NOTE:
Value from 0~255 (DEC) – MUST convert to HEX value
#,3;0548,<Motion Trigger $0001~$00FF 1 (DEC) = $0001 (HEX) = 0.0625G (most sensitive)
0548 Motion Trigger Level
Level>* (HEX)
1
255 (DEC) = $00FF (HEX) = 16G (least sensitive)
Example:
#,3;0548,$0064*
Configure ‘Motion Trigger Level’ to 100 (6.25G) G-Force
sensitivity
Description:
Configure ‘Real Time’ TRACKING sending interval while in
Home network
NOTE:
Parameter unit in second (sec)
0 = Stop sending
Max 65534 seconds
With ‘Custom ACK’ = Disable, minimum 1 seconds
With ‘Custom ACK’ = Enable, minimum 3 seconds
TRACKING Time #,3;0553,<TRACKING Time $0000~$FFFE
0553 Interval (HOME) (sec) Interval (HOME)>* (HEX)
2 When ‘Switch OFF GSM Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
When ‘Switch OFF GPS Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
Example:
#,3;0553,$012C*
Configure ‘TRACKING Time Interval (HOME)’ to track
every 300 seconds = 5 minutes while in Home network
P a g e | 38
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure ‘IDLE Mode’ sending interval while in Home
network
NOTE:
0 = Stop sending
Max 65534 minute
When ‘Switch OFF GSM Module in ‘TRACKING Mode’ =
IDLE Time Interval #,3;0555,<IDLE Time Interval $0000~$FFFE Enable, minimum TRACKING time Interval in Home
0555 (HOME) (min) (HOME)>* (HEX)
2
network will be 5 min
When ‘Switch OFF GPS Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
Example:
#,3;0555,$012C*
Configure ‘IDLE Time Interval (HOME)’ to track every 12
minutes while in Home network
Description:
Configure ‘Real Time’ TRACKING sending interval while in
Roaming network
NOTE:
Parameter unit in second (sec)
0 = Stop sending
Max 65534 seconds
With ‘Custom ACK’ = Disable, minimum 1 seconds
With ‘Custom ACK’ = Enable, minimum 3 seconds
ONLINE Time Interval #,3;0559,<ONLINE Time $0000~$FFFE
0559 (ROAMING) (sec) Interval (ROAMING)>* (HEX)
2 When ‘Switch OFF GSM Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
When ‘Switch OFF GPS Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
Example:
#,3,0559,$0E10*
Configure ‘TRACKING Time Interval (ROAMING)’ to track
every 3600 seconds = 1 hour while in Roaming network
P a g e | 39
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure ‘IDLE Mode’ sending interval while in Roaming
network
NOTE:
Parameter unit in minute (min)
0 = Stop sending
Max 65534 minute
When ‘Switch OFF GSM Module in ‘TRACKING Mode’ =
OFFLINE Time Interval #,3;0561,<OFFLINE Time $0000~$FFFE
0561 (ROAMING) (min) Interval (ROAMING)>* (HEX)
2 Enable, minimum TRACKING time Interval in Home
network will be 5 min
When ‘Switch OFF GPS Module in ‘TRACKING Mode’ =
Enable, minimum TRACKING time Interval in Home
network will be 5 min
Example:
#,3;0561,$0012*
Configure ‘IDLE Time Interval (ROAMING)’ to track every
12 minutes while in Roaming network
Description:
Configure parameter in degree for ‘Angle Base’ tracking
interval
NOTE:
Angle Change #,3;0565,<Angle Change $0001~$00B4 1 (min) ~ 180 (max) degrees
0565 Threshold (degree) Threshold>* (HEX)
1
While using Angle Tracking, ‘ONLINE Power Saving’
modes can NOT be enabled
Example:
#,3;0565,$002D*
Configure to track with a 45 degrees change in direction
P a g e | 40
Command < 4.5Limitation
> INPUT SETTINGS
Function Topic Syntax Format Parameter Description
Code (bytes max)
Command Description:
Function Topicparameter in meterSyntax
Configure Format
for ‘Distance Base’ tracking
Code
interval
NOTE:
Parameter unit in meter (m)
Distance Threshold #,3;0566,<Distance $0001~$FFFE
0566 (meter) Threshold>* (HEX)
2 1 (min) ~ 65534 (max) meter
While using Distance Tracking, ‘ONLINE Power Saving’
Input 1 Trigger Delay #,3;0569,<Input 1 Trigger $0000~$00FE
0569 Time (ms)
modes can NOT be enabled
Delay Time>* (HEX)
Example:
#,3;0566,$0036*
Configure to track every 54 meters in distance
Sending Mode Control Byte
Binary Description
00000000 0 Disable ‘Time’ based tracking
Input00000001
1 Custom 1 Enable ‘Time’ based1tracking
#,3;0885,<Input Custom ASCII String
0885 00000000
Message 0 Disable ‘Distance’ based tracking
Message>* (19 characters)
00000010 1 Enable ‘Distance’ based tracking
00000000 0 Disable ‘Angle’ based tracking
00000100 1 Enable ‘Angle’ based tracking
00000000 0 Disable ‘Resend Missed Locations at HOME’
00001000 1 Enable ‘Resend Missed Locations at HOME’
00000000 0 Disable ‘Resend Missed Locations while Roaming’
$0001~$00FF
0568 Sending Method #,3;0568,<Sending Method>*
(HEX) 0574
1 Input00010000 1 Enable
2 Trigger Delay ‘Resend Missed
#,3;0574,<Input Locations while Roaming’
2 Trigger $0000~$00FE
Time00000000
(ms) 0 Disable
Delay Time>*
‘Send (HEX)
Cell ID when GPS is not Available’
00100000 1 Enable ‘Send Cell ID when GPS is not Available’
00000000 0 Disable ‘Cell ID’ messages to be resend
01000000 1 Enable ‘Cell ID’ messages to be resend
00000000 0 Disable ‘Logging Data’
10000000 1 Enable ‘Logging Data’
Example:
#,3,0568,$0019*
Enable ‘Time’ based tracking
Enable ‘Resend Missed Locations at HOME’
Enable ‘Resend Missed Locations while ROMAING’
P a g e | 41
< 4.6 > OUTPUT SETTINGS Command
Function Topic Syntax Format
Code
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure Output 1 triggered event activation time/duration
NOTE:
Parameter unit in millisecond (ms)
Can NOT be 0
Output 1 Activation #,3;0579,<Output 1 Activation $0001~$00FE
0579 Time (ms) Time>* (HEX)
1 Max 254 ms = 25.4 sec
#,3;0582,<Output 1 Controlwith “Control
$0000~$0005
0582 Output 1Control
OutputByte
1 activation time MUST collocate
Byte>*
Byte = 1 Time Trigger” (HEX)
Example:
#,3;0579,$000C*
Configure Output 1 activate duration with 12ms = 1.2sec
Description:
Configure Output 1 activation time/duration
NOTE:
Parameter unit in millisecond (ms)
Can NOT be 0
Output 1 Duty Cycle #,3;0580,<Output 1 Duty Cycle $0001~$00FE
0580 ON Time (ms) ON Time>* (HEX)
1 Max 254 ms = 25.4 sec
Output 1 activation time MUST collocate with “Control
Byte = Duty Cycle”
Example:
Output 2#,3;0580,$0032*
Activation #,3;0583,<Output 2 Activation $0001~$00FE
0583 Configure Output
Time (ms) 1 activate duration with 50ms = 5sec
Time>* (HEX)
Description:
Configure Output 1 de-activation time/duration
NOTE:
Parameter unit in millisecond (ms)
Can NOT be 0
Output 1 Duty Cycle #,3;0581,<Output 1 Duty Cycle $0001~$00FE
0581 OFF Time (ms) OFF Time>* (HEX)
1 Max 254 ms = 25.4 sec
Output 1 de-activation time MUST collocate with
“Control Byte = Duty Cycle”
Example:
#,3;0581,$0014*
Configure Output 1 de-activate duration with 20ms = 2s
P a g e | 42
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure Output 2 activation time/duration
NOTE:
Parameter unit in millisecond (ms)
Can NOT be 0
Output 2 Duty Cycle #,3;0584,<Output 2 Duty Cycle $0001~$00FE
0584 ON Time (ms) ON Time>* (HEX)
1 Max 254 ms = 25.4 sec
Output 2 activation time MUST collocate with “Control
Byte = Duty Cycle”
Example:
#,3;0584,$0032*
Configure Output 2 activate duration with 50ms = 5sec
Description:
Configure Output 2 de-activation time/duration
NOTE:
Parameter unit in millisecond (ms)
Can NOT be 0
Output 2 Duty Cycle #,3;0585,<Output 2 Duty Cycle $0001~$00FE
0585 OFF Time (ms) OFF Time>* (HEX)
1 Max 254 ms = 25.4 sec
Output 2 de-activation time MUST collocate with
“Control Byte = Duty Cycle”
Example:
#,3;0585,$0014*
Configure Output 2 de-activate duration with 20ms = 2s
P a g e | 43
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure Output 2 Control Byte for output patterns of
behavior
Output 2 Control Byte
HEX Description
0000 Disable
One Time Trigger
0001 time interval follow input activate time
#,3;0586,<Output 2 Control $0000~$0005 reset when triggered event resets
0586 Output 2 Control Byte
Byte>* (HEX)
1
0002 Duty Cycle
0003 Follow Event
0004 Always on until ‘Reset’ command is received
Reverse Follow Event Trigger
0005 Event not trigger ON
Event trigger OFF
Example:
#,3;0586,$0002*
Configure triggered output 2 to follow ‘Duty Cycle’
P a g e | 44
< 4.7 > EVENT SETTINGS
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure speed limit threshold
NOTE:
Parameter unit in knot
$0001~$FFFF Can NOT be 0
0588 Speed Limit (knot) #,3;0588,<Speed Limit>*
(HEX)
2
Max 65536 knot = approx. 121372.671 km/h
(1 knot = 1.852 km/h)
Example:
#,3;0588,$0040*
Configure speed limit threshold with 64 knot = 119 km/h
Description:
Configure speed trigger related output
Speed Trigger Related Output – First Byte
Binary Description
00000001 Output 1
00000010 Output 2
Speed Trigger Related Output – Second Byte
Binary Description
00000001 Custom message 1 - Reserved
Speed Trigger Related #,3;0592,<Speed Trigger $0000~$03FF 00000010 Custom message 2 - Reserved
0592 Output Related Output>* (HEX)
2
00000100 Custom message 3 - Reserved
00001000 Custom message 4 - Reserved
00010000 Custom message 5 - Reserved
00100000 Custom message 6 - Reserved
01000000 Custom message 7 - Reserved
10000000 Custom message 8 - Reserved
Example:
#,3;0592,$0100*
Configure device to trigger output 1 when reached speed
limit threshold
P a g e | 45
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Speed Control Byte
Binary Description
Event Send immediately then
00000010 10 Priority Level 2 follow by real time tracking
Level interval
#,3;0594,<Speed Control $0002~$0012
0594 Speed Control Byte
Byte>* (HEX)
1 00000010
00010010
0
1
Disable speed control
Enable speed control
Example:
#,3;0594,$0012*
Enable Speed Control
Event Priority Level – Send immediately then follow by real
time tracking interval
Description:
Configure G-Force threshold level
G-Force Threshold Value
DEC HEX Description
0 0000 Disable
1 0001 Most Sensitive
G-Force Threshold #,3;0635,<G-Force Threshold $0000~$00FE
0635 Level Level>* (HEX)
1 2~253 0002~00FD G-Force threshold value
254 00FE Least Sensitive
NOTE:
Must convert into G value
Example:
#,3;0635,$0096*
Configure G-Force threshold level to 150
P a g e | 46
Command Limitation
Function Topic Syntax Format Parameter Description
Code (bytes max)
Description:
Configure G-Force trigger related output
G-Force Trigger Related Output – First Byte
Binary Description
00000001 Output 1
00000010 Output 2
G-Force Trigger Related Output – Second Byte
Binary Description
00000001 Custom message 1 - Reserved
G-Force Trigger #,3;0641,<G-Force Trigger $0000~$03FF 00000010 Custom message 2 - Reserved
0641 Related Output Related Output>* (HEX)
2
00000100 Custom message 3 - Reserved
00001000 Custom message 4 - Reserved
00010000 Custom message 5 - Reserved
00100000 Custom message 6 - Reserved
01000000 Custom message 7 - Reserved
10000000 Custom message 8 - Reserved
Example:
#,3;0641,$0100*
Configure device to trigger output 1 when reached
G-Force threshold level
G-Force Control Byte
HEX Description
0001 Disable G-Force control
#,3;0643,<G-Force Control $0001/$0003 Enable G-Force control
0003
0643 G-Force Control Byte
Byte>* (HEX)
1 (Send only one message immediately)
Example:
#,3;0643,$0003*
Enable G- Control
Event Priority Level – Send only one message immediately
P a g e | 47