Xirgo XT2500 User manual

XT2500 Product Manual
Page 1 | 92
CONFIDENTIAL AND PROPRIETARY
XT2500
Product Manual
Firmware Version: 1183DA2.4
Revised February 08, 2021

XT2500 Product Manual
Page 2 | 92
CONFIDENTIAL AND PROPRIETARY
TABLE OF CONTENTS
1. Functional Description 4
1.1. Overview 4
1.2. Mechanical 4
2. Device Setup 5
2.1. Configure Device Via PC (RS232 to USB) 5
3. Interfaces 6
3.1. UART 6
4. Device Configuration 7
4.1. APNs (apn) 8
4.2. OBD Accel and Decel (oad) 9
4.3. OBD RPM and Speed Events (ors) 10
4.4. OTA Prevent (ota) 11
4.5. Bluetooth Enabled (blt) 12
4.6. Buzzer Songs (bzr) 13
4.7. Destination (dst) 13
4.8. Generic Config Value (gcv) 14
4.9. Input Default Polarity (idp) 15
4.10. Motion Sensitivity (mst) 16
4.11. Serial Port Settings (sps) 16
4.12. Timer Duration (tmr) 18
4.13. Packet Creation Recipe (pcr) 19
4.14. Third-Party Config Values (tpv) 19
4.15. GPS Solution Filter (gsf) 21
4.16. Vehicle Bus Configuration (vbs) 22
5. Interpreter 24
5.1. Language 24

XT2500 Product Manual
Page 3 | 92
CONFIDENTIAL AND PROPRIETARY
5.2. Interpreter Scripting Trigger Block Examples 36
5.3. Packet Recipe 37
6. Command Language 76
6.1. Overview 76
6.2. Commands via UDP 76
6.3. Verb and Module 76
6.4. Object 76
6.5. Arguments 77
6.6. Device Command Modules 79
6.7. California Proposition 65 Warning 92

XT2500 Product Manual
Page 4 | 92
CONFIDENTIAL AND PROPRIETARY
1. FUNCTIONAL DESCRIPTION
1.1. OVERVIEW
The XT2500 series is a plug-n-play universal vehicle tracking unit (VTU) for use in light duty/passenger vehicles.
The XT2500 also suits clientele with large fleets of heavy duty trucks with 9-pin/6-pin Deutsch connectors (RP1226
for newer trucks) via a cable harness/adapter. the XT2500 utilizes a cellular modem, a Bluetooth modem, a
GPSmodem, and an integrated accelerometer to collect information about the vehicle for a variety of
applications.
One key benefit of the XT2500 is the flexibility of the device, allowing it to suit an individual client’s desires. The
device can be expanded by connecting to an external XT1065 I/O box. The XT1065 I/O box includes additional
interfaces such as digital inputs, digital outputs, analog inputs, RS232 interface, and Dallas/Maxim 1-wire
interface. The XT2500 is a versatile device that can include an optional Bluetooth interface for ELD applications
and optional internal battery and buzzer for driver behavior alerts. The XT2500 devices can be controlled through
various channels, ranging from simple system parameters to more complex device interpreter scripts, which offer
maximum customization as they are written completely by the customer.
1.2. MECHANICAL
Mechanical
Dimensions 2.63” x 1.49” x 1.06” (6.7 x 5.3 x 2.7 cm)
Weight 2 oz. (57 g)
Physical Connections J1962 (with adapters available)
Operating Temperature -25°C to 70°C (-13°F to 158°F)

XT2500 Product Manual
Page 5 | 92
CONFIDENTIAL AND PROPRIETARY
2. DEVICE SETUP
2.1. CONFIGURE DEVICE VIA PC (RS232 TO USB)
1. Connect the device to a variable power supply.
2. Set the power supply to output average 12 volts and verify the device is drawing current after it has
powered up (the device will automatically switch on when it receives power).
3. Open "Device Manager" on windows and click the drop-down next to "Ports (COM & LPT)".
4. Attach a USB to RS232 coverter (Ex. USB-RS232-0.0) cable to a port on the computer and pins 17 and 18 of
the 24-pin connector.
NOTE: A "USB Serial Device" and the associated COM number should appear under "Ports". If
nothing shows up, unplug the connection to the Device, flip it over, and plug it back in. Take
note of the COM port number.
5. Open Secure CRT and double-click on the session with the correct COM port number. This should connect
the device to the terminal.
6. Right-click the session and go to "Properties".
7. Ensure the following is set for the session:
a. Connection > Protocol > Serial
b. Connection > Serial > Baud rate > 115200
c. Terminal > Check Auto reconnect
d. Terminal > Emulation > Terminal [VT100]
8. Click "Okay".
NOTE: The device should now be connected to the terminal and commands can be sent.

XT2500 Product Manual
Page 6 | 92
CONFIDENTIAL AND PROPRIETARY
3. INTERFACES
3.1. UART
XT2500 devices include a 2-wire asynchronous serial interface (UART) operated through RS232 for communication
with a host device. RS232 interface is TIA/EIA-232-F compliant and will accept 0-5V signaling. The UART interface is
a 3.0V TTL interface conforming to the ITU-T V.24 recommendation, with CMOS compatible signal levels (0V for
low data bit or ON state and 3.0V for high data bit or OFF state). If the
lThe default baud rate is 115200 bits/s
lThe default frame format is 8N1 (8 data bits, no parity, 1 stop bit)
lThe interface does not support flow-control
The UART interface is active and requires no authentication by default. AES-128 challenge/response
authentication can be enabled by enabling the console-authentication bit in the firmware flags setting of the
device description.

XT2500 Product Manual
Page 7 | 92
CONFIDENTIAL AND PROPRIETARY
4. DEVICE CONFIGURATION
System parameters are designed to be non-volatile and have the ability to be updated through a serial
connection, USB, SMS, UDP and are used for many modules within the device. All system parameters (aka
configs, params) have a default value that can always be restored in case the device ends up in an unknown
state.
The following two commands will be most relevant when dealing with the following configurations:
l:rycfg -- Used to read a system configuration
l:wycfg -- Used to write a system configuration
When using either of these commands, you must specify what configuration slot you wish to read/write,
otherwise the console will default to the first slot (index[0]). In the case that the desired parameter does not have
a factory default setting (configs PCR, PCA, &GFN) the console will not default to the first slot unless it has
already been written.
Example:
:wycfg tmr 30 0
:OK
:rycfg dst
|dst[0]: addr:"us.address.com", port:1234 (0x4d2)
: OK

XT2500 Product Manual
Page 8 | 92
CONFIDENTIAL AND PROPRIETARY
4.1. APNS(APN)
The APN parameter contains settings for APN gateway, username, and password.
Configuration instances: 4
Command Type Syntax
SET Command
:wycfg apn[x] "<apn_name>" "<username>" "<password>"
Response
:OK
READ Command
:rycfg apn[x]
Response
| apn[x]: name:"<apn_name>", user:"<username>", passwd:"<password>"
:OK
Parameter Range Description
apn_name 64 Char The name of the APN gateway used for GSM, GPRS, 3G and 4G cellular
networks. Examples of APN's are as follows:internet.t-mobile, wap.cingular,
internet.mnc012.mcc345.gprs
If instances 1 to 3 are configured as "disabled", the given slot will be skipped
during APN hunting procedures.
NOTE: For 4G AT&T modules, a blank APN configuration triggers a network-
pushed APN.
username 32 Char The username used to access the APN given by the first argument.
password 32 Char The password used to access the APN given by the first argument.

XT2500 Product Manual
Page 9 | 92
CONFIDENTIAL AND PROPRIETARY
4.2. OBD ACCEL AND DECEL (OAD)
Configuration instances: 2
Command Type Syntax
SET Command
:wycfg oad[x] <rate>
Response
:OK
READ Command
:rycfg oad[x]
Response
| oad[x]: accdec:<rate> (hex_val)
:OK
Parameter Descriptions
rate rate is measured in .1 mph
Instance Range Description
oad[0] 10 to 200 OBD acceleration threshold.
Speed rate of change to exceed on acceleration to
declare Hard Acceleration Event
oad[1] 10 to 200 OBD deceleration threshold.
Speed rate of change to exceed on deceleration to
declare Hard Deceleration Event

XT2500 Product Manual
Page 10 | 92
CONFIDENTIAL AND PROPRIETARY
4.3. OBD RPM AND SPEED EVENTS (ORS)
Configuration instances: 2
Command Type Syntax
SET Command
:wycfg ors[x] <threshold> <time sec>
Response
:OK
READ Command
:rycfg ors[x]
Response
| ors[x]: thresh:<threshold> (hex_val), time:<time sec> (hex_val)
:OK
Instance Description
ors[0] RPM Threshold
Parameter Range Description
threshold 0 (disable), 100
to 20000
RPM in 1 rpm to exceed
time sec 1 to 60 Time RPM must be greater than threshold to
declare an RPM Exceeded Event
ors[1] Speed Threshold
Parameter Range Description
threshold 0 (disable),
20 to 150
Speed in 1 mph to exceed
Time sec 1 to 60 Time Speed must be greater than threshold to declare
a Speed Exceeded Event

XT2500 Product Manual
Page 11 | 92
CONFIDENTIAL AND PROPRIETARY
4.4. OTA PREVENT (OTA)
Configuration instances: 1
Command Type Syntax
SET Command
:wycfg ota <enable_mask>
Response
:OK
READ Command
:rycfg ota <enable_mask>
Response
| ota: enable:<enable_mask>
:OK
Parameter Description
enable_mask Hex Description
0x0 OTA is not prevented due to OBDCommunications state or TPS Transfer
0x1 Prevent OTAwhen OBD Communications are Active (OBD
Communications detected)
0x2 Prevent OTAwhen TPS Transfer is Active (TPS Transfer is in progress)

XT2500 Product Manual
Page 12 | 92
CONFIDENTIAL AND PROPRIETARY
4.5. BLUETOOTH ENABLED (BLT)
The Bluetooth Enabled configuration sets the Bluetooth communication state.
Configuration instances: 1
Command Type Syntax
SET Command
:wycfg blt <enable>
Response
:OK
READ Command
:rycfg blt
Response
|blt: en:<enable> (hex_val)
:OK
Param Description
enable Enables Bluetooth:
Value Description
0 Disables bluetooth communications
1 Enables bluetooth communications

XT2500 Product Manual
Page 13 | 92
CONFIDENTIAL AND PROPRIETARY
4.6. BUZZER SONGS (BZR)
The Buzzer Songs configuration sets the frequency and duration of up to 8 notes on the device buzzer.
Configuration instances: 10
Command Type Syntax
SET Command
:wycfg bzr[x] <frequency1> <duration1> ... <frequency8> <duration8>
Response
:OK
READ Command
:rycfg bzr[x]
Response
| bzr[x]: freq1:<frequency1> (hex_val), dur1:<duration1> (hex_val), ...
freq8:<frequency8> (hex_val), dur8:<duration8> (hex_val)
:OK
Param Range Description
frequencyX 0 to 65535 A frequency that corresponds to the Xth note to be played (Hz); 0 is silent.
durationX 0 (disable),
10-6535
The duration of the Xth note to be played (ms)
4.7. DESTINATION (DST)
The dst[9] instance is utilized for all Device Manager interactions, including device Checkin Messages; configure
accordingly.
Configuration instances: 10
Command Type Syntax
SET Command
:wycfg dst[x] "<ip>|<hostname>|<local serial>" <port_number>
Response
:OK
READ Command
:rycfg dst[x]
Response
|dst[x]: addr:"<ip>|<hostname>|<local serial>" port:<port_number> (hex_val)
:OK

XT2500 Product Manual
Page 14 | 92
CONFIDENTIAL AND PROPRIETARY
Parameter Range Description
<ip>|<hostname>|
<local serial>
64 Characters This id is the location specified by the dst. It can take the form of
an IP address (192.0.0.0), a hostname limited to 64
characters,or a local serial port. The valid local serial ports are as
follows:
l"SERIAL_AUX0"
l"SERIAL_AUX1"
l"USB"
port_number 1 to 65533 If using an IP address or a hostname, can be used to specify the
port on which to connect.
4.8. GENERIC CONFIG VALUE (GCV)
Configuration instances: 64
Command Type Syntax
SET Command
:wycfg gcv[x] <unsigned_long>
Response
:OK
READ Command
:rycfg gcv[x]
Response
| gcv[x]: value:<unsigned_long> (hex_val)
:OK
Parameter Range Description
unsigned_
long
0 to
4494967295
A generic configuration value accessible within a script.

XT2500 Product Manual
Page 15 | 92
CONFIDENTIAL AND PROPRIETARY
4.9. INPUT DEFAULT POLARITY (IDP)
lidp[0] -> PUD on user input 1
lidp[1] -> PUD on user input 2
lidp[2] -> PUD on user input 3
lidp[3] -> PUD on user input 4
Configuration instances: 4
Command Type Syntax
SET Command
:wycfg idp[x] <pullup_disable>
Response
:OK
READ Command
:rycfg idp[x]
Response
| idp[x]: polrty:<pullup_disable> (hex_val)
:OK
Parameter Range Description
Input active
level
0 to 1 Sets the corresponding user input "active" level by engagingan external
pullup ('0') or pulldown ('1') oncorrespondingthatuser input.
An idp setting of '1' means the user input is configured active high, so the
user input is pulled down when not driven by external influences.
An idp setting of '0' means the user input is configured active low, so the user
input is pulled up when not driven by external influences.

XT2500 Product Manual
Page 16 | 92
CONFIDENTIAL AND PROPRIETARY
4.10. MOTION SENSITIVITY (MST)
Configuration instances: 1
Command Type Syntax
SET Command
:wycfg mst <motion_sensitivity_value>
Response
:OK
READ Command
:rycfg mst
Response
| mst: motion:<motion_sensitivity_value> (hex_val)
:OK
Parameter Range Description
motion_
sensitivity_
value
1 to 2000 Configure accelerometer motion sensitivity in thousandths of a unit of
gravity.
4.11. SERIAL PORT SETTINGS (SPS)
lsps[0] -> Aux port 0
lsps[1] -> Aux port 1
Configuration instances: 2
Command Type Syntax
SET Command
:wycfg sps[x] <baudrate> <dps_value> <mode_value> <console_print>
Response
:OK
READ Command
:rycfg sps[x]
Response
|sps[x]: baud:<baudrate> (hex_val), dps:<dps_value> (hex_val), mode:<mode_value>
(hex_val), conprt:<console_print> (hex_val)
:OK

XT2500 Product Manual
Page 17 | 92
CONFIDENTIAL AND PROPRIETARY
Parameter Range Description
baudrate N/A Acceptable baudrates:
l115200 bit/sec
l57600 bit/sec
l38400 bit/sec
l19200 bit/sec
l9600 bit/sec
l4800 bit/sec
l2400 bit/sec
l1200 bit/sec
dps_value 3 Char Acceptable dps values: 8N1
Mode_value N/A Acceptable mode values:
Value Description
0 Console
3 Garmin
6 Aux Passthru -- Only one serial port can be an Aux Passthru
at any given time.
Console_print N/A Scripted console print from BuildAndSend() format
Value Description
0 (ASCII)
1 (Binary)

XT2500 Product Manual
Page 18 | 92
CONFIDENTIAL AND PROPRIETARY
4.12. TIMER DURATION (TMR)
Configuration instances: 32
Command Type Syntax
SET Command
:wycfg tmr[x] <Duration> <auto_start>
Response
:OK
READ Command
:rycfg tmr[x]
Response
| tmr[x]: sec:<Duration> (hex_val), flags:<auto_start> (hex_val)
:OK
Parameter Range Description
Duration 0 to
4294967295
The time that is set as the duration of the timer (s)
auto_start N/A Determines if the timer is set to start automatically or needs to be
manually started.
Index Description
0 Disables autostart
1 Enables autostart

XT2500 Product Manual
Page 19 | 92
CONFIDENTIAL AND PROPRIETARY
4.13. PACKET CREATION RECIPE (PCR)
Configuration instances: 128
Command Type Syntax
SET Command
:wycfg pcr[x] "<recipe_hex_string>"
Response
:OK
READ Command
:rycfg pcr[x]
Response
| pcr[x]: resipe_hex_string:"<recipe_hex_string>"
:OK
NOTE: This parameter does not have a factory default setting.
Parameter Description
recipe_hex_string Refer to Packet Creation Recipe for configuration details
4.14. THIRD-PARTY CONFIG VALUES (TPV)
Configuration instances: 1
Command Type Syntax
SET Command
:wycfg tpv <dst_index> <checkin_freq> <pid_list_1> <pid_list_2> <Flag_value>
Response
:OK
READ Command
:rycfg tpv
Response
| tpv: index:<dst_index> (hex_val), checkin:<checkin_freq> (hex_val), pidlst1:<pid_
list1>, pidlst2:<pid_list2>, flag:<Flag_value> (hex_val)
:OK
Parameter Range Description
dst_index 0 to 9 Destination config index that points to the Xirgo Gateway Server

XT2500 Product Manual
Page 20 | 92
CONFIDENTIAL AND PROPRIETARY
Parameter Range Description
checkin_freq 0 to 255 Time in hours for periodic check to gateway server
Pid_list_1 0x0 to
0xFFFFFFFF
Bit list for supported pids 1 to 32
Hex Description
0x8000000 Odometer (miles) (ppid 1 0x74)
0x4000000 Oil Life (%) (ppid 2 0x75)
0x2000000 TPMS LF (psi) (ppid 3 0x76)
0x1000000 TPMS RF (psi) (ppid 4 0x77)
0x0800000 TPMS LR (psi) (ppid 5 0x78)
0x0400000 TPMS RR (psi) (ppid 6 0x8E)
0x0200000 TPMS LRI (psi) (ppid 7 0x90)
0x0100000 TPMS RRI (psi) (ppid 8 0x90)
0x0080000 TPMS SPR (psi) (ppid 9 0x91)
0x0040000 Seatbelt D (ascii) (ppid 10 0x92)
0x0020000 Seatbelt P (ascii) (ppid 11 0x9c)
0x0010000 Fuel Level (%) (0x5A)
0x0008000 Airbag Lamp (ascii) (ppid 12 0x9d)
0x0004000 PRNDL (ascii) (ppid 13 0x9e)
0x0002000 Parking Brake State (ascii) (ppid 14 0x9F)
0x0001000 Parking Brake Lamp (ascii) (ppid 15 0xA0)
0x0000800 0x000001 (reserved)
Pid_list_2 0x0 to
0xFFFFFFFF
Bit list for supported PIDs (32 to 32) <reserved>
Flag 0 to 255 Reserved