Clarinet-XT4860 ProtocolDocument 2.0J PDF

Document Information
Title
Communication Specification and Data Format
Document number
Revision 2.0J
Device
XT4860G | XT4860CV | XT4860CS
Platforms
1156DA3
Versions
Released
2/19/2016
Confidential- Covered Under NDA
New Features in 1156CA3
CDMA module supported.
Support for sSHDN5 (Ship Mode w/ State Save)
Geofence Filesystem support.
Aux port pass-through module and supporting commands
New Features in 1156CA8

New Features in 1156CC1
New Features in 1156DA1
Issues Addressed in 1156CA1
Fixed GPS Time & Coordinate restore.

Fixed Solar Charge current value (SCC).
Fixed DNS Cache TTL. TTL value was not being applied.
Fixed 5421 not saved to profile.

Fixed profile corruption with Dynamic Message Formatting.
Fixed initial setup of UDP socket

Added TXCMPL response on AUX UART when message delivered upstream

Issues Addressed in 1156DA3
Device Message Formats

X8z1
X8z2
Y8z3
$$<UID>,<EV#>,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<CQ>,<MI>,<GS>,<EA>,<BB>,<PM>,<AX>,<AY>,<A
Z>[,<SEQ>]##
Z>,<ID> [,<SEQ>]##
4005
Main battery disconnected periodic reporting
6002
Speed threshold alert
6001
Direction change alert
6005
Mileage threshold exceeded alert
6009
Main battery disconnect alert
6010
Main batter reconnect alert
6016
Idle threshold alert
6017
Towing detected alert
6018
Towing stopped alert
6019
Input2 high alert
6020
Input2 low alert
6027
Shutdown Pending Allert
6030
Moving detected
6031
Moving stopped
6032
Park time threshold alert
6035
Accelerometer threshold alert
6048
External ADC low threshold alert
6049
External ADC high threshold alert
6070
Software reset
6071
Motion start wake alert
6072
Motion stop wake alert
6073
Periodic wake alert
6074
Periodic wake alert while in motion
6075
Periodic wake alert while not in motion
6076
DC power-up wake alert
6077
Above Inclinometer threshold
6078
Below Inclinometer threshold
6079
6085
Input1 high wake alert
X8z1
X8z2
Y8z3
Inclinometer delta alert
6077, 6078 & 6085 are only valid on X8z2 FW.
Z>[,<SEQ>]##
Z>,<ID>,<EH>,<IH>,<UT> [,<SEQ>]##
4001
Wired ignition on periodic time based reporting
4003
Virtual ignition on periodic time based reporting
4002
4004
Wired ignition off periodic time based reporting
Virtual ignition off periodic time based reporting
6011
Wired ignition on alert
6013
Virtual ignition on alert
6012
6014
X8z1
X8z2
Y8z3
Wired ignition off alert
Virtual ignition off alert
$$<UID>,<EV#>,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<CQ>,<MI>,<GS>,<EA>,<BB>,<PM>,<XY>,<AX>,<A
Y>,<AZ>[,<SEQ>]##
$$<UID>,<EV#>,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<CQ>,<MI>,<GS>,<EA>,<BB>,<PM>,<XY>,<AX>,<A
Y>,<AZ>,<ID> [,<SEQ>]##
6004
Geofence crossing alert
X8z1
$$<UID>,<EV#>,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<CQ>,<MI>,<GS>,<EA>,<BB>,<PM>,<FW>,<PF>,<
AX>,<AY>,<AZ>[,<SEQ>]##
X8z2
Y8z3
4006
6015
$$<UID>,<EV#>,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<CQ>,<MI>,<GS>,<EA>,<BB>,<PM>,<FW>,<PF>,<
AX>,<AY>,<AZ>,<ID> [,<SEQ>]##
Periodic reporting while device powered (heartbeat)

Alert message on power-up/reset and GPS lock
$$<UID>,<EV#>,<GSM>,<GPR>,<PDP>,<HOFF>,<HO>,<PU>,<R>,<%GPS>,<%GPSQ>,<%GSM>,<%GPR>,<%PDP>,<LV>,<HV>,<CX>,<DB
O>,<ABI>,<DBI>,<SO>,<SI>,<SS>,<SCC>[,<SEQ>]##
4050
Diagnostic data (reference 7050 command for field definitions)
X8z2
Y8z3
Z>,<ID>,<ST>,<SC>[,<SEQ>]##
6084
Sensor Alert
Y8z3
$$<UID>,<EV#>,<CI>,<LA>,<CNT>,<BDx>##
6033
Upstream payload bridged from AUX UART
6034
AUX pass-through status/error message
Aux UART Acknowledgement Format

Y8z3
Device response message format over AUX UART acknowledging receipt of message and completion of upstream
transmission.
$$<UID>,<EV#>,<CNT>,<APTack>
6033
UART message received
Y8z3
$$<UID>,<EV#>,<CNT>,<EV#>,TXCMPL
6034
Asynchronous ACK when an event has been delivered upstream. Note: Final EV# token is code of message transmitted.
Syntax Field Definitions

Parameter
Type/Format
Description
EV#
4 digits
Event Code
UID
CI
LA
CNT
BDx
D
T
LT
LN
AL
SP
HD
SV
HP
BV
CQ
MI
GS
15 digits
String
String
Numeric
String
YYYY/MM/DD
HH:MM:SS
-90.00000 90.00000
-180.00000 180.00000
-90.00000 90.00000
-180.00000 180.00000
Numeric
Numeric
Numeric
Numeric
One Decimal Resolution

Numeric
EA
PM
Numeric
BB
Unit ID (Serial Number/Device MEID)

2-4 byte Cell ID in hexadecimal format
Location Area Code in hexadecimal format

Count of records currently stored in NVM
Data received from peripheral (e.g. UART)

UTC Date
UTC Time
Latitude
Longitude
Altitude (meters)
Speed (mph)
Heading (degrees)
Number of satellites used for position fix

HDOP (Horizontal dilution of precision)
Battery Voltage
Cellular receive signal strength
Miles driven since last reset or power-cycle

GPS status
0: Not Locked
1: Locked
2: Communications Failure
3: GPS Off (Power Saving)

External ADC voltage
Backup battery voltage
Last power-up/reset mode
1: Software Reset
2: DC Power On
3: Motion Sense
4: Interval Wakeup
6: No Motion Sense
7: Periodic Motion
XY
Numeric
FW
String
Ex: X8z1-1156BB1
PF
AX
AZ
ID
EH
UT
ST
Geofence violation
X: Geofence ID
Y=1: Outside Fence Violation
Y=0: Inside Fence Violation

Firmware Version
Profile Name
Numeric
(1/1000 g-unit)
Accelerometer Y-force
Numeric
Inclinometer Angle Degrees
Numeric
Boom Utilization Time (seconds)
Accelerometer X-force
Numeric
(1/1000 g-unit)
Accelerometer Z-force
Numeric
Engine hours (seconds)
Numeric
SC
Numeric
SEQ
3 digits (000 255)
APTack
8: Periodic No Motion
12: Input1
String
Numeric
(1/1000 g-unit)
AY
String
Sensor type
1: Wireless Inclinometer
Sensor code
1: Paired
2: Low Battery
3: Hardware Failure
4: Not Found
5: Incompatible Firmware Version
6: Orphaned Sensor (Network Address Collision)
Unique message indicator included on UDP+ACK protocol(s)

ACK, ERROR on message receipt
Server Acknowledgement Format
Server response message format in UDP+ACK protocol(s) for acknowledging receipt of device message. There is no
response for non-ACK protocol(s).
+XT:UDP_ACK,<EV#>,<SEQ>##
EV#
Echo of 4 digit event code contained in the received message
SEQ
Echo of sequence number contained in the received message
Server Command Format
Server command message format in UDP+Commands protocol(s) for sending allowed commands to the device.
Server commands are allowed for 1003,1005,1007,3xxx,5xxx and 7xxx device commands
+XT:<UID>,<CMD>,<PARAMS>##
UID
Unit ID (Serial Number/Device IMEI)
PARAMS
Fields associated with <CMD>
CMD
4 digit command code
Server Configuration Commands

1001
Configure backend server settings.
Type
Syntax
Response
Read
+XT:1001?
$$<UID>,1001,<PP>,<IP>,<TU>,<PR>,<PRT>,<PRH>##
Set
+XT:1001,<PP>,<IP>,<TU>[,<PR>[,<PRT>[,<PRH>]]]
$$<UID>,1001,<PP>,<IP>,<TU>,<PR>,<PRT>,<PRH>##
Parameter
Type
Description
<IP>
Numeric
<TU>
Numeric
Remote host IP address or fully-qualified-domain-name
Maximum 39 characters allowed
Default value is 10.10.10.10
<PR>
Numeric
<PRT>
Numeric
<PRH>
Numeric
<PP>
Numeric
Remote host port
Valid range is 1-65535
Default value is 10000
Device communication/messaging protocol
1: TCP
2: UDP
3: UDP with server acknowledgements
4: UDP with server command support
6: UDP with server acknowledgements and server command support
PDP reset interval specifies the number of server connections/sessions which the device will make before it
deactivates the current PDP context and activates a new one.
Default value is 0 (disabled)
PDP active timeout specifies the number of minutes that a PDP context is allowed to remain active before it is
deactivated.
PDP reset heartbeat specifies whether the device should send a heartbeat message to the server whenever a new
PDP context is activated.
0: disable
1: enable
1002
Configure APN (Access Point Name) for GPRS.

Only valid on XT4860G
Type
Syntax
Response
Read
+XT:1002?
$$<UID>,1002,<USN>,<PWD>,<NAME>##
Set
Parameter
<USN>
+XT:1002,<USN>,<PWD>,<NAME>
Type
String
$$<UID>,1002,<USN>,<PWD>,<NAME>##
Description
Username
Default value is usn
<PWD>
String
<NAME>
String
1003
Device
XT4860G
Device
XT4860CS
XT4860CV
Password
Default value is pwd

APN operator name
Default value is apn
Query device network settings.

This query command provides the information contained in the 1001, 1002, 1008, 1011, 1012, 1013 and 1014
commands.
The output of this command can be used as the input to the 1010 command.
The <USN>, <PWD> & <NAME> fields are only valid on XT4560G and XT4760G modules.
Type
Syntax
Response
Type
Syntax
Response
Read
Read
+XT:1003
+XT:1003
$$<UID>,1003,<PP>,<IP>,<USN>,<PWD>,<NAME>,<SM>,<TU>,<DCE>,<DCT>,<
PR>,<PRT>,<PRH>##
$$<UID>,1003,<PP>,<IP>,<SM>,<TU>,<DCE>,<DCT>,<PR>,<PRT>,<PRH>##
Parameter
Type
Description
<IP>
Dotted Decimal or
String
<USN>
String
<PWD>
String
<NAME>
String
<SM>
Numeric
<TU>
Numeric
<PP>
Numeric
Remote host port
Username

Password

APN operator name

Remote phone number (SMS)
Default value is sms
1: TCP
2: UDP

<DCE>
Numeric
<DCT>
Numeric
<PR>
Numeric
<PRT>
Numeric
<PRH>
Numeric
Enable DNS cache
0: disabled
1: enabled
Configure cache entry TTL (time-to-live)
Valid range is 1-999999 seconds
Default value is 3600 (1 hour)
Setting a value of 0 configures the default
Network session interval specifies the number of server connections/sessions which the device will make before it
deactivates the current network session and activates a new one.
Valid range is 1-40
Network session active timeout specifies the number of minutes that a network session is allowed to remain active
before it is deactivated.

Network session reset heartbeat specifies whether the device should send a heartbeat message to the server
whenever a new network session is activated.
0: disable
1: enable
<USN>, <PWD> and <NAME> fields are only available on XT4860G Devices.
1004
Configure remote FTP server settings.
Type
Syntax
Response
Read
+XT:1004?
$$<UID>,1004,<DIR>,<FUSN>,<FPWD>,<FIP>,<FPT>,<FMD>,<FRT>##
Set
+XT:1004,<DIR>,<FUSN>,<FPWD>,<FIP>,<FPT>,<FMD>[,<FRT>]
Parameter
Type
Description
<FUSN>
String
<FPWD>
String
Username
<FIP>
Dotted Decimal or
String
<FPT>
Numeric
<DIR>
String
Directory to change to after device logs into the remote server.
Default value is dir
Multiple directory levels in <DIR> are not supported
Password
FTP server IP address or fully-qualified-domain-name

FTP server port
1-65535
Default value is 21
10
<FMD>
Numeric
<FRT>
Numeric
Setting this value to 0 configures the default
FTP data mode
0: Active
1: Passive
Default is 0 (Active)
FTP retries
Valid range is 0-10
Default value is 3
1005
Query remote FTP server settings.
Type
Syntax
Read
Response
+XT:1005
Parameter
Type
Description
<FUSN>
String
<FPWD>
String
Username
<FIP>
Dotted Decimal or
String
<FPT>
Numeric
<FMD>
Numeric
<FRT>
Numeric
<DIR>
String
Directory to change to after device logs into the remote server.
Default value is dir
Multiple directory levels in <DIR> are not supported
Password
FTP server IP address or fully-qualified-domain-name
FTP server port
1-65535
Default value is 21
Setting this value to 0 configures the default

FTP data mode
0: Active
1: Passive
Default is 0 (Active)
FTP retries
Valid range is 0-10
Default value is 3
1006
Device firmware update command.

It is recommended to disable sleep mode prior to initiating a firmware update.
1000, 3000, 5000 and 7000 series settings may be reset to defaults after a main firmware update.
Reference release notes for hardware/firmware download compatibility.
Type
Syntax
Execute
+XT:1006,<bb>,<filename>
Response
Sent upon receipt of command

$$<UID>,1006,1,<bb>,<filename>##
Sent upon completion of update
$$<UID>,1007,<FWM>,<PF>,<GV>##
11
Parameter
Type
Description
<filename>
String
<FWM>
String
Firmware filename
<bb>
Numeric
Firmware type.
1: Main firmware
13: Geofence filesystem

Main firmware version
1007
Query revisions of device firmware.
Type
Syntax
Read
Response
+XT:1007
$$<UID>,1007,<FWM>,<PF>,<GV>##
Parameter
Type
Description
<PF>
String
Configuration profile name
<FWM>
<GV>
String
Main firmware version
2 characters
Specifies the device cellular type and GPS type
1008
Configure remote phone number (SMS).
Type
Syntax
Response
Read
+XT:1008?
$$<UID>,1008,<SM>##
Set
Parameter
<SM>
+XT:1008,<SM>
$$<UID>,1008,<SM>##
Type
Description
String
1010
Configure device network settings.

This configuration command allows setting the features specified in the 1001, 1002, 1008, 1011, 1012, 1013
and 1014 commands.
The <USN>, <PWD> & <NAME> fields are only valid on XT4860G modules.
Device
Type
Syntax
Response
Read
+XT:1010?
PR>,<PRT>,<PRH>##
Syntax
Response
XT4860G
Device
XT4860CS
XT4860CV
Set
Type
Set
+XT:1010,<PP>,<IP>,<USN>,<PWD>,<NAME>,<
SM>,<TU>,<DCE>,<DCT>[[[,<PR>],<PRT>],<PRH
>]
+XT:1010,<PP>,<IP>,<SM>,<TU>,<DCE>,<DCT>[
[[,<PR>],<PRT>],<PRH>]
PR>,<PRT>,<PRH>##
12
Read
+XT:1010?
Parameter
Type
Description
<IP>
Dotted Decimal or
String
<USN>
Numeric
<PWD>
Numeric
<NAME>
Numeric
<SM>
Numeric
<TU>
Numeric
<DCE>
Numeric
<DCT>
Numeric
<PR>
Numeric
<PRT>
Dotted Decimal or
String
<PRH>
Numeric
<PP>
Numeric
Remote host port
Username

Password

APN operator name

1: TCP
2: UDP

Enable DNS cache
0: disabled
1: enabled
Network session reset interval specifies the number of server connections/sessions which the device will make
before it deactivates the current network session and activates a new one.
Network session active timeout specifies the number of minutes that a network session is allowed to remain active
before it is deactivated.

Network session reset heartbeat specifies whether the device should send a heartbeat message to the server
whenever a new network session is activated.
0: disable
1: enable
13
<USN>, <PWD> and <NAME> fields are only available on XT4860G Devices.
1011
Configure PDP reset interval.
Type
Syntax
Response
Read
+XT:1011?
$$<UID>,1011,<PR>##
Set
Parameter
<PR>
+XT:1011,<PR>
Type
Numeric
$$<UID>,1011,<PR>##
Description
PDP reset interval specifies the number of server connections/sessions which the device will make before it
deactivates the current PDP context and activates a new one.
1012
Configure PDP active timeout.
Type
Syntax
Response
Read
+XT:1012?
$$<UID>,1012,<PRT>##
Set
Parameter
<PRT>
+XT:1012,<PRT>
Type
Numeric
$$<UID>,1012,<PRT>##
Description
PDP active timeout specifies the number of minutes that a PDP context is allowed to remain active before it is
deactivated.
1013
Configure DNS cache
Type
Syntax
Response
Read
+XT:1013?
$$<UID>,1013,<DCE>,<DCT>##
Set
+XT:1013,<DCE>,<DCT>
$$<UID>,1013,<DCE>,<DCT>##
Parameter
Type
Description
<DCT>
Numeric
<DCE>
Numeric
Enable DNS cache
0: disabled
1: enabled
14
1014
Configure PDP reset heartbeat.
Type
Syntax
Response
Read
+XT:1014?
$$<UID>,1014,<PRH>##
Set
Parameter
<PRH>
+XT:1014,<PRH>
Type
Numeric
$$<UID>,1014,<PRH>##
Description
PDP reset heartbeat specifies whether the device should send a heartbeat message to the server whenever a new
PDP context is activated.
0: disable
1: enable
3001
Configure ignition on periodic reporting interval.

The device will send a 4001 event at the configured periodic interval (ONI) for wired ignition.
The device will send a 4003 event at the configured periodic interval (ONI) for virtual battery or virtual GPS
ignition types.
The device will send a 6011 event when ignition on is detected and the alert is enabled (ONA) for wired
ignition.
The device will send a 6013 event when ignition on is detected and the alert is enabled (ONA) for virtual
battery and virtual GPS ignition types.
Review the 3012 command for details on supported ignition types.
Type
Syntax
Response
Read
+XT:3001?
$$<UID>,3001,<ONI>,<ONA>##
Set
+XT:3001,<ONI>,<ONA>
$$<UID>,3001,<ONI>,<ONA>##
Parameter
Type
Description
<ONA>
Numeric
Enable alert
0: Disabled
1: Enabled
<ONI>
3002
One Decimal
Resolution
Periodic interval setting in minutes
Valid range is 0.5-43200.0
Only 0.5 minute increments are allowed
Default value is 10.0
Configure ignition off periodic reporting interval.

The device will send a 4002 event at the configured periodic interval (OFI) for wired ignition.
The device will send a 4004 event at the configured periodic interval (OFI) for virtual battery or virtual GPS
ignition types.
The device will send a 6012 event when ignition off is detected and the alert is enabled (OFA) for wired
ignition.
The device will send a 6014 event when ignition off is detected and the alert is enabled (OFA) for virtual
battery and virtual GPS ignition types.
15
Review the 3012 command for defaults on supported ignition types.
Type
Syntax
Response
Read
+XT:3002?
$$<UID>,3002,<OFI>,<OFA>##
Set
+XT:3002,<OFI>,<OFA>
$$<UID>,3002,<OFI>,<OFA>##
Parameter
Type
Description
<OFA>
Numeric
Enable alert
0: disabled
1: enabled
<OFI>
Numeric
Only 5 minute increments are allowed
3003
Configure direction change threshold.

The device will send a 6001 event when the direction change exceeds the configured threshold.
Type
Syntax
Response
Read
+XT:3003?
$$<UID>,3003,<DCT>##
Set
Parameter
<DCT>
+XT:3003,<DCT>
Type
Numeric
$$<UID>,3003,<DCT>##
Description
Heading threshold degrees
Only 5 degree increments are allowed
3004
Configure speed threshold.

The device will send a 6002 event when the speed exceeds the configured threshold.
Type
Syntax
Response
Read
+XT:3004?
$$<UID>,3004,<SPT>##
Set
Parameter
<SPT>
3006
+XT:3004,<SPT>
Type
Numeric
$$<UID>,3004,<SPT>##
Description
Speed threshold mph
Configure mileage threshold.

The device will send a 6005 event each time the mileage exceeds a multiple of the configured threshold.
A 6005 event is sent when the mileage wraps from 65000 to zero.
16
A power-cycle or reset command will reset the mileage to zero.
Type
Syntax
Response
Read
+XT:3006?
$$<UID>,3006,<MT>##
Set
Parameter
<MT>
+XT:3006,<MT>
Type
Numeric
$$<UID>,3006,<MT>##
Description
Mileage threshold configures the mileage interval when the device will send the 6005 event.
Valid range is 10-65000 (miles)
Only 5 mile increments are allowed
3009
Configure main battery disconnect reporting

The device will send a 6009 event when the main battery is disconnected for 2 minutes when the alert (DA) is
enabled.
The device will send a 6010 event when the main battery is reconnected when the alert (DA) is enabled.
The device will send a 4005 event at the periodic interval (DI) while the main battery is disconnected.
When the main battery is disconnected the device will not send 4001, 4002, 4003, 4004, 4006 or 4050 events.
When periodic reporting during disconnect (DP) is set to 0 the device will send 4001, 4002, 4003, 4004, 4006
or 4050 events.
Type
Syntax
Response
Read
+XT:3009?
$$<UID>,3009,<DI>,<DA>,<DP>##
Set
+XT:3009,<DI>,<DA>,<DP>
$$<UID>,3009,<DI>,<DA>,<DP>##
Parameter
Type
Description
<DA>
Numeric
<DP>
Numeric
Main battery disconnect and reconnect alert setting
0: disabled
1: enabled
<DI>
Numeric
Disconnected battery periodic reporting interval in minutes
Periodic Reporting During Disconnect
0: disabled
1: enabled
3010
Configure device heartbeat and power-up/reset reporting

The device will send a 4006 event and a 4050 event at the periodic interval (PI).
The device will send a 6015 event and a 4050 event upon power-up/reset & GPS lock when the alert (PA) is
enabled.
Type
Syntax
Set
+XT:3010,<PI>,<PA>
Response
$$<UID>,3010,<PI>,<PA>##
17
Read
+XT:3010?
$$<UID>,3010,<PI>,<PA>##
Parameter
Type
Description
<PA>
Numeric
Power-up/Reset and GPS lock alert enable/disable setting
0: disabled
1: enabled
<PI>
Numeric
Periodic heartbeat report interval in minutes
3012
Configure device ignition detection
Type
Syntax
Response
Read
+XT:3012?
$$<UID>,3012,<IGT>##
Set
Parameter
<IGT>
+XT:3012,<IGT>
Type
Numeric
$$<UID>,3012,<IGT>##
Description
Ignition Type
1: Wired
2: Virtual Battery
3: Virtual GPS
4: Virtual Battery with Motion/Vibration Assist
3013
Configure device idle alert period

The device will send a 6016 event at the idle reporting interval.
Type
Syntax
Response
Read
+XT:3013?
$$<UID>,3013,<IDT>##
Set
Parameter
<IDT>
+XT:3013,<IDT>
Type
Numeric
$$<UID>,3013,<IDT>##
Description
Idle time in minutes
1 minute increments are allowed
3014
Configure device towing alert and thresholds

The device will send a 6017 event when towing is detected.
The device will send a 6018 event when towing was detected and the vehicle has stopped.
This feature does not work with Virtual GPS Ignition Type.
Towing alerts only apply once Ignition Off has been detected.
Type
Syntax
Set
+XT:3014,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>
Response
$$<UID>,3014,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>##
18
Read
+XT:3014?
$$<UID>,3014,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>##
Parameter
Type
Description
<TSTS>
Numeric
<TSPS>
Numeric
Towing start speed threshold (mph)
Valid range is 3-150 MPH
Default value is 0 (20 MPH)
<TSTT>
Numeric
<TSPT>
Numeric
<TW>
Numeric
Enable alert
0: disabled
1: enabled
Towing stop speed threshold (mph)
The maximum value must also be a minimum of 3 MPH less than the <TSTS> setting
Towing start time threshold (seconds)
Default value is 0 (10 seconds)
Towing stop time threshold (seconds)
3015
Input Pin (2) configuration

The device will send a 6019 event for a low-to-high transition.
The device will send a 6020 event for a high-to-low transition.
Type
Syntax
Response
Read
+XT:3015?
$$<UID>,3015,<IN2>##
Set
Parameter
<IN2>
+XT:3015,<IN2>
Type
Numeric
$$<UID>,3015,<IN2>##
Description
Input Pin (2) port setting
0: alert disabled
1: low-to-high transition enabled
2: high-to-low transition enabled
3: both low-to-high and high-to-low transitions enabled
3017
Configure device sleep/wake configuration

<WT1> period is not resettable due to SMS interrupt
<WT2> period is resettable due to SMS interrupt
The device will not enter sleep if IN1 (Ignition Wire) is pulled high.
The device will always wake from sleep immediately when IN1 (Ignition Wire) is pulled high.
<WT1> period is intended to provide the device time to obtain GPS lock and Cellular network registration
prior to an attempt to send a wake alert.
<WT2> period is intended to allow for receiving SMS messages or UDP commands (UDPC protocols only).
<WNM> is the time before shutdown that a shutdown notification will be sent.
The modes which this command can enable in the Wake Mask (WM) setting are further configured in the
54xx commands.
Type
Syntax
Response
19
Set
Read
+XT:3017,<WT1>,<WT2>,<WNM>,<MWM>
+XT:3017?
Parameter
Type
Description
<WT2>
Numeric
<WNM>
Numeric
Post-Alert wake time in minutes
Valid range is 0-15 minutes
1 minute increments allowed
Default value is 1 minute
<MWM>
Numeric
<WT1>
Numeric
$$<UID>,3017,<WT1>,<WT2>,<WNM><MWM>##
$$<UID>,3017,<WT1>,<WT2>,<WNM><MWM>##
Pre-Alert maximum wake time in minutes
Shutdown notification time in minutes
Motion Wake Mask
0: Disabled
1: Sleep Time
2: Motion Wake
4: Motion/No-Motion Periods & Thresholds
8: Daily Wake
16: WakePin (Input1/Ignition Wire)1

Allowed Configurations
00: Disabled
01: Sleep Time
02: Motion Wake
03: Sleep Time and Motion Wake
08: Daily Wake
10: Motion Wake and Daily Wake
16: WakePin Only
3019
Configure device moving alert and thresholds

The device will send a 6030 event when moving is detected.
The device will send a 6031 event when moving was detected and the vehicle has stopped.
Moving alerts only apply once Ignition On has been detected.
Type
Syntax
Response
Read
+XT:3019?
$$<UID>,3019,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>##
Set
Parameter
<MW>
+XT:3019,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>
Type
Numeric
$$<UID>,3019,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>##
Description
Enable alert
0: disabled
1: enabled
The WakePin mask is not supported on legacy MSP products, this wake control is inherent. Any other non-zero mask will also
configure wake on Ignition.
1
20
<MSTS>
Numeric
<MSPS>
Numeric
<MSTT>
Numeric
<MSPT>
Numeric
Moving start speed threshold (mph)
Moving stop speed threshold (mph)
Moving start time threshold (seconds)
Moving stop time threshold (seconds)
3020
Configure device Park Time threshold

The device will send a 6032 event when park time exceeds the threshold.
Type
Syntax
Response
Read
+XT:3020?
$$<UID>,3020,<PT>##
Set
Parameter
<PT>
+XT:3020,<PT>
Type
Numeric
$$<UID>,3020,<PT>##
Description
Park Time threshold in minutes
3023
Configure device 3-axis accelerometer thresholds

The device will send a 6035 event when a threshold is exceeded.
Type
Syntax
Response
Read
+XT:3023?
$$<UID>,3023,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH>##
Set
+XT:3023,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH>
$$<UID>,3023,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH>##
Parameter
Type
Description
<XL>
Numeric
<XH>
Numeric
X Low Threshold in millig-unit (1/1000 g-unit)
Valid range is -2000-2000 millig-units
<YL>
Numeric
<YH>
Numeric
<AE>
Numeric
Enable alert
0: disabled
1: enabled
X High Threshold in millig-unit (1/1000 g-unit)
Must be 100 millig-units higher than X Low Threshold

Y Low Threshold in millig-unit (1/1000 g-unit)

Y High Threshold in millig-unit (1/1000 g-unit)
21
<ZL>
Numeric
<ZH>
Numeric
Z Low Threshold in millig-unit (1/1000 g-unit)

Z High Threshold in millig-unit (1/1000 g-unit)
3031
Configure device quick fence

Upon movement or towing stop, device will create a circular geofence around its current location with the
configured radius.
While within the fence, the device will suppress all moving or towing alerts.
Type
Syntax
Response
Read
+XT:3031?
$$<UID>,3031,<RA>,<MA>##
Set
+XT:3031,<RA>,<MA>
$$<UID>,3031,<RA>,<MA>##
Parameter
Type
Description
<MA>
Numeric
Quick fence enable setting
0: Disabled
1: Enabled for Movement
2: Enabled for Towing
3: Enabled for Movement and Towing
<RA>
Numeric
Fence Radius in meters
Valid range is 10-65000 meters
Default value is 0 (10 meters)
3034
Configure device external ADC alert and thresholds

The device will send a 6048 event when the Low Threshold is crossed.
The device will send a 6049 event when the High Threshold is crossed.
The device must detect that both thresholds are crossed for 10 consecutive seconds before the event is sent.
Type
Syntax
Response
Read
+XT:3034?
$$<UID>,3034,<EAA>,<EAL>,<EAH>##
Set
+XT:3034,<EAA>,<EAL>,<EAH>
Parameter
Type
Description
<EAL>
One Decimal
Resolution
<EAH>
One Decimal
Resolution
ADC Low Threshold in Volts
Valid Range is 6.0-24.0 VDC
0.1 VDC increments allowed
Default value is 0 (Disabled)
<EAA>
Numeric
$$<UID>,3034,<EAA>,<EAL>,<EAH>##
Alert Enable
0: Disabled
1: Enabled
ADC High Threshold in Volts
Must be 2.0 VDC higher than ADC Low Threshold
22
3040
Composite Configuration Command

Configures 3001, 3002, 3003, 3004, 3006, 3009, 3010, 3012, 3013, 3014, 3015, 3017, 3019, 3023, 3031 and
3081 in a single command.
The read option for this command can also be invoked by sending +XT:3050 to the device.
Type
Syntax
Response
Read
+XT:3040?
$$<UID>,3040,<ONI>,<ONA>,<OFI>,<OFA>,<DCT>,<SPT>,<MT>,<BT>,<DI>,<DA
>,<DP>,<PI>,<PA>,<IGT>,<IDT>,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>,<IN2>,<
WT1>,<WT2>,<WNM>,<MWM>,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>,,<RA>,<MA>,<CM>##
Set
Read
+XT:3040,<ONI>,<ONA>,<OFI>,<OFA>,<DCT>,<SPT>,<MT>,<DI>,<
DA>,<DP>,<PI>,<PA>,<IGT>,<IDT>,<TW>,<TSTS>,<TSPS>,<TSTT>,<
TSPT>,<IN2>,<WT1>,<WT2>,<WNM>,<MWM>,<MW>,<MSTS>,<
MSPS>,<MSTT>,<MSPT>,<PT>,<RA>,<MA>.<CM>
+XT:3050
$$<UID>,3040,<ONI>,<ONA>,<OFI>,<OFA>,<DCT>,<SPT>,<MT>,<DI>,<DA>,<D
P>,<PI>,<PA>,<IGT>,<IDT>,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>,<IN2>,<WT1>
,<WT2>,<WNM>,<MWM>,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>,<PT>,<R
A>,<MA>,<CM>##
Parameter
Type
Description
<ONA>
Numeric
<OFI>
Numeric
Enable alert
0: Disabled
1: Enabled
<OFA>
Numeric
<DCT>
Numeric
<SPT>
Numeric
<MT>
Numeric
<DI>
Numeric
<DA>
Numeric
<ONI>
One Decimal
Resolution
$$<UID>,3040,<ONI>,<ONA>,<OFI>,<OFA>,<DCT>,<SPT>,<MT>,<DI>,<DA>,<D
P>,<PI>,<PA>,<IGT>,<IDT>,<TW>,<TSTS>,<TSPS>,<TSTT>,<TSPT>,<IN2>,<WT1>
,<WT2>,<WNM>,<MWM>,<MW>,<MSTS>,<MSPS>,<MSTT>,<MSPT>,<PT>,<R
A>,<MA>,<CM>##
Valid range is 0.5-43200.0
Only 0.5 minute increments are allowed

Enable alert
0: disabled
1: enabled
Heading threshold degrees
Only 5 degree increments are allowed

Speed threshold mph
Mileage threshold configures the mileage interval when the device will send the 6005 event.
Valid range is 10-65000 (miles)
Only 5 mile increments are allowed

Disconnected battery periodic reporting interval in minutes

Main battery disconnect and reconnect alert setting
23
<DP>
Numeric
<PI>
Numeric
<PA>
Numeric
<IGT>
Numeric
<IDT>
Numeric
<TW>
Numeric
<TSTS>
Numeric
<TSPS>
Numeric
<TSTT>
Numeric
<TSPT>
Numeric
<IN2>
Numeric
<WT1>
Numeric
<WT2>
Numeric
<WNM>
Numeric
0: disabled
1: enabled
Periodic Reporting During Disconnect
0: disabled
1: enabled
Periodic heartbeat report interval in minutes
Power-up/Reset and GPS lock alert enable/disable setting
0: disabled
1: enabled

Ignition Type
1: Wired
2: Virtual Battery
3: Virtual GPS
4: Virtual Battery with Motion/Vibration Assist

Idle time in minutes
1 minute increments are allowed

Enable alert
0: disabled
1: enabled

Towing start speed threshold (mph)
Towing stop speed threshold (mph)
Towing start time threshold (seconds)
Towing stop time threshold (seconds)
Input Pin (2) port setting
0: alert disabled
1: low-to-high transition enabled
2: high-to-low transition enabled
3: both low-to-high and high-to-low transitions enabled

Pre-Alert maximum wake time in minutes

Post-Alert wake time in minutes

Shutdown notification time in minutes
24
<MWM>
Numeric
<MW>
Numeric
<MSTS>
Numeric
<MSPS>
Numeric
<MSTT>
Numeric
<MSPT>
Numeric
<PT>
Numeric
<RA>
Numeric
<MA>
Numeric
<CM>
Numeric
3042

Motion Wake Mask
0: Disabled
1: Sleep Time
2: Motion Wake
8: Daily Wake
16: WakePin (Input1/Ignition Wire)

Allowed Configurations
00: Disabled
01: Sleep Time
02: Motion Wake
03: Sleep Time and Motion Wake
08: Daily Wake
10: Motion Wake and Daily Wake
16: WakePin Only

Enable alert
0: disabled
1: enabled

Moving start speed threshold (mph)
Moving stop speed threshold (mph)
Moving start time threshold (seconds)
Moving stop time threshold (seconds)
Park Time threshold in minutes

Fence Radius in meters
Valid range is 10-65000 meters
Default value is 0 (10 meters)
Quick fence enable setting
0: Disabled
1: Enabled for Movement
2: Enabled for Towing
3: Enabled for Movement and Towing
Clock Mode
1: Maintain GPS Lost Lock Across Sleep
2: Adjust Date/Time presented using PLL/RTC (based on Last Lock)
Any combination is available via summation.
Composite Configuration Command

Configures 3023, 3034 and 3070 in a single command.
25
Firmware
X8z1
The read option for this command can also be invoked by sending +XT:3052 to the device.
3070 is only valid on X8z2 FW.
Type
Syntax
Response
Read
+XT:3042?
$$<UID>,3042,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH>,<EAA>,<EAL>,<EAH> ##
Type
Syntax
Response
Read
+XT:3042?
$$<UID>,3042,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH>,<EAA>,<EAL>,<EAH>,,<IAT>,<IAD>,<ISS>##
Set
Read
Firmware
X8z2
Set
Read
+XT:3042,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH
>,<EAA>,<EAL>,<EAH>
+XT:3052
+XT:3042,<AE>,<XL>,<XH>,<YL>,<YH>,<ZL>,<ZH
>,<EAA>,<EAL>,<EAH>,<IAE>,<IAT>,<IAD>,<ISS>
+XT:3052
Parameter
Type
Description
<XL>
Numeric
<XH>
Numeric
X Low Threshold in millig-unit (1/1000 g-unit)
<YL>
Numeric
<YH>
Numeric
<ZL>
Numeric
<ZH>
Numeric
<EAA>
Numeric
<EAL>
One Decimal
Resolution
<EAH>
One Decimal
Resolution
<IAE>
Numeric
<AE>
Numeric
Enable alert
0: disabled
1: enabled
X High Threshold in millig-unit (1/1000 g-unit)
Must be 100 millig-units higher than X Low Threshold

Y Low Threshold in millig-unit (1/1000 g-unit)

Y High Threshold in millig-unit (1/1000 g-unit)

Z Low Threshold in millig-unit (1/1000 g-unit)

Z High Threshold in millig-unit (1/1000 g-unit)

Alert Enable
0: Disabled
1: Enabled
ADC Low Threshold in Volts
ADC High Threshold in Volts
Must be 2.0 VDC higher than ADC Low Threshold

Alert Enable
26
<IAT>
Numeric
<IAD>
Numeric
<ISS>
Numeric
0: Disabled
1: Enabled Angle Threshold
2: Enabled Delta Threshold
3: Enabled Both Angle and Delta Thresholds
Inclinometer absolute threshold
Valid Range is -5-180 degrees
1 degree increments allowed
Default value is 0
Inclinometer delta threshold
Valid Range is 5-90 degrees
Default value is 5
Inclinometer sensor sensitivity
Valid Range is 1 to 10
1 step increments allowed
Default value is 3
Higher values allow sensor updates when vehicle is not steady (movement/vibration), but with slightly
degraded sensor accuracy
<IAE>, <IAT>, <IAD> and <ISS> are only present on X8z2 FW.
3070
Configure inclinometer thresholds and alerts

The device will send a 6077 event when the inclinometer is detected above the threshold (IAE) when the
enable setting (IAE) is 1 or 3.
The device will send a 6078 event when the inclinometer is detected below the threshold when the enable
setting (IAE) is 1 or 3.
The inclinometer angle threshold alert is only sent once the angle is detected as relatively static.
The device will send a 6085 event when the inclinometer angle is determined to have changed greater than or
equal to the configured delta threshold (IAD).
Only valid on X8z2 FW.
Type
Syntax
Response
Read
+XT:3070?
$$<UID>,3070,<IAE>,<IAT>,<IAD>,<ISS>##
Set
+XT:3070,<IAE>,<IAT>,<IAD>,<ISS>
Parameter
Type
Description
<IAT>
Numeric
<IAD>
Numeric
Inclinometer absolute threshold
Valid Range is -5-180 degrees
Default value is 0
<IAE>
Numeric
$$<UID>,3070,<IAE>,<IAT>,<IAD>,<ISS>##
Alert Enable
0: Disabled
1: Enabled Angle Threshold
2: Enabled Delta Threshold
3: Enabled Both Angle and Delta Thresholds
Inclinometer delta threshold
Valid Range is 5-90 degrees
Default value is 5
27
<ISS>
Numeric
Inclinometer sensor sensitivity
Valid Range is 1 to 10
1 step increments allowed
Default value is 3
Higher values allow sensor updates when vehicle is not steady (movement/vibration), but with slightly
degraded sensor accuracy
3081
Configure clock mode
Type
Syntax
Response
Read
+XT:3081?
$$<UID>,3081,<CM>##
Set
+XT:3081,<CM>
Parameter
<CM>
Type
Numeric
$$<UID>,3081,<CM>##
Description
Clock Mode
1: Maintain GPS Lost Lock Across Sleep
2: Adjust Date/Time presented using PLL/RTC (based on Last Lock)
Any combination is available via summation.
3083
Configure AUX UART parameters
Type
Syntax
Response
Read
+XT:3083?
$$<UID>,3083, <BAUD>,<DB>,,<SB>##
Set
+XT:3083,<BAUD>,<DB>,,<SB>
Parameter
Type
Description
<DB>
Numeric
Data bits: 8, 7, 6
<BAUD>

<SB>
Numeric
Numeric
Numeric
$$<UID>,3083, <BAUD>,<DB>,,<SB>##
Baud: 4800, 9600, 14400, 19200, 38400, 57600 bps

Parity: 0 (none), 1 (odd), 2 (even)
Stop bits: 1, 2
Only baud is configurable in 1156DA1 release.
3084
Configure AUX protocol parameters
Type
Syntax
Response
Read
+XT:3084?
$$<UID>,3084, <SOF>,<EOF>,<PYLDSZ>##
Set
+XT:3084,<SOF>,<EOF>,<PYLDSZ>
$$<UID>,3084, <SOF>,<EOF>,<PYLDSZ>##
Parameter
Type
Description
<EOF>
Char or Hex
End-of-frame: Single ASCII character, or hex valued if starting with 0x. Read always prints hex code.
<SOF>
<PYLDSZ>
5402
String
Numeric
Start-of-frame: 1-3 byte string that distinguishes SOF on AUX UART
Payload length: 1-128 bytes, effective on reboot. Only impacts buffer size, not protocol.
Configure motion/no-motion wake periods and thresholds
28
Type
Syntax
Response
Read
+XT:5402?
$$<UID>,5402,<PMT>,<MP>,<MHT>,<PNMT>,<NP>,<NHT>##
Set
+XT:5402,<PMT>,<MP>,<MHT>,<PNMT>,<NP>,<NHT>
$$<UID>,5402,<PMT>,<MP>,<MHT>,<PNMT>,<NP>,<NHT>##
Parameter
Type
Description
<MP>
Numeric
<MHT>
Numeric
Motion period in seconds
1 second increments allowed
<PNMT>
Numeric
<NP>
Numeric
<NHT>
Numeric
5403
Configure daily wake times

Up to 4 daily wake times can be specified.
Daily wake times are in UTC.
The device will wake up before the configured daily wake time based on the <WT1> configuration in the
3017. This allows the event to be recorded and transmitted as close as possible to the configured time.
When the device enters sleep, it will ignore any daily wake times which are configured to expire within the
next 15 minutes.
Type
Syntax
Response
Read
+XT:5403?<DWTI>
$$<UID>,5403,<DWTI>,<DWTE>,<DWTH>,<DWTM>##
<PMT>
Set
Numeric
Periodic motion timer in minutes
Motion hit threshold (percentage)
1 percent increments allowed

Periodic no-motion timer in hours

No-motion period in seconds
1 second increments allowed
No-motion hit threshold (percentage)
1 percent increments allowed
+XT:5403,<DWTI>,<DWTE>,<DWTH>,<DWTM>
Parameter
Type
Description
<DWTE>
Numeric
Daily wake enable/disable
0: Disabled
1: Enabled
<DWTI>
Numeric
$$<UID>,5403,<DWTI>,<DWTE>,<DWTH>,<DWTM>##
Daily wake index
Valid range is 1-4
29
<DWTH>
Numeric
<DWTM>
Numeric
5421
Configure low battery time thresholds

A battery low event is declared when voltage is below the configured threshold for the specified battery low
time <BLH>.
The battery low event is cleared when voltage reaches at least 1 VDC above the configured threshold for the
battery reset time <BRH>.
A battery disconnect event is declared when voltage is below 2 VDC for the specified battery disconnect time
<BDH>.
A battery disconnect event is cleared when voltage reaches at least 6 VDC for the specified battery reset time
<BRH>.
Type
Syntax
Response
Read
+XT:5421?
$$<UID>,5421,<BLH>,<BDH>,<BRH>##
Set
Daily wake time hour-of-day
Valid range is 0-23
Default value is 0
Daily wake time minute-of-hour
Valid range is 0-59
Default value is 0
+XT:5421,<BLH>,<BDH>,<BRH>
$$<UID>,5421,<BLH>,<BDH>,<BRH>##
Parameter
Type
Description
<BDH>
Numeric
<BRH>
Numeric
Battery disconnect time in seconds
5501
Configure wired ignition detection

Device will declare ignition on when Ignition Sense pin is detected high for the configured on time.
Device will declare ignition off when Ignition Sense pin is detected low for the configured off time.
Command is only applicable with wired ignition type (ref. 3012).
Type
Syntax
Response
Read
+XT:5501?
$$<UID>,5501,<WON>,<WOF>##
<BLH>
Set
Parameter
<WON>
Numeric
Battery low time in seconds
Battery reset time in seconds
+XT:5501,<WON>,<WOF>
Type
Numeric
$$<UID>,5501,<WON>,<WOF>##
Description
Wired ignition on time in seconds
30
Default value is 10
Specifying a value of 0 configures the default
<WOF>
Numeric
5502
Configure virtual ignition detection based on battery voltage

Device will declare ignition on when voltage is above the configured threshold for the configured on time.
Device will declare ignition off when voltage is below the configured threshold by at least the configured
hysteresis for the configured off time.
Command is only applicable with virtual ignition type based on battery (ref. 3012).
Type
Syntax
Response
Read
+XT:5502?
$$<UID>,5502,<VBT>,<VBH>,<VBON>,<VBOF>##
Set
Parameter
<VBT>
Wired ignition off time in seconds
Default value is 10
+XT:5502,<VBT>,<VBH>,<VBON>,<VBOF>
Type
One Decimal
Resolution
<VBH>
$$<UID>,5502,<VBT>,<VBH>,<VBON>,<VBOF>##
Description
Battery based virtual ignition on threshold
Valid range is 10.0-20.0 VDC

Battery based virtual ignition off hysteresis
Valid range is 0.1-9.0 VDC
<VBON>
Numeric
<VBOF>
Numeric
5503
Configure virtual ignition detection based on GPS speed

Device will declare ignition on when speed is above the configured threshold for the configured on time.
Device will declare ignition off when speed is below the configured threshold by at least the configured
hysteresis for the configured off time.
Command is only applicable with virtual ignition type based on GPS speed (ref. 3012).
Type
Syntax
Response
Read
+XT:5503?
$$<UID>,5503,<VGT>,<VGH>,<VGON>,<VGOF>##
Set
Battery based virtual ignition on time in seconds
Default value is 3

Battery based virtual ignition off time in seconds
Default value is 3
+XT:5503,<VGT>,<VGH>,<VGON>,<VGOF>
$$<UID>,5503,<VGT>,<VGH>,<VGON>,<VGOF>##
31
Parameter
Type
Description
<VGH>
Numeric
<VGON>
Numeric
GPS based virtual ignition off hysteresis in MPH
<VGT> - <VGH> must be at least 3 MPH
1 MPH increments allowed
Default value is 15
<VGOF>
Numeric
5701
Configure GSM LED
Type
Syntax
Response
Read
+XT:5701?
$$<UID>,5701,<TLM>,<TLA>##
<VGT>
Set
Numeric
GPS based virtual ignition on threshold in MPH
1 MPH increments allowed
Default value is 20
GPS based virtual ignition on time in seconds
Default value is 10

GPS based virtual ignition off time in seconds
+XT:5701,<TLM>,<TLA>
$$<UID>,5701,<TLM>,<TLA>##
Parameter
Type
Description
<TLA>
Numeric
LED Mask
1: Off After Ignition Off
Default value is 0
5801
Configure message format element group
Type
Syntax
Response
Read
+XT:5801?,<GIN>
$$<UID>,5801,<GIN>[,<EN1>[,<EN2>[,<EN3>[,<EN4>[,<EN5>[,<EN6>[,<EN7>[,
<EN8>[,<EN9>[,<EN10>[,<EN11>[,<EN12>]]]]]]]]]]]]##
<TLM>
Set
Parameter
<GIN>
Numeric
LED Mode
1: Xirgo Standard
Specifying a value of 0 configures the default (1)
+XT:5801,<GIN>[,<EN1>[,<EN2>[,<EN3>[,<EN4>[,<EN5>[,<EN6>[,
<EN7>[,<EN8>[,<EN9>[,<EN10>[,<EN11>[,<EN12>]]]]]]]]]]]]
Type
Numeric
$$<UID>,5801,<GIN>[,<EN1>[,<EN2>[,<EN3>[,<EN4>[,<EN5>[,<EN6>[,<EN7>[,
<EN8>[,<EN9>[,<EN10>[,<EN11>[,<EN12>]]]]]]]]]]]]##
Description
Element Group ID
32
Valid range is 1-30
<ENn>
String
5802
Configure message format event group list
Type
Syntax
Response
Read
+XT:5802?,<GLN>
$$<UID>,5802,<GLN>,<EVN>[,<GN1>[,<GN2>[,<GN3>[,<GN4>[,<GN5>[,<GN6>
]]]]]]
Set
Element n string
Valid element strings can be found in the Syntax Field Definitions section.
+XT:5802,<GLN>,<EVN>[,<GN1>[,<GN2>[,<GN3>[,<GN4>[,<GN5>[
,<GN6>]]]]]]
$$<UID>,5802,<GLN>,<EVN>[,<GN1>[,<GN2>[,<GN3>[,<GN4>[,<GN5>[,<GN6>
]]]]]]
Parameter
Type
Description
<EVN>
Numeric
<GNn>
Numeric
Event Number
Valid event numbers can be found in the Device Message Formats section.
An event number can only be configured to have a single format.
Configuring this field as 0 will delete the association with a previously assigned Event Number.
5803
Configure message format event query

This allows lookup of the current format specified for an event number.
Type
Syntax
Parameter
Type
7001
Read and report vehicle position immediately
Type
Syntax
Parameter
Type
<GLN>
Read
<EVN>
Read
<X>
Numeric
Event Group List ID
Valid range is 1-6
Element Group ID
Valid range is 1-30
Response
+XT:5803?,<EVN>
Numeric
$$<UID>,5803,<EVN>[,<EN1>[,<ENn>]]
Description
Event Number
Valid event numbers can be found in the Device Message Formats section.
An event number can only be configured to have a single format.
Configuring this field as 0 will delete the association with a previously assigned Event Number.
Response
+XT:7001,<X>
Numeric
$$<UID>,7001,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<GS>,<O
T>,<CQ>,<MI>,<IG>,<EA>,<BB>,<PM>,<AX>,<AY>,<AZ>[,<SEQ>]##
Description
Response transport
33
1: TCP or UDP socket.

2: SMS
7003
Device reset
Type
Syntax
7004
Device clear and restore saved profile

All data and configuration settings are reset.
Saved profile is restored if present.
Type
Syntax
7005
Configure output port

If <OUT> is configured as (0) and there is no cellular coverage for 10 minutes the output port is set to an
open circuit. The output port will revert back to short circuit after 10 minutes of continuous cellular
coverage.
The output port is an open circuit when the device is in sleep mode.
Type
Syntax
Parameter
Type
Description
<X>
Numeric
Response transport
1: TCP or UDP socket.
2: SMS
7006
Set virtual odometer

Virtual odometer is reset to zero on a power cycle, reset or memory erase.
Type
Syntax
Parameter
Type
Exec
Exec
Set
<OUT>
Set
<VO>
Response
+XT:7003
$$<UID>,7003##
Response
+XT:7004
$$<UID>,7004,<PF>##
+XT:7005,<OUT>,<X>
Numeric
$$<UID>,7005,<D>,<T>,<LT>,<LN>,<AL>,<SP>,<HD>,<SV>,<HP>,<BV>,<GS>,<O
T>,<CQ>,<MI>,<IG>,<EA>,<BB>,<PM>,<AX>,<AY>,<AZ>[,<SEQ>]##
Output pin configuration
0: Short circuit with cellular override enabled
1: Open circuit
2: Short circuit
Response
+XT:7006,<VO>
Numeric
Response
$$<UID>,7006,<VO>##
Description
Virtual odometer setting in miles
34

1 mile increments allowed
7007
GPS reset
Type
Syntax
7008
Device save profile

Saves entire device configuration to memory.
If <PF> is specified as Unknown, FacDflt or Cleared the device will respond with an error.
Type
Syntax
7009
Device clear profile
Type
Syntax
7010
Device read profile

If no profile is saved in memory the device will respond with Cleared.
Type
Syntax
7011
Send data to AUX UART
Type
Syntax
Response
Exec
+XT:7011,<PYLD>
$$<UID>,7011,<CNT>,ACK|ERROR##
Exec
Exec
$$<UID>,7007##
Response
+XT:7008,<PF>
Exec
$$<UID>,7008,<PF>##
Response
+XT:7009
Read
$$<UID>,7009,Cleared##
Response
+XT:7010
Exec
Response
+XT:7007
$$<UID>,7010,<PF>##
:<UID>,7011,<PYLD>
<UID> syntax for network interface, XT syntax for console interface
Parameter
Type
Description
<CNT>
Numeric
Number of records buffered for delivery
<PYLD>
7017
String
$$<UID>,7011,<CNT>,ACK|ERROR##
The payload delivered to the AUX UART
Reset CDMA Module to Factory Defaults

Resets the CDMA module to factory defaults after the configured delay time.
Only valid on XT4860CV and XT4860CS
35
Type
Syntax
Parameter
Type
Description
<MDN>
10 digits
Mobile Directory Number
Read
<UID>
<DLY>
+XT:7017,<UID>,<MDN>,<DLY>
15 digits
Numeric
Response
$$<UID>,7017,<UID>,<MDN>,<DLY>,ACCEPT##
Unit ID (Serial Number/Device MEID)

Delay in minutes before resetting the CDMA module to defaults
Valid range is 15 to 1440
7022
CDMA Module PRL (Preferred Roaming List) Read/Update

Only valid on XT4860CV and XT4860CS
Type
Syntax
Response
Exec
+XT:7022,2
$$<UID>,7022,2,1,<PRLID>##
Read
+XT:7022,1
$$<UID>,7022,1,<PRLID>##
Parameter
Type
7050
Query device diagnostics

Counter and percent values are accumulated since last clear.
Type
Syntax
Parameter
Type
Description
<GSM>
Numeric
<GPR>
Numeric
GSM registration state
0: Not registered
1: Home
2: Searching
3: Denied
4: Unknown
5: Roaming
<PRLID>
Read
<X>
Numeric
Description
Current PRL ID
Response
+XT:7050,<X>
Numeric
$$<UID>,7050,<GSM>,<GPR>,<PDP>,<HOFF>,<HO>,<PU>,<R>,<%GPS>,<%GPS
Q>,<%GSM>,<%GPR>,<%PDP>,<LV>,<HV>,<CX>,<DBO>,<ABI>,<DBI>,<SO>,<SI
>,<SS>,<SCC>##
Query mode
1: Query without clear
2: Clear diagnostic status after read
GPRS registration state
0: Not registered
1: Home
2: Searching
3: Denied
36
<PDP>
Numeric
<HOFF>
Numeric
<HO>
Numeric
<PU>
Numeric
<R>
Numeric
<%GPS>
Numeric
<%GSM>
Numeric
<%GPSQ>
<%GPR>
<%PDP>
<LV>
Numeric
Numeric
Numeric
Numeric
<HV>
Numeric
<CX>
Numeric
<DBO>
Numeric
<ABI>
Numeric
<DBI>
Numeric
<SO>
Numeric
<SI>
Numeric
<SS>
Numeric
<SCC>
Numeric
4: Unknown
5: Roaming
PDP context status
0: Deactivated
1: Activated
Hours disconnected

Hours on

Power-up counter

Reset counter

GPS lost percentage
GPS lost percentage based on 5-satellite quality factor

GSM lost percentage
GPRS lost percentage
PDP context lost percentage
Low voltage detected (seconds below 9 VDC)
High voltage detected (seconds above 16 VDC)

PDP context activations
Data bytes sent
Only bytes associated with records sent to the server are counted. Other network traffic is ignored.
Acknowledgement bytes received
Only bytes from valid acknowledgement messages are counted.

DOTA bytes received
Only bytes received as part of update files are counted.

SMS messages sent

SMS messages received

SMS spam messages received
Solar charging current (milliamps)
37
Appendix A. UDP with ACK Description
The UDP with ACK feature provides an application-layer acknowledgement and retry protocol for UDP messaging.
Operation
The UDP with ACK consists of two progressive timing back-offs:
UDP ack timeouts {30 seconds, 60 seconds}
UDP hold-off intervals {2 minutes, 4 minutes, 8 minutes, 16 minutes, 32 minutes, 64 minutes}
The UDP ack timeouts indicate how long the device will listen for the appropriate acknowledgement from the
server after a UDP message has been sent. The UDP hold-off intervals indicate how long the device will wait
before allowing the retransmission of pending UDP messages.
The device does not receive any acknowledgements sent by the server during the UDP hold-off period.
The device only listens during the acknowledgement timeout periods.
In normal operation, the device will save an event occurrence, send a UDP message to the server and wait for the
appropriate acknowledgement back from the server.
If no acknowledgement is received within the first 15 second timeout, the same message will be retransmitted
with a 30 second timeout. If no acknowledgement is received within the second 30 second timeout, the device
enters the appropriate UDP hold-off period. If the device reaches the maximum 64 minute hold-off period the
hold-off repeats at 64 minute intervals.
If a correct acknowledgement is received from the server the device will delete the event from memory and
proceed to the next event (if present). The timeout and hold-off are reset.
The sequence number only increments after a successful acknowledgement from the server. The sequence number resets
to zero upon; wrapping after reaching 255, power-up/reset of the device, message transmission on a protocol without
acknowledgements.
The sequence number is not unique to the event number.
7001,1 and 7005,<OUT>,1 command responses also include the sequence number field and utilize the acknowledgement
process. These commands force a reset of any existing hold-off periods.
The device listens for the server acknowledgement on the same port as the one used to transmit.
38
Appendix B. Connector Pins

Cable Harness Description
Wire Color
Pin Name
Type
Function
White
IN1
Input
Ignition Sense/Wake Pin
Yellow
IN2
Input
General Purpose Input
Black
GND
Ground
Green
OUT
Output
Output Port
Blue
UART_RX
Input
Serial Receive
Brown
UART_TX
Output
Serial Transmit
Red
VIN
Input
Main Battery Supply
Port Characteristics
8-24 V
<5V
Internally pulled low
> 1 MOhm to GND

< 1 Ohm to GND
250 mA max sink current
3.3 V logic interface

115200 8n1 no flow-control
2.4-24 V
< 0.2 V
Internally pulled high
3.3 V logic interface

115200 8n1 no flow-control
6-24 V
39
Revision History
Revision
Comments
1.1A
Modified 3012 to remove <IVT>,<IVH>,<IVO> and <IVF>

Added 5501,5502,5503,5540
Changed <PMT> units from hours to minutes with range (10-1440)
Changed <PNMT> units from hours to minutes with range (10-1440)
1.0A
1.1B
1.1C
2.0A
2.0B
2.0C
2.0D
2.0E
2.0F
2.0G
2.0H
2.0I
2.0J
Initial release
Changed field values in <WMM> in 3017 from hexadecimal to decimal

Changed <PRT> in 1001 and 1012 valid range to 3-43200
Changed <WT2> in 3017 valid range to 0-15
Added Read description to 5501, 5502 & 5503
Added <DWTI> parameter in 5403? Read command
Date
8/06/2014
Changed <PMT> units from hours to minutes with range (10-1440)

Changed <PNMT> units from hours to minutes with range (10-1440)
11/10/2014
Added <DP> field to 3009

Added <MNM> field to 3017
Added 6027 alert
2/25/2015
Added CDMA support
5/5/2015
Added <MT> field to 3040 fields list

Added <BT> field to 3040 fields list and 3008 description
Added 5421 for configuring battery detection timings
Added 5801, 5802 and 5803 for managing configurable message formats
Added 3081 clock mode configuration
Merged X8z2 FW version into this document
2/19/2015
Added Solar charge current fix to Issues Addressed section
2/28/2015
Modified default values for <ONI>,<ST>,<BLH> and <VBOF>
12/4/2015
Update supported platforms
Removed 50xx commands. These are supplanted by the Geofence System.

Update supported platforms
Updated 1006 command to enumerate geofence filesystem DOTA type.
12/21/2015
12/21/2015
Added Aux Pass-through commands and alerts: 3083, 3084, 6033, 6034, 7011
1/21/2016
Split APT UART ACKs into two event codes, adding event code of upstream message to format of 6034 ACK.
2/19/2016
Enhanced Aux Pass-through protocol to include async TXCMPL message over UART when upstream message is delivered
2/18/2016
40

Clarinet-XT4860 ProtocolDocument 2.0J PDF

Hochgeladen von

Dokumentinformationen

Originalbeschreibung:

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Clarinet-XT4860 ProtocolDocument 2.0J PDF

Hochgeladen von

Copyright:

Verfügbare Formate

Document Information

Communication Specification and Data Format

XT4860G | XT4860CV | XT4860CS

Confidential- Covered Under NDA

New Features in 1156CA3

CDMA module supported.

Support for sSHDN5 (Ship Mode w/ State Save)

Geofence Filesystem support.

Aux port pass-through module and supporting commands

New Features in 1156CA8

New Features in 1156DA1

Confidential- Covered Under NDA

Issues Addressed in 1156CA1

Fixed GPS Time & Coordinate restore.

Fixed 5421 not saved to profile.

Fixed initial setup of UDP socket

Issues Addressed in 1156CA6

Issues Addressed in 1156DA3

Confidential- Covered Under NDA

Device Message Formats

Main battery disconnected periodic reporting

Speed threshold alert

Direction change alert

Mileage threshold exceeded alert

Main battery disconnect alert

Main batter reconnect alert

Idle threshold alert

Towing detected alert

Towing stopped alert

Input2 high alert

Input2 low alert

Shutdown Pending Allert

Park time threshold alert

Accelerometer threshold alert

External ADC low threshold alert

External ADC high threshold alert

Motion start wake alert

Motion stop wake alert

Periodic wake alert

Periodic wake alert while in motion

Periodic wake alert while not in motion

DC power-up wake alert

Above Inclinometer threshold

Below Inclinometer threshold

Input1 high wake alert

Inclinometer delta alert

6077, 6078 & 6085 are only valid on X8z2 FW.

Wired ignition on periodic time based reporting

Virtual ignition on periodic time based reporting

Wired ignition off periodic time based reporting

Virtual ignition off periodic time based reporting

Confidential- Covered Under NDA

Wired ignition on alert

Virtual ignition on alert

Wired ignition off alert

Virtual ignition off alert

Geofence crossing alert

Periodic reporting while device powered (heartbeat)

Diagnostic data (reference 7050 command for field definitions)

Upstream payload bridged from AUX UART

AUX pass-through status/error message

Confidential- Covered Under NDA