User Manual:
GSM0000PB003MAN
Enfora Event Tool
User Manual
Revision 1.00
Confidential and Proprietary Information - © 2003 Enfora, Inc.
Do not duplicate without express permission from Enfora, Inc.
Enfora Event Tool User Manual
Document Title:
Enfora Event Tool User Manual
Version:
1.00
Date:
6/4/03
Status:
Released
Document Control ID:
GSM0000PB004MAN
General
All efforts have been made to ensure the accuracy of material provided in this document
at the time of release. However, the items described in this document are subject to
continuous development and improvement. All specifications are subject to change
without notice and do not represent a commitment on the part of Enfora, Inc. Enfora,
Inc. will not be responsible for any loss or damages incurred related to the use of
information contained in this document.
This product is not intended for use in life support appliances, devices or systems where
a malfunction of the product can reasonably be expected to result in personal injury.
Enfora, Inc. customers using, integrating, and/or selling this product for use in such
applications do so at their own risk and agree to fully indemnify Enfora, Inc. for any
damages resulting from illegal use or resale.
Copyright
©2002, 2003 Enfora, Inc. All rights reserved.
Enabler and Spider are either registered trademarks or trademarks of Enfora, Inc. in the
United States.
This manual is copyrighted. All rights reserved. No portion of this document may be
copied, photocopied, reproduced, translated, or reduced to any electronic medium or
machine form without prior consent in writing from Enfora, Inc.
© 2002, 2003 Enfora, Inc. All rights reserved.
The information in this document is subject to change without notice and does not
represent a commitment on the part of Enfora, Inc.
All product names mentioned within this document are the trademark of their respective
owners.
Adobe® Acrobat Reader, © 1987-1999 Adobe Systems Inc. All rights reserved.
Adobe and Acrobat are trademarks of Adobe Systems Inc.
GSM0000PB004MAN
1
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Enfora, Inc.
661 East 18th Street
Plano, Texas 75074-5601
USA
www.enfora.com
Enfora, Inc. Proprietary Information
GSM0000PB004MAN
GSM0000PB004MAN
2
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Revision History
Date
6/2/03
Rev
1.00
Author
M.Glover
GSM0000PB004MAN
Description
Initial Release.
3
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Table Of Contents
1
Introduction..............................................................................................................................6
About this Manual.......................................................................................................................6
2 System Requirements ...........................................................................................................6
3 Event Tool Overview..............................................................................................................7
3.1
Basic Functionality .........................................................................................................7
3.2
Running the Event Tool .................................................................................................7
3.3
Running the Event Tool .................................................................................................8
4 Setup and Configuration........................................................................................................9
5 Event Definitions...................................................................................................................11
5.1
Input Events.......................................................................................................................11
5.2
Output Events ...................................................................................................................14
5.3
Result..................................................................................................................................16
5.4
Event Verify .......................................................................................................................17
6 Input Events...........................................................................................................................18
6.1
GPIO Input Event Selections......................................................................................18
6.1.1
GPIO Input Event Detail ......................................................................................18
6.2
Power Up Input Event Selection ................................................................................19
6.2.1
Power Up Input Event Detail...............................................................................19
6.3
GSM/GPRS Registration Input Event Selection......................................................19
6.3.1
GSM Registration Input Event Detail.................................................................19
6.3.2
GPRS Registration Input Event Detail ..............................................................19
6.4
Network IP Input Event Selection ..............................................................................19
6.4.1
Network IP Input Event Detail.............................................................................19
6.5
Network IP Input Event Selection ..............................................................................20
6.6
GPS Distance Input Event Selection (MT Only)......................................................20
6.7
GPS Maximum Velocity Input Event Selection (MT Only) .....................................20
6.8
GPS GeoFence Input Event Selection (MT Only)...................................................20
6.8.1
GPS GeoFence Input Event Type (MT Only) ..................................................20
6.9
GPS Satellite Fix Input Event Selection (MT Only).................................................20
6.9.1
GPS Satellite Fix Input Event Detail (MT Only) ...............................................20
6.10 Analog Input Event Selection .....................................................................................20
6.11 CMUX Power Save Input Event Selection ...............................................................21
6.12 MT-G Power Save Input Event Selection (MT Only) ..............................................21
6.13 Custom Input Event......................................................................................................21
6.13.1 Custom Input Event Type....................................................................................21
7 Output Events .......................................................................................................................22
7.1
GPIO Output Event Selections...................................................................................22
7.1.1
GPIO Output Event Detail ...................................................................................22
7.2
UDP API Message Output Event Binary Format.....................................................23
7.3
UDP API Message Output Event ASCII Format......................................................23
7.4
Event Timer Reset Output Event ...............................................................................24
7.5
Stored AT Commands Output Event.........................................................................24
8 Tech Support.........................................................................................................................25
GSM0000PB004MAN
4
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Table of Figures
Figure 1 - Event Tool Main Screen ........................................................................................................8
Figure 2 - Event Tool Configuration .......................................................................................................9
Figure 3 - Event Tool COM Port Setup Selection ....................................................................................9
Figure 4 - Event Tool COM Port Setup Screen .....................................................................................10
Figure 5 - Event Tool Input Event Category Selection ...........................................................................11
Figure 6 - Event Tool Input Event Detail Selection ................................................................................12
Figure 7 - Event Tool ADD Input Event ................................................................................................12
Figure 8 - Event Tool Multiple Input Conditions ....................................................................................13
Figure 9 - Event Tool Output Event Selection .......................................................................................14
Figure 10 - Event Tool Output Event Detail Selection ...........................................................................15
Figure 11 - Event Tool ADD Output Event............................................................................................15
Figure 12 - Event Tool Result Tab .......................................................................................................16
Figure 13 - Event Tool File Dialog Box.................................................................................................17
Figure 14 - Event Tool Event Verify Tab ..............................................................................................17
GSM0000PB004MAN
5
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
1
Introduction
About this Manual
Contained in this manual are instructions on how to use the Enfora Event Tool
application. The application is designed to facilitate the quick setup and configuration of
the Enfora event-processing engine. The capability of the core Enabler module provides
powerful event-driven processing that can monitor the General Purpose Input Output
(GPIO) interface along with certain network events. Additionally, this tool provides
support for the GSM/GPRS Spider SA (with GPIO interface) MT platform devices.
Please follow the instructions herein closely to insure proper configuration and operation.
Please refer to the following documents for detailed information related to event
processing capabilities.
GSM/GPRS Module and Spider SA platforms (with GPIO interface):
•
•
Enabler-G AT Command Set GSM0102PB001MAN
GSM0000AN015 - Event Monitor and Reporting Overview
GSM/GPRS Spider MT platforms:
•
•
2
Spider MT-G AT Command Set GSM2000PB001MAN
GSM2000AN007 - Spider MT-G Event Monitor and Reporting Overview
System Requirements
•
•
•
Windows 98 SE / XP / NT 4.0 (Service Pack 6)/2000 Professional
One standard RS-232 serial port
An Enfora GSM/GPRS Enabler or Enabler-based product like the Spider SA or
MT.
GSM0000PB004MAN
6
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
3
Event Tool Overview
3.1
Basic Functionality
The event tool application provides support for the AT$EVENT command supported
in various Enfora GSM/GPRS products. The AT command provides multiple options
for configuration and can prove to be complicated if not understood completely. The
event tool provides a graphical interface that allows the user to accomplish the
following:
•
•
•
•
•
•
•
3.2
Set event variables for input and output processing
Write defined events to the modem
Read defined events from the modem
Write defined events to a file
Read defined events from a file
Delete selected events
Delete all events
Running the Event Tool
Prior to running the event tool, make sure that your modem is connected via a
serial connection and is powered and communicating properly.
The event tool is a stand-alone executable application. Once it resides on a
computing platform, it can simply be double-clicked to initiate.
GSM0000PB004MAN
7
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
3.3
Event Tool Layout
The following is the basic layout of the event tool.
Figure 1 - Event Tool Main Screen
Input Events - Used to define input events
Output Events - Used to define output events
Results - Display and read/write defined events
Event Verify - Delete events
GSM0000PB004MAN
8
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
4
Setup and Configuration
The event tool provides the ability to configure the COM port being used. To configure
the COM port, click on the icon in the upper left-hand corner of the application window.
Figure 2 - Event Tool Configuration
Select COM Port Setup (Figure 3 - Event Tool COM Port Setup Selection).
Figure 3 - Event Tool COM Port Setup Selection
GSM0000PB004MAN
9
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
A dialog box is provided to define the COM port (Figure 4 - Event Tool COM Port Setup Screen).
The port number, speed, data bits, parity, stop bits, and flow control can be defined.
These parameters must match the modem configuration.
Figure 4 - Event Tool COM Port Setup Screen
GSM0000PB004MAN
10
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
5
Event Definitions
The following will outline the process required to create and manage an event. Individual
application tab selections are explained.
!
5.1
Please note that the Event Group number defines the
grouping of event transactions. When implementing,
pay careful attention to the Group Number. Failure to
do so could potentially cause unpredictable results.
Input Events
By selecting the Input Event Category drop-down box (Figure 5 - Event Tool Input
a particular input event Selection can be made. Once
selected, the Input Event Detail can be chosen (Figure 6 - Event Tool Input Event
Detail Selection). Make sure that the appropriate Event Group is selected. Click
ADD to create the event (Figure 7 - Event Tool ADD Input Event). Once complete, the
Input Event Summary is provided. If a mistake has been made or an event is to
be eliminated, the DELETE button can be used once the event is selected.
Event Category Selection),
Multiple events can be used as qualifiers before a particular grouping is
considered complete. This is done by selecting the desired event and then
pressing the AND button (Figure 8 - Event Tool Multiple Input Conditions).
Figure 5 - Event Tool Input Event Category Selection
GSM0000PB004MAN
11
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Figure 6 - Event Tool Input Event Detail Selection
Figure 7 - Event Tool ADD Input Event
GSM0000PB004MAN
12
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Figure 8 - Event Tool Multiple Input Conditions
GSM0000PB004MAN
13
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
5.2
Output Events
Once an Input Event is defined, an Output Event definition is required. Select the
Output Event tab. By selecting the Output Event Category drop-down box
(Figure 9 - Event Tool Output Event Selection), a particular output event Selection can
be made. Once selected, the Output Event Detail can be chosen (Figure 10 Event Tool Output Event Detail Selection). Make sure that the appropriate Event Group
is selected. Click ADD to create the event (Figure 11 - Event Tool ADD Output Event).
Once complete, the Output Event Summary is provided. If a mistake has been
made or an event is to be eliminated, the DELETE button can be used once the
event is selected.
Figure 9 - Event Tool Output Event Selection
GSM0000PB004MAN
14
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Figure 10 - Event Tool Output Event Detail Selection
Figure 11 - Event Tool ADD Output Event
GSM0000PB004MAN
15
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
5.3
Result
Once the Input triggers are selected and the resulting output action defined, the
entire event can be viewed. Select the Result tab to view the entire event
definition (Figure 12 - Event Tool Result Tab). The event is described and the
associated AT commands applied to the modem are presented. From this
screen, the events can be written to the modem, written to the modem and saved
to non-volatile memory, or written to a file. This screen can also be used to read
events from an existing file that has previously been saved.
The Next Event Group button can be used to cycle through the event groups that
have been defined. The Save Events in Modem’s Non-Volatile Storage
checkbox will need to be selected if the events are to be saved to memory. This
will allow the events to survive a modem power cycle.
The Write to File and Read from File buttons can be used to designate a
location to write/read a file. A dialog box will be presented for these buttons
allowing for local designation of file location (Figure 13 - Event Tool File Dialog Box).
Figure 12 - Event Tool Result Tab
GSM0000PB004MAN
16
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
Figure 13 - Event Tool File Dialog Box
5.4
Event Verify
The Event Verify tab is used to manage defined events (Figure 14 - Event Tool Event
Events must be first written to the modem and then read by pressing
the Read Events from Modem button. The events will be listed will be presented
in the Modem Events List section of the screen. Events can then be individually
selected and deleted by pressing the Delete Selected Event button or all of the
defined events can be deleted by pressing the Delete All Events from the
Modem button.
Verify Tab).
Figure 14 - Event Tool Event Verify Tab
GSM0000PB004MAN
17
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
6
Input Events
The following input event categories are available:
•
•
•
•
•
•
•
•
•
•
•
•
•
GPIO Events
Power Up Events
GSM/GPRS Registration Events
Network IP Events
Timer Events
GPS Distance Events
GPS Maximum Velocity Events
GPS GeoFence Events
GPS Satellite Fix
Analog Input Events
CMUX Power Save Events
MT-G Power Save Events
Custom Events
6.1
GPIO Input Event Selections
The following GPIO input event selections are available:
•
•
•
•
•
•
•
•
6.1.1
GPIO 1
GPIO 2
GPIO 3
GPIO 4
GPIO 5
GPIO 6
GPIO 7
GPIO 8
GPIO Input Event Detail
The following GPIO input event detail options are available for all GPIO
lines:
•
•
•
•
•
GSM0000PB004MAN
Low-to-High Transition
High-to-Low Transition
Both Edge Transition
Low Level without Transition
High Level without Transition
18
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
6.2
Power Up Input Event Selection
•
N/A
6.2.1
Power Up Input Event Detail
•
6.3
Modem Power-Up
GSM/GPRS Registration Input Event Selection
•
•
GSM Registration
GPRS Registration
6.3.1
GSM Registration Input Event Detail
•
•
•
•
•
•
•
•
6.3.2
GPRS Registration Input Event Detail
•
•
•
•
•
•
•
•
6.4
Idle
Trying
Registered Home Network
Registered Roaming
Registered
Registration Fail
Registered, no trigger
Trying, no trigger
Idle
Trying
Registered Home Network
Registered Roaming
Registered
Registration Fail
Registered, no trigger
Trying, no trigger
Network IP Input Event Selection
•
N/A
6.4.1
Network IP Input Event Detail
•
•
•
•
•
GSM0000PB004MAN
No IP
First IP
New IP
No IP, no trigger
Valid IP, no trigger
19
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
6.5
Timer Input Event Selection
•
•
•
•
•
6.6
Timer 1
Timer 2
Timer 3
Timer 4
All timer events have a timer period value in seconds
GPS Distance Input Event Selection (MT Only)
•
•
•
6.7
Minimum Time (seconds)
Maximum Time (seconds)
Distance (meters)
GPS Maximum Velocity Input Event Selection (MT Only)
•
6.8
Speed (knots)
GPS GeoFence Input Event Selection (MT Only)
•
•
•
•
GeoFence Area 1
GeoFence Area 2
GeoFence Area 3
GeoFence Area 4
6.8.1
GPS GeoFence Input Event Type (MT Only)
•
•
•
•
6.9
Entering GeoFence Area
Leaving GeoFence Area
Entering or Leaving GeoFence Area
Each event provides Latitude (Deg.deg), Longitude (Deg.deg),
and Radius (Meters)
GPS Satellite Fix Input Event Selection (MT Only)
•
N/A
6.9.1
GPS Satellite Fix Input Event Detail (MT Only)
•
•
6.10
Valid Fix
Invalid Fix
Analog Input Event Selection
•
•
•
Analog Input 1
Analog Input 2
Each event provides Minimum and Maximum values in millivolts
GSM0000PB004MAN
20
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
6.11
CMUX Power Save Input Event Selection
•
•
6.12
Entering Low Power Mode
Waking From Low Power Mode
MT-G Power Save Input Event Selection (MT Only)
•
•
6.13
Entering Low Power Mode
Waking From Low Power Mode
Custom Input Event
•
The custom input event selection allows custom definition of event
processing. It is recommended that the AT$EVENT command be
completely understood prior to using this feature.
6.13.1
Custom Input Event Type
•
•
•
•
•
GSM0000PB004MAN
Transition Trigger
Occurrence Trigger
Input Non-Trigger
Output
Each Event Type provides Event Category, Parameter 1, and
Parameter 2 values
21
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
7
Output Events
The following Output event categories are available:
•
•
•
•
•
•
GPIO Output
UDP API Message
UDP Acknowledge Message
UDP Broadcast Message
Event Timer Reset
Stored AT Commands
7.1
GPIO Output Event Selections
The following GPIO output event selections are available:
•
•
•
•
•
•
•
•
GPIO 1
GPIO 2
GPIO 3
GPIO 4
GPIO 5
GPIO 6
GPIO 7
GPIO 8
7.1.1
GPIO Output Event Detail
The following GPIO output event detail options are available for all
GPIO lines:
•
•
•
•
•
GSM0000PB004MAN
GPIO Output Low
GPIO Output High
GPIO Output Toggle
GPIO Output Flash
GPIO Output Flash provides High Duration (seconds),
Low Duration (seconds), and Toggle Count values
22
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
7.2
UDP API Message Output Event Binary Format
The following fields are available to include in a UDP API Message in binary
format. The following information is provided for the UDP API Message, UDP
Acknowledge Message, and UDP Broadcast Message formats.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
7.3
Message Number
Modem ID
GPIO
Analog 1
Analog 2
Store Message
Trigger Event
GPS Date
GPS Status
GPS Latitude
GPS Longitude
GPS Speed
GPS Heading
GPS Time
GPS Altitude
GPS Number of Satellites
The output message can provide a unique message number
UDP API Message Output Event ASCII Format
The following fields are available to include in a UDP API Message in ASCII
format. The following information is provided for the UDP API Message, UDP
Acknowledge Message, and UDP Broadcast Message formats.
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Message Number
Modem ID
GPIO
Analog 1
Analog 2
Store Message
Trigger Event
GPS NMEA GGA
GPS NMEA GLL
GPS NMEA GSA
GPS NMEA GSV
GPS NMEA RMC
GPS NMEA VTG
The output message can provide a unique message number
GSM0000PB004MAN
23
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
7.4
Event Timer Reset Output Event
•
•
•
•
7.5
Event Timer 1
Event Timer 2
Event Timer 3
Event Timer 4
Stored AT Commands Output Event
This feature allows stored AT commands to be executes based on a particular
input event. The following parameters are provided:
•
•
•
•
•
Stored AT Command 1
Stored AT Command 2
Stored AT Command 3
Stored AT Command 4
Stored AT Command 5
GSM0000PB004MAN
24
Version 1.00 – 6/4/03
Enfora Event Tool User Manual
8
Tech Support
For problems stemming from your network access, contact your GSM/GPRS carrier
service. For technical support and customer service dealing with the modem itself,
contact Enfora by any of the following methods:
Website:
http://www.enfora.com
Phone:
(972) 578-2373
Email:
techsupport@enfora.com
GSM0000PB004MAN
25
Version 1.00 – 6/4/03
Download PDF