Sierra Wireless SXL1FLEX Users Manual
SXL1 Asset Tracking Solution
5116-21-00772| Revision 1.0
1 | Page
Proprietary and Confidential Revised 10-11-11
2 | Page
Proprietary and Confidential Revised 10-11-11
Table of Contents
SXL1 .................................................................................................................................................5
Connecting the SXL1 to the Computer .................................................................................................5
SXL1_Programmer Software ...............................................................................................................5
Standard Reporting Tab ...............................................................................................................7
Motion Reporting Tab................................................................................................................. 10
Triggered Reporting Tab .............................................................................................................11
Testing Tab ............................................................................................................................... 12
Info Tab .....................................................................................................................................13
Profiles Tab ............................................................................................................................... 14
Operational Standards ...................................................................................................................... 14
Mounting Pro visions ...................................................................................................................14
Power Standards Outline ...................................................................................................................14
New Battery Installation.............................................................................................................. 15
Battery Replacement.................................................................................................................. 15
Battery Counter Reset ................................................................................................................ 15
Battery Voltage .......................................................................................................................... 15
Battery Low Threshold ................................................................................................................ 15
Power Supply / Battery Life .........................................................................................................15
Configuration Connector..................................................................Error! Bookmark not defined.
USB Port ........................................................................................Error! Bookmark not defined.
Environmental Performance Standards ...................................................Error! Bookmark not defined.
SXL1 Serial Message Protocol .......................................................................................................... 16
Serial Protocol.................................................................................................................................. 16
Serial CRC Algorithm ................................................................................................................. 17
Serial Sensor Messages Supported................................................................................................... 17
Remote Data Command (message type 0x04) ....................................................................................18
Remote Sensor Alarm Command (message type 0x05) ...................................................................... 18
SXL1 On -Air Message Protocol .........................................................................................................18
Location Message Format ................................................................................................................. 19
Message Type (Byte 1) .............................................................................................................. 19
Position (Bytes 2-8).................................................................................................................... 20
Status (Byte 9) ...........................................................................................................................20
Battery Status (Bits 2:0).............................................................................................................. 20
Report Mode (Bit 3).................................................................................................................... 20
Alarm Indication (Bit 4) ............................................................................................................... 20
Message Cause (Bits 8:5)........................................................................................................... 20
Engine Run Time (Bit 9) ............................................................................................................. 21
Configuration Change (Bit 10)..................................................................................................... 21
Message Count (Bits 13:11) ........................................................................................................21
Motion State (Bit 14) .................................................................................................................. 21
GPS 2D/3D (Bit 15).................................................................................................................... 21
Remote Message ............................................................................................................................. 21
Termination Message ........................................................................................................................22
Engineering Message ....................................................................................................................... 22
Message Type ........................................................................................................................... 23
GPS Mean Search Time (Byte 2) ................................................................................................ 23
# GPS Fails (Byte 3) .................................................................................................................. 23
# Transmissions (Bytes 4:5)........................................................................................................ 23
HW Configuration (Byte 6, bits 7:5) ............................................................................................. 23
Configuration Change (Byte 6 bits 4:2) ........................................................................................ 23
Termination Reset (Byte 6 bit 1).................................................................................................. 24
3 | Page
Proprietary and Confidential Revised 10-11-11
Motion Status (Byte 6 bit 0) .........................................................................................................24
Message Cause (Byte 7 bits 7:6) ................................................................................................ 24
Engine Run Time (Byte 7:8)........................................................................................................ 24
Reserved (Byte 7 bits 5:0 and Bytes 8:9)..................................................................................... 24
Regulatory Approvals ........................................................................................................................24
Labeling and Marking........................................................................................................................ 24
Unit ID....................................................................................................................................... 24
Appendix A: Regulatory Notices .........................................................................................................25
Appendix B: Calculating Lat / Long .................................................................................................... 26
Calculating Lat / Long from SXL1 Messages .......................................................................................26
Appendix C: SXL1 Data Interface...................................................................................................... 28
Scope .............................................................................................................................................. 28
Transport Layers .............................................................................................................................. 28
Data Formats ................................................................................................................................... 28
Tracker XML Description ............................................................................................................28
Tracker XML Example................................................................................................................ 29
Delivery Methods .............................................................................................................................. 30
HTTP / HTTPS .......................................................................................................................... 30
SMTP (E-Mail) ........................................................................................................................... 30
SFTP ........................................................................................................................................ 30
Steps for Configuring the Datastream for an Asset in the FELIX Software Administration webs ite..........30
Queuing, VAR Back Office Acknowledgement, and Error Notifications ................................................. 33
Custom Defined Methods .................................................................................................................. 34
4 | Page
Proprietary and Confidential Revised 10-11-11
SXL1
The SXL1 is a small but fully self-contained, global satellite-based tracking device capable of
determining location using GPS and reporting the location over a low earth orbit (LEO) satellite
network. The SXL1 is powered by a field replaceable battery and requires no wiring or harnesses for
use.
The SXL1 communicates data via the Globalstar Simplex Data Service. This satellite service utilizes
low power, one-way transmitters to relay data from locations globally to a back office server
accessible over the internet through secure connection. The use of one -way, simplex satellite
communications is a proven, reliable method to inexpensively collect widely scattered asset data.
The device is speak only, so there is no way to communicate to the device in the field. This feature is
mitigated by a rich configuration capability that enables the SXL1 to automatically detect situations
where a data update is desired, such as start and stop or while in motion.
This Users Manual describes how the SXL1 is configured and the protocol for on-air data payload
and internet XML packets. This document provides a generalized overview only. Consult Numerex
for more details and options of relaying data.
Connecting the SXL1 to the
Computer
The SXL1 is availa ble in preconfigured
operational modes. These modes are
determined at point of manufacture or at OEM
depot distribution. Field configuration should
only be performed by installation specialists
to avoid configuration errors. Since the
device does not support over -the-air
configuration and must be connect using a
short range RF link , it is important the devices
are properly configured for use.
The SXL1 contains a short range RF
transceiver for setting the device for
operation. This transceiver communicates with a like transceiver in the SXL1 programming device.
The SXL1 programmer provides the interface for configuring the device using the SXL1_Programmer
setup tool available from Numerex.
The SXL1_Programmer software tool is designed to operate on a Microsoft Windows® XP -based
computer. The Microsoft .NET framework is also required to run the configuration setup software.
This is a default Windows® XP add -on, and may also be downloaded from www.microsoft.com
without charge.
A USB Type A cable coming from the SXL1 programmer (right) is used to connect to the computer
being used to configure the device. Connect the computer to the SXL1 programmer using the USB
cable, and then run the SXL1_Programmer software tool. The SXL1_Programmer software will
automatically begin searching for available SXL1 units.
SXL1_Programmer Software
The SXL1_Programmer is a Windows® executable software program designed to access and
configure the SXL1. The program can simply be copi ed to a directory on the computer.
5 | Page
Proprietary and Confidential Revised 10-11-11
When launched, the program will auto-detect a SXL1 programmer. If a programmer is detected
the SXL tab will appear along the top of the program window
The SXL1_Programmer tool is structured as a standard Windows application with tabs along the top
of the display area that groups similar configuration controls and displays. The bottom of the display
remains constant; showing the ESN of the connected SXL1, sleep mode indicator/control, and two
buttons used to read back a device configuration or write/configure a device for operation.
The “Sleep SXL1” button queries the configuration of the connected device (populating the dialog
boxes of the tool) and then places the device to sleep. This button is used to force a devi ce to sleep
without changing the configuration.
The “Run SXL1” button queries the configuration of the connected device (populating the dialog
boxes of the tool) and then places the device into run mode. This button is used to force a device to
run using the pre -configured settings.
The “Sleep Mode” checkbox is used to select the operating mode of the device subsequent to
configuration. If checked, a unit is left in low-power sleep mode following programming. If
unchecked, the device is left in run-mode following programming. If a device is read for configuration,
the sleep mode checkbox will reflect the current state of the device being queried.
The “Read SXL1” button queries the device connected for configuration. The current configurations
held in the dialog boxes of all the tabs will be overwritten by the settings of the device being queried.
The “Program” button configures the device connected using the dialog boxes of all the tabs. The
button may be used repetitively on subsequent units to configure a set of devices identically.
When a device is connected to the computer and read, the SXL1_Programmer panel will show the
ESN in the lower left corner.
When the program is started the dialog boxes are initialized to the manufactured standard
configuration. If a device is read after being connected to the computer the dialog boxes are
populated with the device configuration. Connecting to a device after the program is launched will not
change the dialog boxes .
6 | Page
Proprietary and Confidential Revised 10-11-11
SXL Tab
The “SXL” tab only appears if the program detects that a SXL1 programmer is attached
to the computer. The SXL tab contains functions specific to the RF link between the
transceiver in the SXL1 and the SXL1 programmer.
When the program is first opened and it detects a SXL1 programmer, it will initiate a
scan for SXL1 devices within its RF range. The scan will last approximately 7.5 seconds.
If the ESN of the desired SXL1 does not show up in the discovered SXLs dialog box
there are 2 ways to try acquire a RF link with it. The first is to click the “Rescan” button.
This will start another 7.5 second scan for available devices. If the ESN is known it may
be typed into the lower dialog box and the “Add ESN(s)” button is clicked. This causes
the programmer to try and talk specifically to the specified device. Once the device is
found it will show up in the dialog box with the Status of connected listed next to it.
Click on the ESN that you would like to configure.
If the desired profile is currently being displayed by the setup tool and there are more
than one SXL1 that needs to be configured with this profile, click and drag down,
highlighting all of the devices to be configured. Once the devices are high lit, click the
“Program” button to configure them all at the same time.
7 | Page
Proprietary and Confidential Revised 10-11-11
Standard Reporting Tab
The “Standard Reporting” tab is used to configure the device for routine position reporting. The SXL1
can be configured to report on a time delay between reports (Standard Interval) or at a specific time
of day (Time of Day). The pull down dialog box is used to select one or the other mode.
Or
Note that if Standard Interval is selected, the user may use the “Days, Hours, Minutes” controls to set
the amount of time between a standard location report. If “Time of Day” is selected, the “Days”
control is not available, the user is prompted to select the hour and minute of the day for reporting.
The device will wake once a day at this time to perform the standard report. Time of Day is provided
in UTC (GMT) format only. Displayed below the UTC setting is the correlating time of your current
time zone as set by your computer. If enabled for Time of Day, the user should specify the time at
Greenwich Mean Time for operation.
8 | Page
Proprietary and Confidential Revised 10-11-11
Note: When programming
SXL1
for Time of Day reporting:
Programming for Time of Day mode within 1 hour of the scheduled time will result in the first days
message being pushed out 24 hours. Also, if the device time is not current, the first time of day event may
take a complete 24 hours from time of program to complete. Users should thus allow up to 48 hours for
the unit to begin reporting on schedule.
Time of day reporting mode is set in UTC. Displayed below the UTC setting is the correlating time of your
current time zone as set by your computer.
The Subsequent Message function is configured using the Subsequent dialog entry boxes:
Subsequent Messages are sent following the Standard report. The “Subsequent Messages” dialog
configures the count of messages to be sent subsequent to the standard report. The “Subsequent
Message Interval” sets the time in hours and minutes between subsequent reports.
For example, a device configured to report daily at 8 AM and hourly thereafter for 6 hours would be
configured as:
9 | Page
Proprietary and Confidential Revised 10-11-11
Also, on the Standard Interval tab is the dialog to configure the Engineering Message. The
Engineering Message is a transmitted message containing data related to the health and operation of
the SXL1. It is advisable to send the Engineering Message routinely, typically monthly or bi-weekly.
The Engineering message interval may also be configured for time of day operation. This is useful,
for example, when requiring a daily count of engine runtime.
Motion Reporting Tab
The “Motion Reporting” tab is used to configure the device for detecting and reporting while in motion.
The Motion Reporting Mode pull down dialog box is used to select one of four modes of motion
detection and operation:
Disabled: Disabled mode configures the device to do nothing regarding motion. The Sensitivity and
Stop Time dialogs are ignored.
Start Only: Start Only mode configures the device to detect start of motion and report. The
Sensitivity sets the device for low, medium and high sensitivity. Stop Time set s the amount of time in
minutes that the unit does not detect motion, before the device drops out of motion. The Start Time
sets the amount of time in minutes that the unit detects motion, before the device reports in motion.
As with the Standard reporting function, the device may be configured to report subsequently
following motion start detection. For example, a device may be configured to detect motion start and
report every 30 minutes subsequently for 4 reports.
Start / Stop: Start / Stop mode configures the device to detect start or stop of motion and report.
The Sensitivity and Start and Stop Time configurations are as described earlier. The device only
reports start and stop of motion. No subsequent reporting is configurable in this motion mode.
10 | Page
Proprietary and Confidential Revised 10-11-11
In Motion: In Motion mode configures the device to detect start and stop of motion and report at a
set interval while remaining in motion. The Sensitivity and Start and Stop Time configurations are as
described earlier. The Subsequent Message Interval controls set the time between reports while the
unit remains in motion. The Subsequent Message dialog (count) is ignored.
Triggered Reporting Tab
The “Triggered Reporting” tab is used to configure the device for alarm detection and reporting. The
SXL1 has two integral alarms that may be configured, magnet reed switch.
The magnet reed switch detects the presence or removal of the magnet inserted in the top of the
SXL1 enclosure. Removal of the magnet while the device is asleep will initiate operation of the
device. Action on reinsertion/removal of the magnet is configurable. Three modes of operation are
supported for magnet function while the device is in run mode.
Disable: Disable magnet mode configures the device to ignore any magnet reinsertions or removals
while in run mode.
Resume Sleep: Resume Sleep magnet mode configures the device to return to low-power sleep
state when the magnet is inserted for 15 seconds. This mode configures the device to use the
magnet as an on/off switch. Off when the magnet is inserted and on when it is removed.
11 | Page
Proprietary and Confidential Revised 10-11-11
Loading...