Page 2
Antares SB GSM User’s Manual (FW 5.21) Digital Communications Technologies April 15, 2008...
Page 3
Special Note This manual applies to the GSM version of the Antares SB Firmware version This manual applies to firmware version 5.21 of the GSM version of the Antares SB . You can consult the unit’s firmware version with the...
Regulatory Compliance This product operates with Wavecom’s Q24PL transmitter. FCC Parts 22H and 24E are granted to the Wavecom Q24PL under FCC identifier O9EQ24PL001. The antenna gain, including cable loss, must not exceed 3 dBi at 1900 MHz / 1.4 dBi at 850 MHz for mobile operating configurations and 7 dBi at 1900 MHz / 1.4 dBi at 850 MHz for fixed mounted operations, as defined in 2.1091 and 1.1307 of the rules for satisfying RF exposure com- pliance.
Page 5
LIMITED WARRANTY Digital Communications Technologies warrants the original purchaser that for a period of three years from the date of purchase, the product shall be free of defects in materials and workmanship under normal use. During the warranty period, Digital Communications Technologies shall, at its option, repair or replace any defective product upon return of the product to its facilities, at no charge for labor and materials.
Page 6
Technologies be liable for any special, incidental, or consequential damages based upon breach of warranty, breach of contract, negligence, strict liability, or any other legal theory. Such damages include, but are not limited to, loss of profits, loss of the product or any associated equipment, cost of capital, cost of substitute or replacement equipment, facilities or services, down time, purchasers time, the claims of third parties, including customers, and injury to property.
Page 16
Contents 10 Appendix D - Quick TAIP reference 10.1 Setting the Antares SB ID ....232 10.2 Setting the APN ..... 232 10.3 Configuring the SIM card PIN .
Preface This document is the Antares SB User’s Guide. On this document you will find information on what is the Antares SB , its features, specifications, installation instructions and explanation on the unit’s configuration and operation. This document is available at: http://www.digitalcomtech.com...
0.3. TECHNICAL ASSISTANCE The TAIP reference chapter is a compendium of all the configu- ration and query commands, therefore it is the big complement of the Operation and Configuration chapters. The Quick Start Guide is a very condensed summary to get you started with the unit.
About the Antares SB The Antares SB is a vehicle tracking and controlling device designed to interact remotely with Automated Vehicle Location (AVL) systems or end-users by using the GSM/GPRS cellular network as commu- nication media. The Antares unit is installed on a vehicle whose geographical position and/or state is desired to be remotely moni- tored/controlled.
1.1. FEATURES 1.1.3 Optional Back-up Battery The Antares SB may include a built-in back-up battery to be used when the vehicle’s battery is unavailable. Refer to the Operation chapter for more information. 1.1.4 Voice support An audio jack for non-balanced hands-free audio system is provided to initiate and receive phone calls with the unit.
Destinations. One application for this is attaching an MDT device. Other example includes attaching a satellital modem to be used when no GSM/GPRS signal is detected by the Antares SB 1.1.10 Communication buffer Antares SB will start saving event’s reports and incoming serial...
GPS antenna connector. 1.1.18 Event Reporting Antares SB has the ability to interpret complex user-defined report- ing criteria to track normal, as well as exceptional situations. This is called Event Report and it is mainly done via the Event Machine included in the unit’s firmware.
Page 23
1.1. FEATURES – Main power detection. – 12volts/24volts detector for main power. – GPS Fix state. – GSM roaming state. – GSM registration state. – GPRS registration state. – GPRS attach state. – GPS Antenna short circuit state. – TCP connections’ state indicators. –...
1.2. CONTENTS OF PACKAGE Contents of package Inside the Antares SB box you will find the following content: An Antares SB A GSM Quad-Band antenna ready to work with any GSM car- rier regardless of its operation frequency. An active GPS antenna with magnetic support and reverse- polarity connector.
Use this port to configure or query the unit and to connect accessories like PDA-like devices or MDTs. The Antares SB ’s works as an RS-232 DCE device. See the Serial Port section in the Operation chapter for more in-...
1.3. FRONT SIDE DESCRIPTION 1.3.2 SIM card slot Use this slot to insert the GSM SIM card. Insert the SIM card as described on the next figure. Use a thin object like a coin to get the SIM card fully inserted until it clicks. The SIM gets locked when it clicks.
1.3. FRONT SIDE DESCRIPTION 1.3.4 AUDIO jack The audio connector is designed to connect a non-balanced hands-free audio system. See the Specifications section for information on the type of speaker and microphone that can be used. The connector is designed to use a 2.5mm stereo plug with the fol- lowing configuration: A non-balanced speaker-microphone connection must be as follows: Most popular cellular phones’...
1.4. BACK SIDE DESCRIPTION Back side description 1.4.1 GSM Antenna connector This is a SMA (Sub Miniature A) connector with a female center contact. Use this connector for the GSM Antenna provided with the unit. 1.4.2 GPS Antenna connector This is a SMA (Sub Miniature A) connector with a male center con- tact .
1.4. BACK SIDE DESCRIPTION XP makes reference to Outputs, IP to Inputs. For information on inputs, outputs and ADC see the Operation chapter. The I/O Harness (female molex-type receptacle) supplied with the unit is configured as follows: Signal Color White and brown White and red White and orange White and yellow...
Page 30
1.4. BACK SIDE DESCRIPTION The Power Harness (female molex-type receptacle) supplied with the unit is configured as follows: Signal Color Black Ignition (F00) Yellow...
1.5. SPECIFICATIONS Specifications 1.5.1 Dimensions Values shown in millimeters. The depth of the unit is 127mm. 1.5.2 Environment Operating: 20 C to +55 C Storage: 30 C to +85 C Humidity: Up to 95% non-condensing. 1.5.3 Power DC Voltage : 8V - 32 V Current consumption: –...
1.5. SPECIFICATIONS 1.5.4 Inputs/Ignition Input impedance: 50 Kohms. Internal Pull-up: 50 Kohms. Sampling rate: 3 s/sec. Inputs’ detection: Logical State Electrical State Active 0V to 1V Inactive 2.9V to 32V or Open Ignition detection: State Voltage range Ignition ON 5.8V to 32V Ignition OFF 0V to 4.8V or Open 1.5.5...
When the vehicle has a main power switch to cut/restore the battery voltage, some recommendations have to be followed: If the switch disconnects the positive voltage of the vehicle’s battery, the Antares SB can be connected before or after the switch. When connected before it will keep on receiving the vehicle’s power whenever the switch is off.
Page 36
2.1. POWER SUPPLY If the switch disconnects the negative voltage of the vehicle’s battery, the Antares SB power CAN NOT BE TAKEN BE- FORE THE SWITCH. Doing so will make all of the unit’s con- nections to ground like panic buttons and its chassis serve as current path canceling the vehicle’s main power switch thus...
2.2. INPUTS DETECTION Inputs detection For the general purpose inputs the electrical conditions are as follows: Logical State Electrical State Active 0V to 1V Inactive 2.9V to 32V or Open A typical input configuration consists of the input connected trough a switch to GND.
2.4. OUTPUTS connected to the start position which gives energy to the vehicle’s start engine as this position is ON only for a short period of time. The unit’s ignition sense can be directly connected to the electrical end of this position. See the Connection Diagrams section for an illustration.
2.5. CONNECTION DIAGRAMS Connection diagrams The following illustrations show: Panic Button detection. Ignition sense. Engine turn off Shutting and engine off without knowing a vehicle’s state is not advised. See the Operation chapter for more information.
Operation The Antares SB operates on an automatic basis according to an user-defined configuration which can be modified at any time locally or remotely using the GSM/GPRS network. The unit’s operation in- cludes actions/reports based on interaction with its surroundings like remotely-given commands, input sensing, accessories’...
(9600,8N1). It does not use any flow control method and all of the RS-232 communication lines on the DB9 connector are used. The Antares SB works as a DCE device, meaning that it is connected to a PC with a one-one cable.
3.2. LEDS Initializing: This state lasts 15 seconds and is reached any time the unit is recovering from a non-power situation or recovering from a previous system reset. If the unit remains in this state for a longer time you may have a hardware problem. In this state the unit’s TAIP console will not respond to commands.
3.3. INPUTS/IGNITION 3.2.3 Fix (Yellow) As long as the Power LED is solid ON, this LED gives information on the GPS receiver status. There are two possible states: ON: The GPS unit is doing fixes. This indicates a well placed GPS antenna with sky view.
Page 47
3.3. INPUTS/IGNITION Logical State Electrical State Active 0V to 1V Inactive 2.9V to 32V or Open For the ignition input: State Voltage range Ignition ON 5.8V to 32V Ignition OFF 0V to 4.8V or Open For addition Inputs’ state can be consulted locally or remotely at any time with the TAIP console.
RSSXP31 To deactivate the output: SSSXP30 Example Making the Antares SB automatically drive an output: Use the SS message as an user-action on an event definition, see the Event Machine section on the Configuration chapter and the ED mes-...
R05. See the GR message on the TAIP reference for information on how to create regions. Analog to Digital Converter The Antares SB has one ADC whose input voltage is located on the I/O molex-type connector. The input voltage range is 0V to 32V. The ADC value computed...
These events will send the report to the serial port. See the Event Machine section on the Configuration chapter for more information. Back-up Battery The Antares SB offers the possibility of a built-in back-up Lithium- Polimer battery to be used whenever the main power source (the ve- hicle’s battery) is lost or sabotaged.
Page 51
3.6. BACK-UP BATTERY The battery state is not an instant value of the battery level, Note: instead it gives an average value computed every 10 seconds. The actual computed value may be consulted at any time with the XABS message, see the TAIP reference for more information. Example Query the actual battery status: QXABS...
When using UDP nobody initiates a connection. In this case the units responds TAIP queries sent as UDP datagrams from a remote IP address/name defined on an UDP-IP-type Destination. There are Antares SB supports IP numbers as well as domain names.
Page 53
TAIP commands on a fixed, always-available port. No- tice that the UDP server port solution only works when both the server sending the TAIP query and the Antares SB located on the same network (Virtual or Real). This is not the case on the majority of situations where the unit has Internet access.
Page 54
3.8. OVER THE AIR 1. First, the unit tries to match the remote peer address with the UDP Network set with the XAUN command. If the remote peer address does not match the UDP network, or if the UDP network is not defined (default state), the second validation mechanism is performed.
Refer to the XAVC, XAVE commands and voice signals for more infor- mation. Refer also to the Operation chapter and Examples chapter. TAIP console The Antares SB TAIP console allows commands and queries to be sent to the the unit by a user or software. The TAIP console is avail-...
3.9. TAIP CONSOLE may be configured and/or consulted locally over the serial port or remotely by means of IP communication (GPRS) or SMS interaction (GSM). The console is also used to show the unit’s report messages generated by the Event Machine (i.e EV and ET TAIP messages). The TAIP console is based on a question/command and its answer which can be formed by multiple messages .
The unit can be configured to output every message with the vehicle’s ID. This is optional and is controlled by the RM message. The default ID is set to 0000. The Antares SB will check all incoming messages for ID, if no ID is specified, the unit will accept the message. If the ID is included in messages but does not compare with the ID previously set, the message will be ignored.
Interacting TAIP communication must be driven by a timeout-retry mechanism. 3.10 Remote host software The Antares SB is designed to interact with Automated Vehicle Location (AVL) servers which have the ability of interpreting TAIP messages. In this document, AVL server, AVL system, AVL host, AVL appli-...
3.10. REMOTE HOST SOFTWARE 5. The server should not use a keep-alive mechanism. Using the unit’s keep-alive option or a periodical report event are the pre- ferred methods. See the XAKA message for keep-alive options. 6. The server should have an association between unit’s ID and corresponding TCP socket so any user-query can be correctly routed.
Then no more sends for about 6 more minutes. After that the mech- anism restarts. 3.10.3 Working with SMS Antares SB may use Telephone Number Destinations to send its report or to give TAIP console access via SMS messages. The Destina- tion may be configured to send user-defined event messages intended to be read by a person with a cellular phone or similar.
TAIP command that the user locates on the user- action section of an event definition. So, the AVL server shall expect two types of reports from the Antares SB : The Events’ Reporting Messages and the Responses to TAIP commands messages.
3.11. REPORTS’ MESSAGES For detailed information on this message refer to the EV message on the Unit’s TAIP reference chapter When configuring the Event Machine, on each event definition, the user decides what Reporting Message the event shall generate. For information on events’...
For more information and examples see the Event Machine section on the Configuration chapter. 3.12 Reports’ buffer The Antares SB reserves a memory space to save reports whenever the remote Destination is not available. The buffering process for a Destination takes place on any of the following situations: For IP-type destinations: 1.
This process is stared with the XAFU message. See the TAIP reference for detailed information. The message takes a firmware version number for ex- ample 5.21, a flag that tells which server to use: DCT’s or any defined by the user, and a Destination Address or Destination Point to send the up- grade progress state.
Page 65
(pending events) will be lost. The unit’s configuration is preserved throughout firmware upgrades Example Initiate an over-the-air firmware update with DCT’s servers in order to up- grade the unit’s firmware to version 5.21 having the diagnostic messages sent over the serial port:...
The use of this tools is recommended for the creation and writing of configura- tion scripts on which a complete configuration for the Antares SB can be created or read.
Now a brief instructional on having the ACT communicate with the unit is given. 3.14.1 Communicating locally with the Antares SB In this section you will learn how to communicate with the unit. Power on the unit. Connect a direct serial cable between the unit’s and the PC’s serial ports.
3.14. ANTARES CONFIGURATION TOOL (ACT) If at any time you need to liberate the comm port for other ap- Note: plications, select the Disconnect option from this menu. It is not necessary then to close ACT for this purpose 3.14.2 STEP 2.
3.14. ANTARES CONFIGURATION TOOL (ACT) 3.14.3 Managing regions This section assumes you are familiar with the ACT software, you can find information on the Antares Configuration Tool User’s Manual. Instructions on how to create regions with scripts are given on the Using Regions section of the Configuration chapter.
Page 70
3.14. ANTARES CONFIGURATION TOOL (ACT) In the illustration there are 4 regions already defined. They are displayed in the Regions’ List as a region’s code and name. The name, code (same as number), point’s list and sketch correspond to the region highlighted in the Regions’...
Page 71
When you create a region you can give it the name you want and whatever code (a number between 0 and 29) that is going to be used later on the Event Definition as reference. The regions’ names are not relevant for Antares SB , only for Note: Create/edit points (Step 3) Once you create a new region, ACT automatically defines 3 points that form...
Configuration The Antares SB configuration is done through the unit’s TAIP console via TAIP commands. The TAIP console can be used with several commu- nication methods: The unit’s serial port. TCP or UDP (GPRS level) communication. 2-way SMS (GSM level).
4.1. *UNIT’S ID are also defined in order to gain remote access to the unit. The sections on this chapter marked with an * are essential to Note: every configuration. This chapter is a complement of the TAIP reference chapter and vice versa.
PIN was not given. So it is recommended in those cases to reset the unit after the PIN-set command with the reset message. Or better, have the PIN correctly configured before the SIM card is inserted. The Antares SB does not block a SIM card when the given PIN Note: is wrong.
For example: this.is.an.apn.com internet.carrier-name.com Setting the APN on the Antares SB is also done with the RF message. An “empty” APN may be configured too. An empty value is used when a GPRS session is not desired.
*Destinations (DPs and DAs) (*)Essential configuration A destination makes reference to the device or user that is receiving and/or sending messages from/to the Antares SB . The possible destination for the unit are: 10 IP hosts. Via TCP and/or UDP.
4.3. *DESTINATIONS (DPS AND DAS) an IP address or a server name and a TCP or UDP port number. The Antares SB is a TCP and/or UDP client which always starts the communication. This means that the IP host has to be a TCP or UDP server listening for incoming connections on the same port specified here.
DP instead of TAIP reporting messages. See the XADP message for more information on this. The Antares SB reporting messages that have to be interpreted by the AVL software server are the EV and ET messages. See the...
4.5. *EVENT MACHINE *Event Machine (*)Essential configuration The unit’s reporting is controlled by an Event Machine which constantly evaluates user defined events. These events allow the user to create a re- porting schema and functionality controlled by triggers and actions. Events can be consulted or configured at any time with the ED message throughout the TAIP console, enabling the user to alter the Event Machine parameters at any time locally or over the air.
Page 80
4.5. *EVENT MACHINE Now, every time S and P are both true at the same time, C is going to be true too. Whenever S or P become false, C will become false. The situation we just created (named C) is useful for detecting an speed limit violation within a cities’...
Actions Once you have defined a trigger (and/or a set of triggers) the next step for configuring the Antares SB event machine, is to tell the unit what to do when a trigger goes off. There are two types of actions the unit may take when a trigger goes off.
Page 82
Activate a led connected to any output whenever a vehicle is out of a polygonal geo-fence. Have the Antares SB safely turn the vehicle’s engine off whenever this travels too far from the normal working region.
The next figure gives a global description of the TAIP ED mes- sage. For detailed information refer to the unit’s TAIP specification chapter. The Antares SB has 50 events available for the user to configure. They may be defined all at once in a configuration script or they me be individually...
Page 84
4.5. *EVENT MACHINE events’ definitions of the unit may be consulted with the TAIP message QED . This will have the unit deliver the configuration state of all 50 events. An example of the returned configuration on the TAIP console is: >QED<...
A situations makes reference to a vehicle state which is in fact represented by signals and their state. Antares SB signals are of boolean nature, meaning that they can only take one of two possible values: true or false.
Page 86
4.5. *EVENT MACHINE Signal Description A00 - A09 Destination Points’ state True when the IP address/port defined on the corre- sponding Destination Point’s index is accepting a TCP connection or when using UDP (i.e. the TCP/UDP socket is open). See the XADP message. B00 - B04 Battery Levels(+) True when the unit’s back-up battery level is above the...
Page 87
(*) Antares SB does not have GPIOs. These signals are maintained for backwards compatibility with scripts from other versions. Instead, Antares SB has 4 inputs and 4 outputs. Signals G00-G03 are the same as IP1-IP4 signals and G04-G07 signals are the same as XP1-XP4 signals. The user is encouraged to use IP and XP signals instead of G signals.
4.5. *EVENT MACHINE a “periodic” sort of signal which is suitable for a Time And Distance report. An example of using these messages to define a signal: Example Defining the speed signal S06 to be true whenever the vehicle’s speed ex- ceeds 55mph and false whenever the speed is below: SGS0610550 Now the speed signal S06 can be used on an event’s definition to gener-...
It is recommended to define regions with the ACT software and not manu- ally. Using Regions (geo-fences) The Antares SB supports detecting when a vehicle is inside or outside of up to 30 user-defined polygons (50 points maximum each). These polygon- defined regions are defined with the GR message and the associated regions’...
3. Once you are done creating/editing regions on ACT the next step is passing the configuration to an Antares SB . This is different than passing an script to the unit as described on the Using Scripts section.
4.8. THE TIME AND DISTANCE CRITERIA set the signal low whenever the vehicle’s speed is below the limit. Up to 10 speed limits may be defined, so there are 10 speed signals (S00 - S09) available to be used on an event’s definition. Example To create the speed limit 00 having a value of 55mph send to the unit: SGS0010550...
4.9. USING TIME WINDOWS ensures a minimum reporting frequency. One way to see this parameter, is that this time will be the report period when the vehicle is stationary. The Minimum time between reports takes control of the report when the unit exceeds the Distance threshold.
4.10. USING COUNTERS 4.10 Using Counters Counters’ configuration/manipulation is controlled by the GC message. Up to 20 counters can be configured. For detailed information and more exam- ples see the GC message. Next, a brief description of counters’ operation. There are three types of counters: For counting time (TIMERS).
Page 94
4.10. USING COUNTERS Keep on counting (continuous counter). To define a continuous counter: Set the recycle flag to C. The previous illustration shows a continuous counter. Reset the counter value to zero (recycling counter), creating thus a periodic counter signal. To define a recycling counter: Set the recycle flag to R.
Page 95
4.10. USING COUNTERS A counter value can also be ”‘manually”’ altered with the GC command. Use the V command on a previously defined counter. The next graph illustrates this. Note that altering a counter’s value does not affect its counting con- figuration: After altering its value, the counter keeps on counting from the given value.
Page 96
4.10. USING COUNTERS The X next to the V on the setting-value command indicates the counter to preserve its recycling flag: If the letters R or C were used instead of X, the counter will not only change its value but its recycling configuration too. A counter value may be consulted at any time.Use the V command in query form ( QGC00V ).
4.11. MANIPULATING SIGNALS Unit’s TAIP reference chapter and the Scenarios and Examples sections. 4.11 Manipulating signals Signals marked with a (-) sign on the signals’ list on the Event Machine section can be directly manipulated by the user. These signals are: Outputs (4).
SED40NV0;J02+ 4.14 Driving Metrics (Acceleration, Max. Speed, etc) Antares SB has the ability of calculating the vehicle’s positive and nega- tive accelerations based on GPS information. The instant acceleration value gives an idea of how a vehicle is being drove. Large positive values indicates...
Page 99
4.14. DRIVING METRICS (ACCELERATION, MAX. SPEED, ETC) situations. A vehicle having large acceleration values indicates unsafe an expensive driving. On the contrary, low values indicate an smooth, efficient driving. The actual acceleration of the vehicle can be known with the XAIT command.
SXAITC For detailed information consult the XAIT message in the TAIP chapter. 4.15 Voice calls To make the Antares SB generate/terminate a voice call refer to the XAVC and XAVE messages. To answer voice calls: If no voice call is being held, the unit can answer incoming calls as long as the remote party number is registered on any Phone number-type Desti- nation and the Destination is authorized to receive phone calls.
Page 101
2. The external device has no idea of TAIP so it talks any byte-based protocol. For the first option there are no special configurations on the Antares SB . It is only necessary to configure the Event Machine to send reports to the serial port so the attached device has GPS/events information to analyze.
Page 102
Supposing the external device sends the following data: Note: Non-printable data is shown between [ ] symbols in hex value [02]Test message...[03] The Antares SB after receiving the 03 byte will send to Destination 04 the following TX message: RTX 02Test message... 03...
4.18. ANALOG TO DIGITAL CONVERTER MONITORING This will make the Antares SB send the original sequence to the attached device. For more information refer to the TX and MT messages. 4.18 Analog to Digital Converter monitoring The ADC can be monitored with the XAAC message.
Comments are not passed to the unit, they are only saved on the .tmf file and can not be retrieved when reading an script from an unit. Here it is an example of an script file: #Antares SB script #Getting Started example #Unit’s ID >SIDEXAMPLE<...
If you prefer, you can edit an existing script instead of creating a new one from scratch. Another option for not having to create an script from scratch is mak- ing ACT generate an script file by reading an Antares SB . See the next section.
Make sure of following the instructions on the Antares Configuration Tool section of the Operation chapter and have the ACT already connected and communicating with the Antares SB before proceeding. Make sure of using version 1.6.4 or superior of ACT. Contact...
Page 107
4.24. USING SCRIPTS option HW VSP works as the TP Server only box on the software. For more information on these software tools contact Digital Communi- cations Technologies...
Scenarios and examples For this chapter It is assumed that the reader already has access to the unit’s TAIP console trough the unit’s serial port using a terminal software like Windows ’ Hyperterminal . Refer to the Operation chapter for more information.
5.1. GETTING STARTED The GSM registration status is indicated by the status LED. This LED is solid whenever the unit is not registered on GSM. Although the unit is not registered, it could be searching for the operator which is a normal con- dition.
TCP listener. 4. The server is accepting the connection but it is immediately (or a few seconds later) closing it. 5. The Antares SB is behind a cellular carrier’s NAT which has the selected port blocked.
AVL application you can always shut it down an use some popular free TCP listener applications that will show you the RAW data where you can check the TAIP messages generated by the Antares SB Other useful tool is a network sniffer that allows you to analyze the traffic...
Now our unit is generating a 5 minutes periodic report and also a special report whenever the Input 3 goes high 5.1.9 Script This example can be resumed with the following script: #Antares SB script #Getting Started example #Delete any previous configuration >SRT;CONFIG< >SXADP**U<...
5.2. ADDING SMS REPORTING # server destination >SDA4;P00< #Time-only Time And Distance #signal definition >STD80300< #Event triggered by T&D signal >SED37NV4;TD8+< #Input report event >SED05NV4;IP3+< #end You can copy and paste this script to a new empty text file and have it save with a .tmf extension so ACT software can pass it to a unit.
5.2. ADDING SMS REPORTING Now Destination Address 5 holds Destination Points 00 and 10. We can point any event to DA 5 making any report generated by the event to be routed to our AVL server an to the Telephone Number 912345678 at the same time.
Signal LED does not have to be solid ON. The cellular carrier has to provide SMS sending capabilities to the cellular line being used by the Antares SB The phone number 912345678 may not be exactly the phone number that should be used for sending SMS messages. A plus sign with country/area code or similar may be required.
5.3. ADDING SMS INTERACTION #signal definition >STD80300< #Event triggered by T&D signal >SED37NV4;TD8+< #Input report event >SED05NV5;IP3+< #User text message for event 05 >SXATM05Input 3 has been activated!< #end Adding SMS interaction Once a Phone-Number-type destination has been created it is possible to interact with the unit via SMS messages generated from that phone number, as long as the Destination configuration allows TAIP console access to the configured DP.
5.4. ADDING VOICE INTERACTION phone number 912345678 the text message: SSSXP21 The unit responds the following via SMS: RSSXP21 Confirming that it accepted the command and the output has been set high. Adding voice interaction The unit may receive or make calls from/to any of the Phone Number-type defined Destinations.
Ignition ON and OFF events are only going to be sent to the AVL server. 5.5.1 Script The resulting script: #Antares SB script #Getting Started example # + SMS reporting (+SMS interaction + Voice interaction) # + Ignition sense #Delete any previous configuration >SRT;CONFIG<...
5.6. SPEED VIOLATION (WITH WARNING) REPORT #The remote AVL server address and port >SXADP0000avl.server.com;2145< #The Phone-Number-type destination #with support for user-messages ON >SXADP1010912345678< #A Destination Address holding the # server destination >SDA4;P00< #A Destination Address holding the # server destination and phone number >SDA5;P00,P10<...
5.6. SPEED VIOLATION (WITH WARNING) REPORT 5.6.1 Setting the speed limit Up to 10 speed limits can be defined on the unit, for no particular reason we choose the limit 07. Using the GS message we set the limit: SGS0710650 Now any time the vehicle speed is above 65mph the S07 signal is going to be true.
LED off when the speed limits falls below: SED43SV0;S07-;ACT=SSSXP10 5.6.6 Script The resulting script: #Antares SB script #Getting Started example # + SMS reporting (+SMS interaction + Voice interaction) # + Ignition sense # + Speed viol. and warning #Delete any previous configuration >SRT;CONFIG<...
5.7. START/STOP MONITORING >SED37NV4;TD8+< #Input report event >SED05NV5;IP3+< #User text message for event 05 >SXATM05Input 3 has been activated!< #Ignition ON event >SED19NV4;F00+< #Ignition OFF event >SED20NV4;F00-< #Set an speed limit of 65mph >SGS0710650< #Start a 15 secs. timer when #speed limit is violated #(silent event) >SED40SV0;S07+;ACT=SGC00TC00015<...
5.7. START/STOP MONITORING + Ignition sense + Speed violation and warning. Now we have to tell the unit what is a STOP and what is a START. There are several ways of doing this, for this example we are going to define a STOP situation to be when the vehicle’s speed remains below a small speed limit for a given period of time.
5.7.6 Script The corresponding script of this configuration plus all the examples worked so far is: #Antares SB script #Getting Started example # + SMS reporting (+SMS interaction + Voice interaction) # + Ignition sense # + Speed viol. and warning...
Page 125
5.7. START/STOP MONITORING #The Phone-Number-type destination #with support for user-messages ON >SXADP1010912345678< #A Destination Address holding the # server destination >SDA4;P00< #A Destination Address holding the # server destination and phone number >SDA5;P00,P10< #Time-only Time And Distance #signal definition >STD80300< #Event triggered by T&D signal >SED37NV4;TD8+<...
5.8. SAFE ENGINE TURN OFF #Create the violation report >SED10NV4;C00+< #Drive a LED on output 1 ON #when the speed goes beyond the limit #(silent event) >SED42SV0;S07+;ACT=SSSXP11< #Drive a LED on output 1 OFF #when the speed falls off the limit #(silent event) >SED43SV0;S07-;ACT=SSSXP10<...
5.8. SAFE ENGINE TURN OFF 4. We can also add an event to report when the output is actually set (i.e. the ignition is cut), let’s use event code 13 for this. We continue working on the same example worked so far. 5.8.1 Create the speed limit We set 15mph on the S01 limit:...
5.8. SAFE ENGINE TURN OFF 5.8.6 Script Adding a safe-engine-turn-off option leads to the following script: #Antares SB script #Getting Started example # + SMS reporting (+SMS interaction + Voice interaction) # + Ignition sense # + Speed viol. and warning...
Page 129
5.8. SAFE ENGINE TURN OFF #Event triggered by T&D signal >SED37NV4;TD8+< #------------------------------------------- #--Input sense------------------------------ #Input report event >SED05NV5;IP3+< #User text message for event 05 >SXATM05Input 3 has been activated!< #------------------------------------------- #--Ignition sense--------------------------- #Ignition ON event >SED19NV4;F00+< #Ignition OFF event >SED20NV4;F00-< #------------------------------------------- #--Speed viol.
5.8. SAFE ENGINE TURN OFF #Speed limit for START/STOP detection >SGS0310080< #Start 2 minutes timer >SED38SV0;S03-;ACT=SGC01TC00120< #Stop the time >SED39SV0;S03+ACT=SGC01U< #Create the STOP report >SED30NV4;C01+< #Create the START report >SED31NV4;S03C01&+< #------------------------------------------- #--Safe engine turn off--------------------- #Set the speed limit for the time/speed #condition >SGS0110150<...
5.9. IMPROVING THE PERIODIC REPORT 2. If you receive a confirmation of this message the turn off process has initiated. Wait for event 13 to report. When event 13 report is received it means that the given time/speed condition met and the vehicle’s engine has been turned off.
And leave the rest of the script unchanged. 5.9.1 Script Changing only the TD8 definition, our script ends up: #Antares SB script #Getting Started example # + SMS reporting (+SMS interaction + Voice interaction) # + Ignition sense # + Speed viol. and warning...
Page 133
5.9. IMPROVING THE PERIODIC REPORT #The Phone-Number-type destination #with support for user-messages ON >SXADP1010912345678< #A Destination Address holding the # server destination >SDA4;P00< #A Destination Address holding the # server destination and phone number >SDA5;P00,P10< #A complete Time And Distance criterion #min = 120 secs.
Page 134
5.9. IMPROVING THE PERIODIC REPORT >SED41SV0;S07-;ACT=SGC00U< #Create the violation report >SED10NV4;C00+< #Drive a LED on output 1 ON #when the speed goes beyond the limit #(silent event) >SED42SV0;S07+;ACT=SSSXP11< #Drive a LED on output 1 OFF #when the speed falls off the limit #(silent event) >SED43SV0;S07-;ACT=SSSXP10<...
A00 signal has to be used as the AVL server is defined on the Destination Point 00: SED49NV4;A00+ We chose event 49 for no particular reason. This will have the AVL server receiving event 49 any time a new connection from an Antares SB established. 5.10.1 Script...
Page 136
5.10. RECONNECTION EVENT FOR TCP >SXADP**U< #------------------------------------------- #--Essential configurations----------------- #Units ID >SIDEXAMPLE< #configuring the SIMs PIN >SRFI1234< #configuring the APN >SRFAinternet.carrier-name.com< #The remote AVL server address and port >SXADP0000avl.server.com;2145< #The Phone-Number-type destination #with support for user-messages ON >SXADP1010912345678< #A Destination Address holding the # server destination >SDA4;P00<...
Page 137
5.10. RECONNECTION EVENT FOR TCP >SED20NV4;F00-< #------------------------------------------- #--Speed viol. + warning-------------------- #Set an speed limit of 65mph >SGS0710650< #Start a 15 secs. timer when #speed limit is violated #(silent event) >SED40SV0;S07+;ACT=SGC00TC00015< #Stop the timer when the speed falls #below the limit #(silent event) >SED41SV0;S07-;ACT=SGC00U<...
5.11. MAIN-POWER-LOSS ALARM #condition >SGS0110150< #Start 16 seconds timer when the speed #falls off the previously set value and #as long as the user signal is set >SED14SV0;S01!U00&+;ACT=SGC02TC00016< #Stop the timer when the speed condition #is violated >SED15SV0;S01+;ACT=SGC02U< #Ignition cut event #Sets output 4 high and #sends a report to DA 5 >SED13NV5;C02U00&+;ACT=SSSXP41<...
5.13. CONFIGURING/READING A DISTANCE COUNTER 5.13 Configuring/reading a distance counter Refer to the XACR message. 5.14 Generating an extended-EV report Related commands: ED, EV, XAEF As mentioned on the Reports’ messages section of the Operation chapter, an EV report can be extended to include extra information tags .
Page 140
;ID=EXAMPLE REV311447147649+2578440-0802854301000512;AL=00001;AC=+08 ;ID=EXAMPLE And event 32 as REV321447147747+2578440-0802854301000512;AC=-12;CV07=01203;SV=09 ;ID=EXAMPLE Notice that the order of information tags defined with the XAEF is not preserved, Antares SB reports the tags alphabetically. For detailed in- formation see the ED, EV and XAEF messages.
6.1. (AL) ALTITUDE (AL) Altitude Qualifiers: Q, R This message gives the vehicle’s altitude and vertical speed. The message has the following format: AAAAABBBBBBCCCCDE Chars Item Format Value Meaning GPS Time AAAAA seconds GPS time of day. Altitude BBBBBB meters Above Mean Sea Level Altitude.
6.2. (CP) COMPACT POSITION (CP) Compact Position Qualifiers: Q, R This message gives the position solution. The message has the following format: AAAAABBBCCCCDDDDEEEEFG Chars Item Format Value Meaning GPS Time AAAAA seconds GPS time of day. Latitude BBB.CCCC degrees Latitude in the WGS-84 datum. Positive values indicate a northern latitude.
6.3. (DA) DESTINATION ADDRESS (DA) Destination Address Qualifiers: Q, S, R A Destination Address is an association of Destination Points. These allows an event defined with the ED message to be routed to multiple receivers at the same time by selecting the Destination Address (or group) that holds all of the desired destinations (IP-types, Telephones, Serial Port).
6.3. (DA) DESTINATION ADDRESS 6.3.1 Examples Creating DAs To create Destination Address 5 as an association of Destination Points 2, 3, 10 and 15 (15 is the unit’s serial port): SDA5;P02,P03,P10,P15 To create Destination Address 0 with only one Destination Point, for example the unit’s serial port: SDA0;P15 To create a Destination Address as a range of DPs:...
6.4. (DP) DESTINATION POINT (DP) Destination Point Qualifiers: Q, S, R This command is deprecated and should not be used, use the XADP message instead. A Destination Point defines the IP address and/or cellular telephone of a destination. An association of Destination Points is used to define a Des- tination Address which is used in an Event Definition to route Event Mes- sages.
Page 147
6.4. (DP) DESTINATION POINT AABC[DDD...] Chars Item Format Value Meaning Destination 10-14 Decimal number holding the point’s index. In- Point ID dexes 00 to 09 refer to IP addresses where an AVL software is listening for TAIP messages. Indexes 10 to 14 refer to SMS receptors’ tele- phones.
Qualifiers: Q, S, R This message is used to define events. These events define the Event Ma- chine configuration for the Antares SB . An event is created by defining a boolean combination of signals as a trigger, a routing indication for a gener- ated event message (EV or ET) and a possible TAIP message to be executed when the event occurs.
Page 149
6.5. (ED) EVENT DEFINITION AABCD;EEE [EEE][F] G[[;ACT=HH...][;ACT=HH...]...] Chars Item Format Value Meaning Event ID 00-49 Decimal number ranging between 00 to 49 (or ’**’). Event flag Message routing: Handling Normal. Route the Event Message to the specified Destination Address (DA). Serial Port.
6.5. (ED) EVENT DEFINITION 6.5.1 Examples Single signal triggers Example: Periodic report To define event 05 to send an EV Event Message every 3 minutes: 1. Use the TD message to configure a Time & Distance signal to trigger every 3 minutes: STD70180 2.
Page 151
6.5. (ED) EVENT DEFINITION Example: Reporting Following the previous example, create another event that generates an extended-EV report including the state of distance counter 12 whenever the another extended-EV vehicle is turned off: reporting message SED24NB0;F00-; SXAEFB;CV12; Refer to the Scenarios and examples chapter for more information.
6.6. (ER) ERROR REPORT (ER) Error Report Qualifiers: R This message is generated by the unit whenever the previous command en- tered on the TAIP console generates an error. The message has the following format: AA:[BBB...] Chars Item Format Value Meaning Error Error code: See the table of error...
6.7. (ET) EVENT REPORT, TIME ONLY MESSAGE (ET) Event Report, time only message Qualifiers: R This message is generated when an event is triggered. This message only contains date and time of the generated event. The message has the follow- ing format: AABBBBCDDDDD Chars...
6.8. (EV) EVENT MESSAGE (EV) Event Message Qualifiers: R This message is generated when an event is triggered and reported. The message has the following format: AABBBBCDDDDDEEEFFFFFGGGGHHHHHIIIJJJKL[EXTENDED-EV TAGS] Chars Item Format Value Meaning Event 00-49 Event code. code BBBB week Number of weeks since 00:00AM January 6, 1980.
Page 155
6.8. (EV) EVENT MESSAGE Meaning ;AL=AAAAA Altitude is A meters Above Mean Sea Level (AMSL). ;AC=AAA Acceleration is A [Miles] per [Hour per second] ;AD=AAAAA Voltage on the Analog port is A mV. ;AD=AAAAA Voltage on the Analog port is A mV. ;BL=AAAAA Voltage of the back-up battery is A mV.
6.9. (GC) COUNTERS, TIMERS, DISTANCERS (GC) Counters, Timers, Distancers Qualifiers: Q, S, R This message is used to configure and manipulate internal counters. Each counter can be configured as a user-controlled counter, a timer, or a dis- tancer (counter updated by the traveled distance). For more information refer to the Operation chapter.
6.9. (GC) COUNTERS, TIMERS, DISTANCERS 6.9.1 Counters’ commands Value Meaning Sets the counter type to Counter with a threshold value de- fined as DDDDD. The value for this type of counter can only be changed with the increment (I or value (V) command. Set and start a Timer counter with a threshold value defined as DDDDD, time increment 1 or EEEEE seconds.
Page 158
6.9. (GC) COUNTERS, TIMERS, DISTANCERS are not interested on monitoring the C05 signal. We can query the distance counter value at any time: QGC05V Ant the unit shall respond: RGC05V00997 Indicating that the traveled distance since the counter set is 99.7km (997 x 100m).
An output is defined by setting the bit that corresponds to the GPIO’s index. An input is defined by re- setting this bit. Only the following command works on Antares SB SGFF0 Any other value will make the unit return error 86: SGF00...
6.11. (GS) SPEED LIMIT 6.11 (GS) Speed Limit Qualifiers: Q, S, R This message is used to configure the speed limits that can be used to trigger events. The message has the following format: AABCCCC Chars Item Format Value Meaning Speed 00-09 Identification code assigned to...
6.12. (GT) TIME WINDOW 6.12 (GT) Time Window Qualifiers: Q, S, R This message is used to configure the Time Windows that can be used to trigger events. The signal associated with a Time Window becomes active when the actual date and time is between the values set by the TMin and TMax parameters.
Use 99 to leave this field bor 2 empty.Check the explanation after this table. The Antares SB has the ability to detect whether a vehicle is inside or outside of a user defined polygon. In order to achieve this the point’s nu-...
6.13. (GR) REGIONS A point is formed by the region’s index, the point’s index, the point’s latitude and longitude and by other two parameters called the left neighbors. The left neighbors of a point are the indexes of the points connected (if any) with a line to the actual point and have a longitude value equal to or less than the actual point’s longitude.
Page 164
6.13. (GR) REGIONS This region is drawn with the north pointing upwards so you can see how the leftmost point has the index 00 and the rightmost has the higher index 06 following the longitude ordering discussed above. Left neighbors Lets examine each point’s left neighbors according to the definition given.
Page 165
6.13. (GR) REGIONS As you can see points 02 and 03 share the same longitude. As discussed early it is not relevant which point comes first, the points could be assigned having the 03 below the 02 instead of the arrangement presented in the figure.
Page 166
6.13. (GR) REGIONS Another approach would have been counting 02 as left neighbor Note: of point 03 but then we must be careful of not including 03 as left neighbor of point 02. Point 04. Left Neighbor 1 : 00 Left Neighbor 2 : 99 Point 05.
Page 167
6.13. (GR) REGIONS Point 03. Left Neighbor 1 : 00 Left Neighbor 2 : 01 Point 04. Left Neighbor 1 : 01 Left Neighbor 2 : 99 Point 05. Left Neighbor 1 : 06 Left Neighbor 2 : 99 Point 06. Left Neighbor 1 : 99 Left Neighbor 2 : 99 Point 07.
6.14. (ID) IDENTIFICATION 6.14 (ID) Identification Qualifiers: Q, S, R This message is used to set/query unit’s ID. The message has the following format: A[AAA...] Chars Item Format Value Meaning 1 to 10 Vehicle ID A[AAA. . . ] string Identification code assigned to the vehicle.
6.16. (MT) MDT MODE 6.16 (MT) MDT Mode Qualifiers: Q, S, R This message controls and starts the serial port’s MDT communication mode. The message has the following format: A[BBB[CCCD EE FF GG HH]][;ROUTE=I] Chars Item Format Value Meaning Mode flag MDT mode: P: PAD...
6.17. (PV) POSITION-VELOCITY 6.17 (PV) Position-velocity Qualifiers: Q, R This message gives the unit’s current position, velocity, heading, source of information and age of the data. The message has the following format: AAAAABBBCCCCCDDDDEEEEEFFFGGGHI Item Format Units Meaning GPS Time AAAAA seconds Time of the generated report.
6.18. (RF) RADIO FREQUENCY MODULE CONFIGURATION 6.18 (RF) Radio Frequency module configuration Qualifiers: Q, S, R This message is used to configure Cellular Network parameters. Any RF parameter can be left empty by issuing the command Note: without the B string The message has the following format: A[BBB...] Item...
6.19. (RM) REPORTING MODE 6.19 (RM) Reporting Mode Qualifiers: Q, S, R This message controls flags used to change the format of the responses and reports, i.e. messages with the R qualifier. The message has the following format: [;ID FLAG=A][;EC FLAG=B][;CR FLAG=C][;ER FLAG=B] Chars Item Format...
6.20. (RP) REGISTRATION PARAMETERS (CELLULAR NETWORK) 6.20 (RP) Registration Parameters (Cellular Network) Qualifiers: Q, R This message reports the unit’s cellular registration state. The message has the following format: ABBCCCC Item Format Units Meaning Registration Values: state registered searching operator. Registered in home network.
Page 175
6.20. (RP) REGISTRATION PARAMETERS (CELLULAR NETWORK) RSSI [-dBm] 0 to 7 113 - 99 Very poor 8 to 13 97 - 87 Poor 14 to 17 85 - 79 Fair 18 to 20 77 - 73 Fair 21 to 24 71 - 65 Good 25 to 31...
6.21. (RT) RESET MESSAGE 6.21 (RT) Reset message Qualifiers: S, R When this message is issued alone the unit performs a system reset. When used with qualifiers it serves multiple internal initializations purposes. The message has the following format: [;CONFIG][;SIGNALS] Qualifier Meaning Resets almost all the configuration of the unit.
6.22. (SS) SIGNAL STATUS 6.22 (SS) Signal Status Qualifiers: Q, S, R This message allows for the inspection of signals’ state and the setting of outputs and other manipulatable signals. See the Signals’ list on the Event Machine section of the Configuration chapter. The message has the following format: AAA[B] Chars Item...
Page 178
6.22. (SS) SIGNAL STATUS SSSXP31 To deactivate it: SSSXP30 See the Configuration and Operation chapters for more examples.
6.23. (ST) STATUS 6.23 (ST) Status Qualifiers: Q, R This message provides information about the unit’s GPS receiver. The message has the following format: AABCDDEFGG Chars Item Format Value Meaning Tracking characters: GPS satellite signal acquisition and tracking Status status. 00-0A Code Doing position fixes.
6.24. (TM) TIME AND DATE 6.24 (TM) Time and Date Qualifiers: Q, R This message provides information about the unit’s Time and Data as pro- vided by the GPS service. The message has the following format: AABBCCDDDEEFFGGGGHHIJJKLLLL Chars Item Format Value Meaning Hour...
6.25. (TD) TIME AND DISTANCE SIGNALS CONFIGURATION 6.25 (TD) Time and Distance signals configuration Qualifiers: Q, S, R The Time and Distance signals are set by its corresponding Time and Dis- tance counter which is a counter that follows a Time and Distance criteria. This criteria allows to create a counter that does not follow a time or dis- tance criteria independantely from each other, instead, combines these two variables to generate an intelligent trigger to be used for a more efficient...
Page 182
6.25. (TD) TIME AND DISTANCE SIGNALS CONFIGURATION fast. A Time and Distance counter is created with the following parameters: 1. Distance Threshold. 2. Minimum Time. 3. Maximum Time. The TD message allows to configure the parameters that control the Time & Distance signals’...
6.26. (TX) TEXT MESSAGE 6.26 (TX) Text Message Qualifiers: S, R This message is used to transfer messages between the unit and any Des- tination. Printable ASCII characters as well as byte-like messages can be transfered by means of escaping sequences. The message has the following format: [A...] Chars...
6.27. (VR) VERSION NUMBER 6.27 (VR) Version number Qualifiers: Q, R This message returns the unit’s firmware version The message has the fol- lowing format: Antares GPS [A]A.AA[B][C] Chars Item Format Value Meaning Version A.AA Firmware version number. number Reserved Reserved...
6.28. (XAAC) ANALOG TO DIGITAL CONVERTER 6.28 (XAAC) Analog to Digital converter Qualifiers: Q, R Use this message to consult the actual computed value of the ADC. The message has the following format: AAAAAPBBB Chars Item Format Value Meaning AAAAA millivolts ADC computed value: Average...
6.29. (XABS) BATTERY STATUS 6.29 (XABS) Battery Status Qualifiers: Q, R Use this message to consult the actual state of the built-in back up battery The message has the following format: ABBBBPCCC Chars Item Format Value Meaning Main flag Indicates that the main power Power source (vehicle’s battery) is ON State...
6.30. (XACR) COUNTER REPORT 6.30 (XACR) Counter Report Qualifiers: S, R Use this message to have the unit generate a TX message to a Destination Point (DP) or Destination Address (DA) containing an specific counter’s (see GC message) value. The message takes a counter’s index, and a DP or DA index.
Page 188
6.30. (XACR) COUNTER REPORT For example: Distancer 2(S) = 1200 x(10m) If no (S) is shown, it means the counter is running. The counter type Counter indicates a user defined counter. See the GC message for more information.
6.31. (XACT) COMMUNICATION TEST 6.31 (XACT) Communication Test Qualifiers: S, R Use this message to generate an event code to a Destination Address (DA). This message is used to test the communication with a given destination(s) without requiring for an specific event to occur. It is also a method for testing a DA definition and testing the remote host identification process of an EV message.
6.32. (XADM) DIAGNOSTIC MESSAGE 6.32 (XADM) Diagnostic Message Qualifiers: Q, R Use this message to query unit’s status. The message has the following format: ABBCCDEFFGHIIJKLMMNN Chars Item Format Value Meaning level Diagnostic level. Only ’0’ is supported. FW family Firmware family. Always return 05 FW version –...
6.33. (XADP) DESTINATION POINTS 6.33 (XADP) Destination Points Qualifiers: Q, S, R This message configures both IP-type and Telephone destinations. 6.33.1 IP-type destinations For IP-type destination, i.e. Destination Points 00 to 09 use the following format and table: AABCD[DDD...];E[EEE...] Chars Item Format Value...
Page 193
6.33. (XADP) DESTINATION POINTS AABCD[DDD...] Chars Item Format Value Meaning Destination 10-14 Telephone destination point. Point index Type of host or DP type/Action: Delete action Delete the Destination Point. Report messages are sent as TAIP messages to this destination. User-defined messages are sent in- stead of TAIP.
6.34. (XAEF) EXTENDED-EV MESSAGE FORMATS 6.34 (XAEF) Extended-EV message Formats Qualifiers: S, R This message allows the creation and configuration of up to three sets of information tags to be used by an event having the Message ID qualifier set to A, B or C. This will make such an event generate an EV reporting message with extra information tags as described on the EV message section.
ABBBBCCDD Chars Item Format Value Meaning Server Firmware server: Use 0 for DCT’s servers, 1 for user-defined server Firmware Ver- BBBB Firmware Version to download. The first two sion letter must always be 05. The last two indicate the firmware family. For example, to update to FW 5.21, BBBB should be set to 0521.
6.36. (XAGA) ADC LEVELS 6.36 (XAGA) ADC levels Qualifiers: Q, S, R This message is used to configure analog-to-digital converter levels associ- ated to ”D” signals. The message has the following format: AABCCCCC Chars Item Format Value Meaning ADC level 00-04 Identification code assigned to the ADC level.
6.37. (XAGB) BACK-UP BATTERY LEVELS 6.37 (XAGB) Back-up Battery levels Qualifiers: Q, S, R This message is used to configure back-up battery levels associated to ”B” signals. The message has the following format: AABCCCCC Chars Item Format Value Meaning Battery 00-04 Identification code assigned to the level ID...
6.38. (XAGH) HEADING DELTAS 6.38 (XAGH) Heading deltas Qualifiers: Q, S, R This message is used to configure heading changes to be monitored with J signals. The message has the following format: AABCCC Chars Item Format Value Meaning Index 00-04 Heading delta index.
6.40. (XAID) IMEI AS ID 6.40 (XAID) IMEI as ID Qualifiers: Q, R This message tells the unit whether to use or not (defaults to not) its IMEI as ID. Chars Item Format Value Meaning action Use 1 to set the unit’s ID with the IMEI. Use 0 to set the unit’s ID to the value set by the user with the ID message.
6.41. (XAIM) IMEI CONSULT 6.41 (XAIM) IMEI consult Qualifiers: S, Q, R This message is used to consult the unit’s IMEI (International Mobile Equip- ment Identity). AAAAAAAAAAAAAAB Chars Item Format Value Meaning IMEI IMEI. IMEI’s CS IMEI’s Check Sum.
6.42. (XAIO) INPUT, OUTPUTS CONSULT 6.42 (XAIO) Input, Outputs consult Qualifiers: Q, R This message is used to consult the actual state of inputs and outputs. ;XABCD;IEFHJ;GKLM Chars Item Format Value Meaning Out 4 flag State of Output 4 (1=active, 0=inactive). Out 3 flag State of Output 3.
6.43. (XAIP) IP ADDRESS 6.43 (XAIP) IP address Qualifiers: Q, R This message is used to consult the actual IP address assigned to the unit by the carrier. IP address 0.0.0.0 is returned when the GPRS session is not up. The message has the following format: AAABBBCCCDDD Chars Item...
6.44. (XAIT) DRIVING METRICS (ACCELERATION AND MAXIMUMS.) 6.44 (XAIT) Driving Metrics (acceleration and maximums.) Qualifiers: S, Q, R Use this message to consult the actual vehicle’s acceleration, maximum reg- istered positive acceleration, maximum registered negative (breaking) ac- celeration and maximum registered speed. This command allows to consult also the GPS situation of the vehicle when each maximum occurred.
6.45. (XAKA) KEEP ALIVE 6.45 (XAKA) Keep Alive Qualifiers: S, Q, R This message is used to activate/deactivate a keep-alive to a given IP-type Destination Point (see the XADP message). A keep-alive option should be avoided as increases the transmission cost. Use this option if you need to be able of interrogating the unit at any time and the unit is working behind a NAT.
6.46. (XALL) LOCAL LOCK 6.46 (XALL) Local Lock Qualifiers: S, Q, R This message is used to lock/unlock configuration messages ( S messages) on the TAIP console for the serial port. A locking operation consists of using this message and a user-defined 4-character code. An unlocking operation is performed by entering the message in unlocking mode with the same code defined on the locking operation.
6.47 (XANB) Network Band mode Qualifiers: S, Q, R Antares SB is capable of working on 4 different cellular bands in the fol- lowing way: With this command the user selects a mode which may be of mono band or dual-band type. On dual-band modes, bands are automati- cally switched by the module according to network discovery information.
6.48. (XANS) NETWORK STATUS (GPRS) 6.48 (XANS) Network Status (GPRS) Qualifiers: Q, R Use this message to consult the state of the GPRS session and the state of the TCP sockets of every IP-type Destination Point. The message has the following format: ABB[ ;CDEEE x 10] Chars...
6.49. (XAPM) POWER MANAGEMENT 6.49 (XAPM) Power Management Qualifiers: S, Q, R This command activates/deactivates the unit’s power saving mode (sleep mode). When power saving mode is activated, the unit will go to sleep after 2 minutes as long as no communication activity is detected on the GPRS or SMS channels.
Page 209
6.49. (XAPM) POWER MANAGEMENT A[[[[BBBBBCDEFGHI]JJJJ]KKKK]LLLL] Chars Item Format Value Meaning Action Action: Activate the power saving mode. End any active power saving mode. Go to power saving mode immedi- ately(*). Flags BBBBB Reserved flags. Should be set to 11111 Power flag Set to 1 to monitor the power detector input when in sleep mode.
6.49. (XAPM) POWER MANAGEMENT (*) When going to sleep immediately using the ’I’ qualifier the saving mode is not preserved. i.e. after the unit wakes up the unit ends the power saving mode. 6.49.1 Examples Activate the power saving mode. Only the vehicle’s ignition may awake the unit, and when awaken, the unit must remain up for 20 minutes: SXAPMA000000010000020m Activate the power saving mode.
6.50. (XARD) RESET DIAGNOSTICS 6.50 (XARD) Reset diagnostics Qualifiers: S, Q, R This messages activates/deactivates the system’s resets’ information dis- played with TX messages to a selected DA or DP. The message has the following format: Chars Item Format Value Meaning DA or DP / Command:...
6.51. (XASF) STORE & FORWARD BUFFER 6.51 (XASF) Store & Forward Buffer Qualifiers: Q, R Use this message to consult the reports’ buffer state of a given Destination The message has the following format: AA[BBBBB;CCCCC;DDDDD] Chars Item Format Value Meaning Destination 00-14 Destination Point...
6.52. (XATD) CURRENT DESTINATION POINT 6.52 (XATD) Current Destination Point Qualifiers: Q, R Use this message to know the DP index used on the actual communication channel. The command will return the DP index used to generate the QXATD query. The message has the following format: Chars Item Format...
6.53. (XATM) USER-DEFINED TEXT MESSAGES 6.53 (XATM) User-defined Text Messages Qualifiers: S, Q, R Use this message to set the user-custom messages to be used when an SMS report is to be generated to a Telephone-type Destination configured to receive non-TAIP messages. See the XADP message for more information. One user-text message can be created for each event (00 - 49) so that when an event report is to be sent as a user-custom message the sent message is the one defined with this command (XATM) for the event code that generates...
6.54. (XATS) TAIP CONSOLE SNIFFER 6.54 (XATS) TAIP console Sniffer Qualifiers: S, R Use this message to activate/deactivate the debugging tool that throws to the serial port all of the TAIP console messages exchanged over any com- munication media. This is useful to check the communication between an IP-host software or Telephone and the unit.
6.55. (XAUN) UDP NETWORK 6.55 (XAUN) UDP Network Qualifiers: S, Q, R An UDP-Network can be set as a validation mechanism for UDP queries originated to the unit’s UDP-Server Port configured with the XAUP mes- sage. The UDP-Network validation for the UDP-Server port is optional as the validation is also done by looking for a match on the IP-type, UDP Destinations defined as IP-numbers When an UDP-Network is set, the validation for UDP queries received on...
6.56. (XAUO) UDP ORIGIN PORT 6.56 (XAUO) UDP Origin Port By default Antares SB chooses the value of the UDP-origin-port when sending UDP datagrams. Usually after a GPRS session has been estab- lished, the chosen port is 1024. This value is incremented and reused ac- cording to the unit’s TCP/IP stack.
6.57. (XAUP) UDP SERVER PORT 6.57 (XAUP) UDP Server Port Qualifiers: S, Q, R This command is used to configure a listening UDP port on the unit. If the special value 00000 is used the unit won’t listen for UDP messages on a fixed port, instead it will only use the dynamic port created when it sends reports to a UDP destination.
6.58. (XAVC) VOICE CALL START 6.58 (XAVC) Voice Call Start Qualifiers: S, R This command is used to initiate a voice call with a Telephone-type Desti- nation Point (DPs 10 to 14). Two optional fields are provided to specify a retry number and a time between retries for failing calls.
6.59. (XAVE) VOICE CALL END 6.59 (XAVE) Voice Call End Qualifiers: S, R Use this message to hang-up any current voice call. If no voice call is being held, the command returns and does nothing. The message has the following format: ...No parameters ...
6.60. (XAVI) VOICE CALL IDENTIFICATION SWITCH 6.60 (XAVI) Voice Call Identification switch Qualifiers: S, R, Q This command is used to turn ON/OFF the voice call number validation performed by the unit on incoming voice calls. It defaults to ’ON’, meaning that the calling-party’s number has to be defined on any of the Telephone- type destinations in order for the unit to accept the call .
6.61. (XAVM) MICROPHONE GAIN 6.61 (XAVM) Microphone gain Qualifiers: S, R, Q This command is used to change the microphone gain for voice calls. Chars Item Format Value Meaning Action/value 0-9, +, - Gain value (0-9) or gain action: + to increase, - to decrease.
6.62. (XAVS) SPEAKER VOLUME 6.62 (XAVS) Speaker volume Qualifiers: S, R, Q This command is used to change the speaker volume for voice calls. Chars Item Format Value Meaning Action/value 0-9, +, - Volume value (0-9) or volume action: + to in- crease, - to decrease.
6.63. ERRORS LIST 6.63 Errors list The following table contains a list of the errors returned by the unit with the ER message. See the ER message for more information.
Page 225
6.63. ERRORS LIST Description Unrecognized command The message is not delimited by and/or ID miss match on incoming postfix “;ID= ” KY miss match on incoming postfix “;KY= ” Not a valid set message. Missing parameter. TAIP console is restricted for this DP. See the locking parameters on the XADP message. Queries resulting on multiple answers are not supported over the air.
Page 226
6.63. ERRORS LIST Continued from the previous page. Description Length exceeded for TX message. See the TX message. Invalid event index when using the XATM message. See the XATM message. Invalid XATM message format. See the XATM message. Invalid reset option. See the RT message. Can not modify a DP using the TAIP console from the same DP.
Appendix A - Quick Start Guide The next two pages are a quick guide for installing and configuring the unit. You can print these two pages and have them at hand.
Appendix B - Getting Started Script Select the following script and paste it on any plain-text editor to create the GettingStarted.tmf script file. #Antares SB script #Getting Started example #Delete any previous configuration >SRT;CONFIG< >SXADP**U< #Unit’s ID >SIDEXAMPLE< #configuring the SIM’s PIN >SRFI1234<...
Appendix C - Signals’ Table For more information on signals refer to the Configuration chapter, Event Machine section. The available signals for the Antares SB are presented in the next table on the next page.
Page 232
Signal Description A00 - A09 Destination Points’ state True when the IP address/port defined on the corre- sponding Destination Point’s index is accepting a TCP connection or when using UDP (i.e. the TCP/UDP socket is open). See the XADP message. B00 - B04 Battery Levels(+) True when the unit’s back-up battery level is above the...
Page 233
(*) Antares SB does not have GPIOs. These signals are maintained for backwards compatibility with scripts from other versions. Instead, Antares SB has 4 inputs and 4 outputs. Signals G00-G03 are the same as IP1-IP4 signals and G04-G07 signals are the same as XP1-XP4 signals. The user is encouraged to use IP and XP signals instead of G signals.
This chapter presents quick examples of the most commonly used TAIP commands. Refer to the Unit’s TAIP reference chapter for detailed infor- mation on a command. 10.1 Setting the Antares SB To set the unit’s ID to AbcD-1234, send: SIDAbcD-1234 10.2 Setting the APN To set the APN to internet.carrier.com, send:...
10.6. RESETING THE GPRS CONNECTION 10.6 Reseting the GPRS connection To reset the GPRS connection, send: SXAGP1 The until will close the GPRS session and will automatically start it again after approximately 1 minute . 10.7 Configuring a host address/type To set IP address 192.168.0.1 working on TCP port 8000 on Destination Point 00, send: SXADP0001192.168.0.1;8000...
10.9. QUERYING HOSTS/PORTS AND TELEPHONES 10.9 Querying hosts/ports and telephones To get a list of hosts, ports with working protocol (TCP, UDP), mode (ACK, no-ACK), and telephones, as well as authorization flags for each host and telephone, send: QXADP 10.10 Grouping AVL servers on DAs To make Destination Address (DA) 4 represent only host address (Destina- tion Point) 00, send:...
10.13. CREATING A TURN-BY-TURN (HEADING CHANGE) REPORT The letter X on the command indicates to generate event reporting mes- sages only to the serial port. 10.13 Creating a turn-by-turn (heading change) report To define a heading-delta change of 45 degrees, send: SXAGH001045 To define event 44 so that it sends a message to the serial port every time the vehicle’s heading delta changes by more than 45 degrees, send:...
10.18. QUERYING THE ANALOG TO DIGITAL CONVERTER 10.18 Querying the Analog to digital converter To query the voltage value at the ADC input, send: QXAAC 10.19 Querying the Internal back-up battery level To query the voltage value and charge level of the internal back-up battery, send: QXABS 10.20...
Need help?
Do you have a question about the Antares SB and is the answer not in the manual?
Questions and answers