Download Class GW1001: An Introduction to Xirgo Technologies XT

U
ni
t
y
Ge
ss
ire
tW le
v e r si
Class GW1001: An Introduction to
GWU-XIR-1001:
Xirgo Technologies XT-2000,
XT-2060, XT-2050
Device Introduction
1. The XT-2000 family of Products from Xirgo Technologies consists of the following three products:
a. XT-2000: 2G GPRS connectivity
b. XT-2060: 3G HSPA+ connectivity
c. XT-2050: 2G 1xRTT connectivity (Verizon and Sprint)
d. OBD II Interface: All devices in the XT-2000 family interface with the OBD II port on a
vehicle. It is via the OBD II port that these devices draw power, detect ignition status,
and read the vehicle information.
e. LED location and definition: All devices in the XT-2000 family have three (3) LEDs to
provide device status.
O
C
G
i. The “O” LED indicates the status of the OBD communication.
ii. The “C” LED indicates the status of the Cellular link.
iii. The “G” LED indicates the status of the GPS link
https://www1.gotomeeting.com/register/583538560
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
OBD LED (Orange)
Ignition OFFLED OFF
Ignition ON
LED flickers
Cellular LED (Blue)
XT-2000/2060
Cellular Modem Reboot
LED OFF
Searching for Cellular Network
Alternating on and off every 1/2 second
Cellular Network Lock
Blinking briefly once every 3 seconds
Cellular Connection Failed
Alternating on and off every 1/2 second
XT-2050
Cellular Modem Reboot
LED OFF
Searching for Cellular Network
Blinking on and off rapidly
Cellular Network Lock
Alternating on and off every 1 second
Cellular Connection Failed
Blinking on and off rapidly
GPS LED (Green)
Searching for Satellite
Solid
GPS LockBlinking
2. SIM install process
a. XT-2000:
i. Locate the SIM card cover. It is located on the opposite side of the OBD II
plug and is labeled as below.
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
2
ii. Remove the SIM card cover by using a small flat screwdriver or your finger
nail. On both sides of the SIM card cover, there is a slot in the center to
insert a small flat screwdriver and pop the cover out.
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
Slot to pull the cover out using
flat screwdriver or finger nails
iii. Place the SIM card in the cover – positioning it as shown below. This will ensure
the SIM card is oriented correctly.
Unique cut shape
iv. Replace the SIM card cover using the two rails on the opposite side of the SIM
card cover to guide the SIM card into the slot. Press the SIM card cover back into
the device and press until it is flush with the device.
Fully seated
Installing
b. XT-2060:
i. Locate the SIM card cover. It is located on the opposite side of the OBD II plug
and is labeled as below.
ii. Remove the SIM card cover by using a small flat screwdriver or your finger nail. On both sides of the SIM card cover, there is a slot in the center to insert a small flat screwdriver and pop the cover out.
Slot to pull the cover out using
flat screwdriver or finger nails
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
3
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
iii. Place the SIM card into the device as shown below.
iv. Replace the SIM card cover using the two rails on the opposite side of the SIM
card cover to guide the SIM card into the slot. Press the SIM card cover back
into the device and press until it is flush with the device.
c. XT-2050:
i. Even though there may be a SIM card slot with a cover on some of the earlier
XT-2050 devices, it has no function. These are CDMA devices and do not use a
SIM card. Please ignore the SIM card slot on the XT-2050 if it is present. Later
versions of the XT-2050 will not have a SIM card slot.
3. Plug the XT-2000 Series device into the OBD II port of the vehicle. If the device is functioning
properly and there is an active data plan assigned to the device (or an active SIM card installed
in the device), the LED behavior observed after about 1 minute should be as follows:
a. XT-2000/2060:
i. The Orange OBD “O” LED should be “off” when the ignition is off and flickering
when the ignition is on.
ii. The Blue Cellular “C” LED should be blinking briefly once every 3 seconds –
indicating that the modem is connected to the network and able to at least pass
SMS messages.
iii. The Green GPS “G” LED should be blinking indicating a GPS lock.
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
4
b. XT-2050:
i. The Orange OBD “O” LED should be “off” when the ignition is off and flickering
when the ignition is on.
ii. The Blue Cellular “C” LED should be alternating on and off every 1 second –
indicating that the modem is connected to the network and able to pass both
SMS messages and IP traffic.
iii. The Green GPS “G” LED should be blinking indicating a GPS lock.
Provisioning XT-2000, XT-2060 and XT-2050 devices
1. The XT-2000 and XT-2060 devices have the ability to receive and send SMS message once an
active SIM card is installed and the Blue Cellular “C” LED is blinking once every 3 seconds. IP
data traffic / reports cannot be sent from these devices until the APN has been set appropriately
for the SIM card installed using the appropriate SMS command.
2. The XT-2050 is a CDMA device and thus does not use a SIM card. Once the MEID number of
the device is assigned to an active data plan, the device will automatically provision upon powerup and pass both SMS messages and IP data traffic / reports.
Device Configuration: SMS and IP based Reporting
1. The XT-2000, XT-2060 and XT-2050 devices are configured using “+XT” commands. If the device has an active data plan, these commands can be sent to the device via SMS. If
using a Xirgo OBD programming test fixture, connected to a PC via USB, these commands can
be sent locally to the device via a Telnet session. The commands are the same whether being
sent via SMS or a Telnet session, and for the purposes of this document, we’ll assume they are
being sent via SMS.
2. When configuring Xirgo devices via SMS “+XT” commands, the device will respond with a
confirmation message indicating that it accepted the command. Unfortunately it will not
automatically send this response to the cell phone number from which the command was sent.
Instead, the cell phone number to which SMS command confirmation messages will be sent
needs to be defined using the “+XT:1008” command. After setting this number, all SMS command confirmation messages will be sent to this phone number regardless of the phone
number of the device from which they were sent. The protocol for +XT:1008 command is as
follows:
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
+XT:1008,8053779844 (The phone number following the comma is where you want the
Xirgo device to reply back to).
The successful reply to this command will be $$359134032774006,1008,8053779844##
An “error” in the reply indicates that the command format was not recognized. Once you have set the SMS reply number to your cell phone number, you can now send other
commands to the device via SMS per the device protocol documentation and expect to
receive a confirmation from the device that the command was accepted.
3. Send the +XT:1007 command to query the firmware version of the device. This will dictate the
version of data protocol document to be referenced to program the device. Each data protocol
document lists the firmware version for which it applies on the first page as shown below.
Communication Specification and Data Format for
XT-2000-G-X001
Revision 1.0 H
Supports Firmware Revision X001-1111G1
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
5
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
4. Send the +XT:1001 command to set the IP address and port for IP data packet reporting along
with the data packet type. The protocol for this command is as follows – using the most current
firmware:
Command: “+XT:1001,<PP>,<IP>,<TU>[,<PR>[,<PDPT>]]”- Sets Port, IP address and TCP or
UDP
Example: “+XT:1001,10005,166.156.237.236,3,0,0”
o Response (via SMS): $$<UID>,<1001>,<PP>,<IP>,<TU>,<PR>,<PDPT>##
_ <PP> is a numeric port number between 0 and 65,535
_ <IP> is an IP address in the form YYY.YYY.YYY.YYY or a DNS name
_ <TU> is TCP or UDP protocol: <TU>=1 TCP, <TU>=2 UDP, <TU>=3 UDPwAck, <TU>=4 UDPC
_ <PR> is de-activate PDP on call counter and activate on next call event, > 1, 1 increments, 0 =
disable, 40 max
_ <PDPT> is the PDP timeout in minutes, >= 30 minute, 1 minute increments, 0 = disable, 43200
max
_ UDPwAck mode is described in Appendix 1
_ UDPC is the same as UDP (w/o Ack) except allows server commands sent via UDP (SMS cmd
still supported).
_ In UDPC mode the server must use the last known IP and port from the device based on most
recently received message.
_ If UDPC is selected <PR> should be set to 0
_ UDPC mode not available for GSM type A devices (see 1007)
5. Send the +XT:1002 command to set the APN of the SIM card (along with the APN user
name and password if applicable). The protocol for this command is as follows:
Command: “+XT:1002,<USN>,<PWD>,<NAME>”- Sets APN, username and password
Example: “+XT:1002,,,isp.cingular”
o Response (via SMS): $$<UID>,<1002>,<USN>,<PWD>,<NAME>##
_ <USN> is APN user name, blank if not applicable
_ <PWD> is APN password, blank if not applicable
_ <NAME> is APN name
6. To query the settings defined by the +XT:1001 and +XT:1002 commands, send the +XT:1003
command. The protocol for this command is as follows:
Command: “+XT:1003”- Query network settings
o Response (via SMS, UDPC):
$$<UID>,<1003>,<PP>,<IP>,<USN>,<PWD>,<NAME>,<SM>,<TU>,<DCE>,<DCT>,<PR>,<PD
PT>##
_ <SM> is server SMS number
7. The settings defined in the +XT:1001, +XT:1002 and +XT:1008 commands can be sent in one
single command using the +XT:1010 command. The protocol for this command is as follows:
Command:”+XT:1010,<PP>,<IP>,<USN>,<PWD>,<NAME>,<SM>,<TU>,<DCE>,<DCT>[,<PR>[,<
PDPT>]]”- Sets Port, IP address, Username, Password, APN, SMS number, Protocol and DNS
interval
o Response (via SMS):
$$<UID>,<1010>,<PP>,<IP>,USN>,<PWD>,<NAME>,<SM>,<TU>,<DCE>,<DCT>,<PR>,<PDPT>##
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
6
t
y
U
ni
An Introduction Xirgo Technologies XT-2000, XT-2060, XT-2050
ss
Ge
ire
tW le
v e r si
Device Configuration: Event triggered reporting
Once the device has been configured to send IP data packet reports, the events that will
trigger IP data reports can be defined and programmed.
1. The +XT:3001 and 3002 commands are used to send data reports for when the vehicle is in a
state of “Ignition On” and “Ignition Off” respectively. These are the most common event or
state based reports, and as of the latest firmware build, the Ignition On report can be
configured to report as often as once every 30 seconds. The protocol for +XT:3001 and
+XT:3002 commands are as follows:
Command: “+XT:3001, <ONI>,<ONA>”- Sets Ignition ON reporting interval and alert
Example: “+XT:3001,0.5,1”
o Response (via SMS, UDPC): $$<UID>,3001,<ONI>,<ONA>##
_ <ONI> is periodic Ignition On interval in minutes: > 0.5 min, 0.5 min increments, 0 = disable,
43200 max
_ <ONA> is Ignition On alert enable/disable: 0 = disable alert message, 1 = enable alert message
_ EV# 4001 is squelched if idle (Ref: 3013) is enabled and detected
_ Periodic reporting event message for Ignition ON is EV# 4001.
_ Alert message for Ignition ON is EV# 6011.
Command: “+XT:3002, <OFI>,<OFA>”- Sets Ignition OFF reporting interval and alert
Example: “+XT:3002,10,1”
o Response (via SMS, UDPC): $$<UID>,3002,<OFI>,<OFA>##
_ <OFI> is periodic Ignition Off interval in minutes: > 10 min, 5 min increments, 0 = disable,
43200 max
_ <OFA> is Ignition Off alert enable/disable: 0 = disable alert message, 1 = enable alert message
_ Periodic reporting event message for Ignition OFF is EV# 4002.
_ Alert message for Ignition OFF is EV# 6012.
Note: Each of these commands generates two types of reports. For the +XT:3001 command,
the data report with ID #6011 indicates the state of the device just changed to “Ignition On”, and
the data report with ID #4001 is the periodic report that is sent per the periodicity defined by the
user. For the +XT:3002 command, the data report with ID #6012 indicates the state of the device
just changed to “Ignition Off”, and the data report with ID #4002 is the periodic report that is sent
per the periodicity defined by the user.
2. Using similar commands defined in the XT-2000 family data protocol documents, additional
events such as the following can be configured to trigger IP data reports.
a. Change in Direction Report
b. Speed Threshold Report
c. RPM Threshold Report
d. Mileage Threshold Report
e. Acceleration/Deceleration Report
f. Diagnostic Trouble Code Alerts
g. +XT:7001 to read and report vehicle position immediately
h. Geo-fence polygon indices locations and more
20130702 Rev 1.0
https://www1.gotomeeting.com/register/583538560
7