User Manual Part 1

ManualsBrandsQuake Global ManualsElectronicsQ4000 / QPRO Satellite Module

CONFIDENTIAL

Information classified Confidential

Do not copy (See last page for obligations)



Summary of content (44 pages)

PAGE 1
Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL
PAGE 2
Information classified Confidential - Do not copy (See last page for obligations) User Guide to Q4000/QPRO CONFIDENTIAL Document #1135-4713 Revision G SENSITIVITY LEVEL: GREEN Document Number 1135-4713 Rev G THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION. IT MAY BE USED BY RECIPIENT ONLY FOR THE PURPOSE FOR WHICH IT WAS TRANSMITTED AND WILL BE RETURNED UPON REQUEST OR WHEN NO LONGER NEEDED BY RECIPIENT.
PAGE 3
User Guide to Q4000/QPRO Revision History Revision Number Description October 2010 A Initial Production Release December 2010 B Add TIME_SYNC event with parameter which specifies the amount of time added to real-time clock. Add description of SMTP message handling when message is too large. Add description of CAN bus loading. Add description of “dR” to save configuration parameters when they are changed. Add note that QCT doesn’t work with Iridium to change Turnkey parameters.
PAGE 4
User Guide to Q4000/QPRO Table of Contents 1 INTRODUCTION .......................................................................................................... 1 1.1 1.2 1.3 1.4 Overview ........................................................................................................................... 1 Scope ............................................................................................................................... 1 Related documents ..............................
PAGE 5
User Guide to Q4000/QPRO 3.1.5 3.2 3.3 GSM/GPRS ............................................................................................................................... 29 Antenna grounding .......................................................................................................... 29 Noise problems ............................................................................................................... 31 4 ACTIVATING AND PROVISIONING THE MODEM .........................
PAGE 6
User Guide to Q4000/QPRO 10.2 Application update ............................................................. Error! Bookmark not defined. 10.3 Parameter update .............................................................. Error! Bookmark not defined. 10.4 Foundation update ............................................................. Error! Bookmark not defined. 10.4.1 Requirements ....................................................................................................................
PAGE 7
CONFIDENTIAL 14.9 MSG_ALERT ................................................................................................................ 136 14.10 MTS_DTR ..................................................................................................................... 137 14.11 MSG_MID_CHANGED ................................................................................................. 137 14.12 MSG_NAK ........................................................................................
PAGE 8
User Guide to Q4000/QPRO APPENDIX F - GLOSSARY OF TERMS ........................................................................ 162 16 ACTIVE GRAVEYARD (WHERE TO PLACE?) ....................................................... 164 16.1 DTR handling (used to be in 9.6 Working with Turnkey) ............................................... 164 CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) 17 LOAD CONDITIONS ..............................................
PAGE 9
User Guide to Q4000/QPRO Figure 2-1: Q4000 assembly data cable .......................................................................................................... 4 Figure 2-2: Q4000 assembly data cable components ..................................................................................... 5 Figure 2-3: Q4000 locking connector ............................................................................................................... 5 Figure 2-4: Q4000 antenna connections ...........
PAGE 10
Figure 12-16: The application was successfully removed ............................................................................. 79 Figure 12-17: Turnkey APL.c file.................................................................................................................... 80 Figure 12-18: Modify Turnkey APL.c by adding a printf statement ................................................................ 81 Figure 12-19: Logger output with "Hello, World!" ........................................
PAGE 11
User Guide to Q4000/QPRO CONFIDENTIAL Table 2-1: Turnkey application parameters ................................................................................................... 15 Table 2-2: Turnkey TK_PARAM_MASK bit fields .......................................................................................... 16 Table 2-3: SMTP and POP configuration parameters ................................................................................... 17 Table 2-4: Turnkey message format ................
PAGE 12
User Guide to Q4000/QPRO 1 Introduction 1.1 Overview The QUAKE Q4000/QPRO is a highly configurable, dual mode solution that is ready for global use. The Q4000/QPRO is designed to communicate with terrestrial GSM cellular network systems when a cellular signal is available, and to slide seamlessly into its back-up mode to communicate with a satellite system when a cellular signal is not available.
PAGE 13
User Guide to Q4000/QPRO Chapter 11: OVER THE AIR UPDATE describes how to update the modem’s firmware remotely using satellite and GSM. Chapter 12: EVENT DRIVEN ARCHITECTURE discusses the various events that make up the software architecture of the Q4000/QPRO modem. Chapter 13: QUAKE FIRMWARE AND API’S discusses the main modules of the modem foundation software and their interactions.
PAGE 14
User Guide to Q4000/QPRO The built-in and on-line help provided by IAR Systems for their Integrated Development Environment (IDE) are valuable references. The API Function Reference listed above [3] is necessary for any custom ‘C’ programming involving calls to supported API functions. It should be viewed as a companion piece to this document. You may obtain the most current version of this document from the QUAKE Global website at www.quakeglobal.com. 1.4 Contacting QUAKE To contact QUAKE Global Inc.
PAGE 15
User Guide to Q4000/QPRO 2 Quick Start Guide The Q4000/QPRO operates from 6VDC to 32VDC. For satellite applications, optimal performance requires at least 10.5 VDC. In order to communicate with the Q4000 or QPRO the following is required: - a computer with at least one available serial port or a USB-to-serial adapter (Keyspan, part number USA-19HS) - a power supply capable of providing at least 3 amps at 12 V - a Q4000 or QPRO assembly data cable - a Q4000 or QPRO modem. 2.1.
PAGE 16
User Guide to Q4000/QPRO Figure 2-2: Q4000 assembly data cable components CONFIDENTIAL Note: Additional serial connections, I/O, and other signal lines are also available as nonterminated wires that come shrink-wrapped together in the assembly cable. Plug the locking connector into the modem. The connector can only fit one way as shown below. Figure 2-3: Q4000 locking connector Note: The AUX port • maximum speed is 57600 bps. • may not be available on certain configurations of the Q4000.
PAGE 17
User Guide to Q4000/QPRO Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL On the opposite side of the modem, attach the antenna cable to the appropriate connector (Figure 2-4). Figure 2-4: Q4000 antenna connections Document Number 1135-4713 Rev G Page 6 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 18
User Guide to Q4000/QPRO 2.1.1.1 Inserting the SIM card in the Q4000 2. Remove screw and washers from side of case. 3. Insert SIM card with the metal contacts facing upward. 4. Ensure SIM card clicks into place. CONFIDENTIAL 1. Find side of case with screw and washers. 5. Replace the washers and screw. Document Number 1135-4713 Rev G Page 7 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 19
User Guide to Q4000/QPRO 2.1.2 Connecting the QPRO Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL The QUAKE part number for the QPRO assembly data cable is QUAKE P/N 1137-0211. Figure 2-5: QPRO assembly data cable There are three main components to the QPRO assembly data cable: 1. the locking connector 2. four serial DB9 connectors for use with the Logger port, MTS, AUX, and GSM 3. power (red) and ground (black) banana plugs.
PAGE 20
User Guide to Q4000/QPRO Figure 2-7: QPRO locking connector 2.1.2.1 Installing the SIM card in the QPRO All SIM cards for the QPRO are installed by QUAKE. For a Development Kit, the SIM card number is available on a white tag connected to the QPRO. 2.2 Serial port connections There are four or five serial ports that come terminated with DB9 connectors: 1. the Logger port - provides diagnostic data for the user 2. the MTS port - implements QUAKE’s Communication Protocol (QCP) 3.
PAGE 21
User Guide to Q4000/QPRO 2.4 Downloading code to the modem The Q4000/QPRO uses two separate code packages: the foundation and the application. The foundation is supplied by QUAKE Global. The application may be written by the user or a third party to perform operations unique to the customer’s requirements. Both can be loaded into the modem using the QUAKE Configuration Tool (QCT).
PAGE 22
User Guide to Q4000/QPRO 2.4.1 QUAKE Configuration Tool (QCT) The QUAKE Configuration Tool (QCT) provides a Graphical User Interface (GUI) to download code and modify configuration parameters in the modem. QCT is available on the Downloads page on the QUAKE website. To download code or modify configuration parameters, load and run QCT on a PC connected to the modem’s MTS serial port. When connecting to the MTS port, the default settings are: 4800 bps 8 None 1 None Figure 2-8: QCT – Initial screen 2.4.
PAGE 23
User Guide to Q4000/QPRO 2. Enter the foundation file’s address and select . Figure 2-10: QCT – Update the firmware (2) CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) 3. QCT starts the firmware update. Power cycle the modem. Figure 2-11: QCT – Update the firmware (3) 4. The progress bar will indicate when the file is loaded.
PAGE 24
Figure 2-12: Completion of successful download (using QCT) 2.5 Logger messages All Q4000/QPRO modems have an RS-232 serial port called the Logger port. This port provides system information so that users can monitor modem operations, and examine variables such as satellite reception, signal strength and message status. The Logger port can be connected to any terminal emulation program, such as Windows HyperTerminal, running on a PC.
PAGE 25
User Guide to Q4000/QPRO included or excluded in the message by setting bits in the message mask, but it is not possible to add additional fields.. Turnkey can be used by customers who need a basic tracking or monitoring system. The application requires only the configuration of message and transmission parameters in order to run. This allows customers to use the Q4000/QPRO as an ‘out of the box’ solution.
PAGE 26
User Guide to Q4000/QPRO 2.6.2 Parameters used by Turnkey: (TK_) and (QCFG_) The Turnkey application uses two different types of parameters: (TK_) and (QCFG_). The parameters unique to the Turnkey application (TK_) are defaulted to send a message every ten minutes. The default message will contain the current time, the GPS location, the value of the Digital I/Os (DIOs) and analog inputs, and Parameter Group Number (PGN) information for PGN 65253.
PAGE 27
User Guide to Q4000/QPRO The TK_PARAM_MASK bit fields are expanded in more detail in Table 2-2 below: Table 2-2: Turnkey TK_PARAM_MASK bit fields Default Value 1 Message counter is incremented for every message sent while the modem is on On 2 Julian time in seconds On 3 Latitude On 4 Longitude On 5 Altitude in meters On 6 Speed in kph On 7 Heading On 8 DIO readings On 9 Unused On 10 Value of Analog0 On 11 Value of Analog1 On 12 CAN data On Unused On 13-32 The Turnkey
PAGE 28
User Guide to Q4000/QPRO Table 2-3: SMTP and POP configuration parameters Value (Hex) QCFG_MODEM_APN_ADDRESS 0x9D orbcomm.t-mobile.com QCFG_SMTP_USER 0xA6 username@gmx.com QCFG_SMTP_PASS 0xA7 password QCFG_POP_USER 0xAC username@gmx.com QCFG_POP_PASS 0xAD password QCFG_SMTP_SERVER_ADDR 0xA4 mail.gmx.com QCFG_POP_SERVER_ADDR 0xAA pop.gmx.com QCFG_SMTP_TO_ADDR 0xA8 username@quakeglobal.com QCFG_SMTP_SUBJ 0xA9 This is a test subject… 2.6.
PAGE 29
User Guide to Q4000/QPRO The following data will be displayed: +qkeca: +qkeca: +qkeca: +qkeca: +qkeca: +qkeca: +qkeca: 2.6.3.1.2 TK_POWER_DOWN_AFTER_MSG=0 TK_XMIT_INTERVAL=60 TK_RX_INTERVAL=0 TK_PARAM_MASK=4294967295 TK_POWER_DOWN_GSM_AFTER_MSG=0 TK_ENABLE=1 TK_PGN0_NUMBER=65263 Via Over the Air (OTA) Note: The SMTP and POP parameters must have been previously configured over the MTS if using GSM/GPRS. CONFIDENTIAL 2.6.3.1.2.
PAGE 30
User Guide to Q4000/QPRO Information classified Confidential - Do not copy (See last page for obligations) attachment file to specify the parameters. The body of the email is blank. Figure 2-14 is an example of the Iridium email. CONFIDENTIAL Figure 2-14: Sending OTA Turnkey parameters via Iridium (email) Figure 2-15 is an example of the attached file.
PAGE 31
User Guide to Q4000/QPRO 2.6.3.2 Setting foundation (QCFG_) parameters The Logger port can be used to change the preferred network designation and also to set the SMTP and POP addresses. 1. Connect a Terminal Emulation program to the Logger port with the following settings: Baud rate: Data bits: Parity: Stop bits: Flow control: 115200 bps 8 None 1 None 2. Type the letters: ‘U’ ‘C’ ‘s’. 4. The new values must be written to flash and the modem must be rebooted to save these new values.
PAGE 32
User Guide to Q4000/QPRO 2.6.
PAGE 33
User Guide to Q4000/QPRO 2.6.6 Turnkey Logger messages 2.6.6.1 Turnkey messages at boot up When the modem boots with the Turnkey application loaded, the current settings of the Turnkey parameters will be displayed on the Logger port. If SMTP and POP addresses are configured, they will be displayed also. This log information provides the dates and version numbers of the QUAKE Turnkey and foundation code, as well as the values for Turnkey parameters and SMTP and POP address information.
PAGE 34
User Guide to Q4000/QPRO Parameter names and current settings are: TK_POWER_DOWN_AFTER_MSG 0 TK_XMIT_INTERVAL 60 TK_RX_INTERVAL 0 TK_PARAM_MASK 0xffffffff TK_POWER_DOWN_GSM_AFTER_MSG 0 TK_ENABLE 1 TK_PGN0_NUMBER 65263 TK: ORBCOMM Modem Startup TK: TERR Modem Startup ---accessPointName = orbcomm.t-mobile.com ---serverName = mail.gmx.com ---serverPort = 25 ---smtpUser = quaketest11@gmx.com ---smtpPass = Quaketest11 ---smtpToAddress = jlitvak@quakeglobal.
PAGE 35
User Guide to Q4000/QPRO QUAKE Global evaluation and development kits include a demo account that can be activated for at least 60 days and will allow unlimited ORBCOMM or Iridium satellite data to be sent and received during this time. The GPRS data plan must be provisioned by the customer. Contact customersupport@quakeglobal.com for more information on provisioning for evaluation and development kits.
PAGE 36
User Guide to Q4000/QPRO 2.8.2 Power off There are a number of ways in which a controlled power-down sequence can be initiated on the Q4000/QPRO modem: • through a QCP call on the MTS port; • function calls from custom applications written in ‘C’ can be used to initiate controlled power downs from an internal application. Both QCP and the “C” programming library utilize the function “SYS_pwrDownModem(duration)”.
PAGE 37
User Guide to Q4000/QPRO 3 Antenna setup 3.1 Antenna recommendations 3.1.1 ORBCOMM 3.1.1.1 Voltage Standing Wave Ratio (VSWR) CONFIDENTIAL • • • 1:1 – best case. This is a perfect match between the cable and antenna. 1.5:1 – good. > 2:1 – poor match. The antenna is both not receiving signals as efficiently as possible, and is prevented from radiating as much power as the transmitter PA is capable of putting out. We recommend using an antenna with less than 2:1 VSWR.
PAGE 38
User Guide to Q4000/QPRO The figure below shows a typical Orbcomm satellite pass: CONFIDENTIAL Note that in the figure below, the area of weakest radiation is directly above 90° using a whip antenna. The area of strongest radiation is at 1/2Ȝ. The gain increases as the angle approaches 0. The size of the ground plane affects the look angle of the antenna pattern. Maximum gain is at 10° - 30° above ground plane.
PAGE 39
Information classified Confidential - Do not copy (See last page for obligations) User Guide to Q4000/QPRO CONFIDENTIAL Figure 3-3: Ground Plane Frequency 137-138 MHz 148-150 MHz λ 2.2 m 85.9 in 2m 79.3 in λ /2 42.9 in 39.6 in λ /4 21.5 in 19.8 in Table 3-2: Antenna wavelength and gain Antenna Gain (dB) Whip ¼, 1/2 , 5/8 Unity (0) 1/8 -4dB Low Profile -2 to -4 Quad-Helix +3 Dipole * +3 to +6 3.1.2 GPS The GPS antenna should be 3.3 VDC active.
PAGE 40
User Guide to Q4000/QPRO 3.1.3 Iridium Iridium Antennas must be approved by Iridium before being used on the Iridium network. A list of approved antennas can be found on Iridium’s home page at www.iridium.com. When selecting an Iridium antenna, make sure it is a 50 ohm, Gain 3dBi maximum, polarization Right Hand Circular Polarized (RHCP) and VSWR 1.5:1 or better (in both receive and transmit bands) for optimal messaging.
PAGE 41
User Guide to Q4000/QPRO Information classified Confidential - Do not copy (See last page for obligations) Beware of high power antennas, urban canyons and other structures that block the line of sight (LOS) to the satellite. Below are some antenna installation mishaps: CONFIDENTIAL Figure 3-4: Antennas with blocked view of sky Figure 3-5: Tipped over antenna Document Number 1135-4713 Rev G Page 30 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 42
User Guide to Q4000/QPRO 3.3 Noise problems Figure 3-6: Noise - radiated and conducted Noise suppression parts include ferrite beads, EMI cores and RF filters. Techniques include twisting power lines, separating power from signal, using right angles, covering the band of interest and double wrapping wire and placing it near the noise source. Document Number 1135-4713 Rev G Page 31 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 43
User Guide to Q4000/QPRO 4 Activating and provisioning the modem Each Q4000/QPRO must be provisioned and activated on the network(s) supported by the modem. Modems purchased with QUAKE Global Development Kits are supplied with two months of free airtime on the ORBCOMM or Iridium satellite networks. Otherwise, the customer is responsible for activating and provisioning the modem(s). The following information is required for provisioning and activation. ORBCOMM 4.1.
PAGE 44
User Guide to Q4000/QPRO Delivery plan – Delivery plan details how ORBCOMM attempts to deliver messages to the modem. There are 4 different Delivery Plans: 1. Automatic delivery attempts: the number of times immediately upon receipt and at one-minute intervals that the ORBCOMM Gateway attempts to deliver a modemterminated message. 2. Time to hold: the maximum time the ORBCOMM Gateway holds the message before returning it as undeliverable. 3.