User Manual Part 6

ManualsBrandsQuake Global ManualsElectronicsQ4000 / QPRO Satellite Module

User Guide to Q4000/QPRO

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. DISCLOSURE TO UNAUTHORIZED THIRD PARTIES OR DUPLICATION WITHOUT THE EXPRESS WRITTEN PERMISSION OF QUAKE

GLOBAL IS PROHIBITED.

Page 140

CONFIDENTIAL

Information classified Confidential

Do not copy (See last page for obligations)

14.25 SPEED_ALARM

A GPS measurement completed and a speed violation occurred. The parameter [0-15] indicates

which Sensor Table was used.

14.26 TIMER

This occurs when a software timer expires. The parameter [0-39] indicates which timer expired.

Timers may be set, examined and read using function calls such as TIMER_set(),

TIMER_clear(), TIMER_checkWakeup(), TIMER_setDuration() and

TIMER_getRemaining(). Note that in making calls to the timer utilities, a particular timer must

be selected. It is important to select a timer with the appropriate type for the intended use. The

types and properties of all timers are shown in Table 14-1.

Table 14-1: Timer types and properties

Timer



Numbers



Timer Type



Description / Notes



Volatile



Value and status of these timers are lost when the modem powers

down. These timers should be used for general purpose timing

requirements. On power-up, all Volatile timers are set to disabled.



Non

Volatile



Value and status of these timers are stored in NVM. This type of timer is

used when timing data relating to an event or action must be maintained

during power off. When a Non-Volatile timer expires, it does not cause a

wake up of the modem, but does cause a timer event to be sent to the

application on the next power on.



Wake



Wake-up timers are like nonvolatile timers, except that when a power

down is called, the Real-Time Clock (RTC) is programmed to wake up at

the timer expiration time (if this time is less than the specified power

down interval).



Time

Day



These timers are identical to Wake-Up timers, except that the duration of

the timer is specified as an absolute time of day rather than relative to

the current time. Time-Of-Day Timers always expire within 24 hours.



14.27 TIME_SYNC

The time has been received from a source such as a satellite or GSM and the real-time clock has

been updated to the new time. Parameter one is the value of the change and should be

converted to a signed 32 value to ensure negative adjustments are accounted for.

Summary of content (27 pages)

PAGE 1
User Guide to Q4000/QPRO 14.25 SPEED_ALARM A GPS measurement completed and a speed violation occurred. The parameter [0-15] indicates which Sensor Table was used. 14.26 TIMER CONFIDENTIAL Table 14-1: Timer types and properties Timer Numbers Timer Type Description / Notes 0 - 9 Volatile Value and status of these timers are lost when the modem powers down. These timers should be used for general purpose timing requirements. On power-up, all Volatile timers are set to disabled.
PAGE 2
User Guide to Q4000/QPRO 14.28 USER_CMD An Over-The-Air command was received. The parameter [0-255] indicates which action to take. This is currently supported for ORBCOMM and GSM/GPRS networks. When a USER_CMD is sent, byte 0 of the data represents how many user commands will be sent. This is based on User Data Bytes 1-4 content in conjunction with User Byte 0’s value. For example, using: USER DATA BYTES 0 1 2 3 4 • One USER_CMD event would be sent to the application. • It would be USER_CMD 255.
PAGE 3
User Guide to Q4000/QPRO 15 QUAKE firmware and APIs CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) Figure 15-1 shows the software architecture of the modem. The customer can write applications that reside in the user space of the modem. The application makes use of the QUAKE Application Programming Interface (API) to connect to the various tasks and drivers operating on the modem.
PAGE 4
User Guide to Q4000/QPRO Please see the API Function Reference for detailed explanations on how to make function calls to all the various tasks, drivers and objects operating on the modem. • QUAKE Real-Time Operating System (RTOS) • QUAKE Flash File System (FFS) • Hardware drivers ( ADC, DIO, Relay, Serial Ports, GPS, etc.
PAGE 5
User Guide to Q4000/QPRO 15.4 FFS module (Flash) The Q4000/QPRO uses a FLASH File System (FFS). This FFS was designed specifically to be robust and immune to problems encountered during uncontrolled power downs. FFS calls are abstracted through a QUAKE FFS_ layer similar to the SYS layer, with calls such as FFS_open(), FFS_read(), FFS_write(), FFS_close(). The application does not need direct access to the FFS.
PAGE 6
User Guide to Q4000/QPRO An ORBCOMM packet is constructed specifying a particular type of ORBCOMM message, based on packet descriptions in the ORBCOMM Serial Interface Specification. The packet is queued to the OSI using MSG_queueOsiPkt(). The module contains utilities as well as functions to read and write ORBCOMM parameters (CFG_getValOrb()and CFG_setValOrb()).
PAGE 7
User Guide to Q4000/QPRO complete with the name of the function in which the error occurred, the line number, and a string identifying the type of error. Note: The message packet should not be freed by the application; this is done by the foundation code. The QMM module implements QUAKE’s Message Manager. The firmware code in the module checks for network availability, and handles the details of transferring messages from one network to another based on availability.
PAGE 8
User Guide to Q4000/QPRO 15.17 UART module The UART module provides direct access to the serial hardware on the Q4000/QPRO. Application access to the serial ports should be made through the SERIAL module, described in Section 15.15. SERIAL allows the foundation firmware to exercise more control and oversight. For those applications requiring more direct access, the public API to the UART module is UART_ioctl(), which allows the parity, stop bits and baud rate to be set for serial ports. 15.
PAGE 9
User Guide to Q4000/QPRO Appendix A - ORBCOMM configuration parameters Table A-1: ORBCOMM configuration parameters Name Def. Value Min Value Max Value DTE Access Description Personal Identification Number, used 0x00 pin_code 1234 0 9999 R/W as a security measure Instructs modem to acquire satellite 1 (U.S.) 0x01 desired_gwy_id 0 255 R/W connected to this ORBCOMM Gateway Additional notes: This parameter should be set according to where the application/modem will be located.
PAGE 10
User Guide to Q4000/QPRO Def. Min Max DTE Description Value Value Value Access Additional notes: This parameter defines the way in which the modem will connect to satellites as they come into view. It works in conjunction with parameter 0x01 (desired_gwy_id). By default the modem will only connect to satellites that are attached to the desired gateway.
PAGE 11
User Guide to Q4000/QPRO Def.
PAGE 12
Num Name Def. Value Min Value Max Value DTE Access 0x32 sw_version --- --- --- R 0x33 hw_version --- --- --- R Numb er Name Def. Value Min Value Max Value DTE Access Description Modem software version. For example, July 5, 2005 will return decimal 7055. NOT SUPPORTED Description modem Serial Interface Specification revision supported 4: QUAKE Global, Inc. NOT SUPPORTED Most recent downlink channel NOT SUPPORTED NOT SUPPORTED 0. Receiver OFF 1. Listen to DL 6/16 2.
PAGE 13
User Guide to Q4000/QPRO Appendix B - QUAKE’s ORBCOMM configuration parms (QCFG) Table B-1: QUAKE’s ORBCOMM configuration parameters Def Val 4 0 Min Val 0 0 Max Val 6 1 0x82 QCFG_TL_LOGGING 0 0 1 0x83 QCFG_DLEVPROC_LOG_LEVEL 0 0 5 0x84 QCFG_ULMGR_LOG_LEVEL 0x85 QCFG_SPP_LOG_LEVEL 0 0 0 0 5 5 0x86 QCFG_MODEM-TMGR_LOG_LEVEL 0 0 5 0x87 QCFG_MODEM_LOG_LEVEL 0x88 QCFG_OSPM_LOG_LEVEL 0 0 0 0 5 5 0x89 QCFG_MSN_SAVE_OPTION 0 0 1 0x8b QCFG_MTS_AUTO_ROAMING_ENA 0 0 1 0x8c QCFG_QLM_LOG_
PAGE 14
User Guide to Q4000/QPRO CONFIDENTIAL 0x99 QCFG_MODEM_APN_PASS 0x9a QCFG_OSI_IB_ROUTE Def Val None 1 Min Val Max Val DTE Description Access User password if required R/W Route inbound messages/commands to: 0=Application; 1=Transport Layer; 2=Both 0x9b QCFG_MODEM_BAND 3 0 3 Not supported 0x9d QCFG_MODEM_APN_ADDRESS Network provider name. Default: ORBCOMM.tmobile.com 0x9e QCFG_MODEM_CONNECT_DUR_S 90 0 65535 If there’s no data exchange within this timeout period (seconds) the connection is closed.
PAGE 15
User Guide to Q4000/QPRO 0xae 0xaf 0xb0 0xb1 0xb2 0xb3 QCFG_GLSS_CHAN QCFG_GLSS_RETRY_COUNT QCFG_GLSS_MIN_INTERVAL_S QCFG_GLSS_MAX_INTERVAL_S QCFG_MDMIF_IRI_PORT QCFG_AUX_BAUD_RATE 0xb4 QCFG_MTS_BAUD_RATE 0xb5 QCFG_POWER_DOWN_MODE DTE Description Access R/W R/W R/W R/W R/W R/W GlobalStar channel GlobalStar retry count GlobalStar minimum interval GlobalStar maximum interval Iridium port Note that the maximum speed of the AUX is 57600 bps 1200 115200 R/W 0 1 R/W 1=power down when DTR goes low 1.2.
PAGE 16
User Guide to Q4000/QPRO Appendix C - QUAKE’s Iridium & Inmarsat config parms (QCFG) Table C-1: QUAKE’s Iridium and Inmarsat configuration parameters Name Def Val 4 Min Val 0 Max Val 6 Access 0x81 QCFG_GPS_LOGGING 0 0 1 R/W 0x82 QCFG_TL_LOGGING 0 0 1 R/W 0x83 QCFG_DLEVPROC_LOG_LEVEL 0 0 5 R/W 0x84 QCFG_ULMGR_LOG_LEVEL 0 0 5 R/W 0x85 QCFG_SPP_LOG_LEVEL 0 0 5 R/W 0x86 QCFG_MODEM-TMGR_LOG_LEVEL 0 0 5 R/W 0x87 QCFG_MODEM_LOG_LEVEL 0 0 5 R/W 0x88 QCFG_OSPM_LOG_LEVEL 0 0
PAGE 17
User Guide to Q4000/QPRO Name Def Val 3 Min Val 0 Max Val 3 0x9e QCFG_MODEM_CONNECT_DUR_S 90 0 65535 0x9f QCFG_EXT_MODEM_ID_INTERVAL 0 0 65535 R/W 0xa0 QCFG_MDMIF_BAUD_RATE 0xa1 QCFG_REQUEST_GLOBALGRAMS 0 0 1 R/W 0xa2 QCFG_POS_FILTER_MAX_VEL 50 0 65535 R/W 0xa3 QCFG_POS_FILTER_MAX_DIFF 25 0 100 R/W 0 65535 CONFIDENTIAL 0x9b QCFG_MODEM_BAND 0x9d QCFG_MODEM_APN_ADDRESS DTE Access 0xa4 QCFG_SMTP_SERVER_ADDR None 0xa5 0xa6 0xa7 0xa8 QCFG_SMTP_SERVER_PORT QCFG_SMTP_USER QCFG
PAGE 18
User Guide to Q4000/QPRO Appendix D - Debug and utility menus QUAKE Global provides a large group of debug and utility menus which are accessible via the Logger port. These menus allow the user to send and receive messages and email, view operational performance, conduct serial tests and many more functions. Some of the menus require a password and are accessible to QUAKE personnel only.
PAGE 19
User Guide to Q4000/QPRO Information classified Confidential - Do not copy (See last page for obligations) Additional utility commands are available by typing ‘U’ ‘?’: CONFIDENTIAL Figure E- 2, Debug menus available from 'U' '?' Note: See section 7.2.1 for examples of using the menu commands on the Logger port. Document Number 1135-4713 Rev G Page 158 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 20
User Guide to Q4000/QPRO Appendix E - Software file naming convention The name of a code file follows the format: --aa.bb.cccc.dd-.
PAGE 21
User Guide to Q4000/QPRO • Table E-3 • aa is the Major version • bb is the Minor version • cccc is the Subversion build • dd is the Coverity Checker ID • File Identifier is defined in Table E-4 Example: CONFIDENTIAL Table E-1: File naming – Product label Product Label Description Q4K Q1K QPRO (for applications and foundation code produced before 4/9/2011) Q4000 Q1000 QPRO-3G Q4KI (for applications produced before 4/9/2011) Iridium application Table E-2: File naming – File type File
PAGE 22
User Guide to Q4000/QPRO Table E-3: File naming – Hardware features label Hardware Features Label ONN Description ORBCOMM GGT HGT IGT H3T JGT Globalstar, GSM, Trimble ORBCOMM, GSM, Trimble Iridium, GSM, Trimble ORBCOMM, 3G, Trimble InmarSat, GSM, Trimble Description ENC an encrypted, loadable image the name of the application. If the app is customer-specific image the value will be the customer name.
PAGE 23
User Guide to Q4000/QPRO ADC API BPS CAN CD CR DIO DTE DTR EDA FFS FTP GPRS GPS GSM GUI ICD IDE IMS LEO LF LSB MHz MID MO MT MTS NCC NVM O/R OSI OTA PGN POP QCFG QCP QCT QFFS QMM QRTOS RPM RTC RTOS Analog to Digital Converter Application Programming Interface Bits per Second Controller Area Network Carrier Detect Signal Carriage Return Digital Input/Output Data Terminal Equipment Data Terminal Ready signal Event Driven Architecture Flash File System File Transport Protocol General Packet Radio Service Glo
PAGE 24
User Guide to Q4000/QPRO Society of Automotive Engineers Short Burst Data Simple Mail Transfer Protocol Universal Asynchronous Receiver/Transmitter Voltage Standing Wave Ratio Very High Frequency CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) SAE SBD SMTP UART VSWR VHF Document Number 1135-4713 Rev G Page 163 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
PAGE 25
User Guide to Q4000/QPRO 16 Active Graveyard (where to place?) CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) 16.1 DTR handling (used to be in 9.6 Working with Turnkey) Document Number 1135-4713 Rev G Page 164 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 26
User Guide to Q4000/QPRO 17 Load conditions • send messages on the GSM/GPRS port at 115200 bps continuously • send messages via satellite network continuously • use MTS port at 115200 bits per second (bps) • use AUX port at 115200 bps The AUX port • maximum speed is 57600 bps • may not be available on certain configurations of the Q4000/QPRO. The Q4000/QPRO with Iridium or Inmarsat, for example, does not have the AUX port available.
PAGE 27
User Guide to Q4000/QPRO Confidentiality obligations This document contains sensitive information and is classified “CONFIDENTIAL”. Its distribution is subject to the recipient’s signature of a Non-Disclosure Agreement (NDA). At all times you should comply with the following security rules (Refer to the NDA for detailed obligations): This document may not be altered in any way that removes or obscures the Confidentiality notices. Keep this document locked away.