User Guide to Q4000/QPRO 4.3.2 Provisioning • with one to five email/ID addresses. Each modem-originated message is sent to all the email addresses with which the modem is provisioned. • to work with Iridium’s Direct IP gateway. Messages are sent directly to and from the server(s) of the customer backend over a TCP connection. • to send messages to another Short Burst Data modem with an IMEI number or to itself (for testing purposes). • to receive Geodata and Ring Alerts.
User Guide to Q4000/QPRO CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) The SkyWave IsatData Pro network records the registration message and forwards it to the user’s application. The network then sends an acknowledgement message over the satellite to the modem. The modem is now ready to send and receive messages. Document Number 1135-4713 Rev G Page 35 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) User Guide to Q4000/QPRO Figure 4-1: Inmarsat activation process Document Number 1135-4713 Rev G Page 36 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.
User Guide to Q4000/QPRO 5 Logger messages Log messages are continuously printed to the Logger port on the modem. The level of detail of the log messages may be adjusted with the QCFG_debug_level_parameter (0x39). The default level is set to 4. This parameter may be changed via the Logger port by typing ‘d’ ‘e’ and a number between 1 and 6. The higher the number, the more detailed the log messages. ORBCOMM The receiver is normally in one of two modes: Acquire or Receive.
User Guide to Q4000/QPRO 5.1.2 Receive mode If the modem is in Receive mode, the receiver has acquired a satellite. When in this mode, a typical message sent to the Logger would be: Rx[26Jun02 22:30:06|11.00] Sync(23* 285 04): Dplr -2448 Pwr -103 Ebno 15.8 0/50 • Rx: Indicates a satellite signal is being received. • 26Jun02 22:30:06: GMT according to the satellite. • 11.00: Indicates how many seconds the modem has been receiving from the current satellite.
User Guide to Q4000/QPRO 5.2.4 Mailbox check Rx[IRI]+SBDIX: 32, 415, 2, 0, 0, 0: This is a mailbox check and the network response (32) indicates that an invalid response from the network was received. Rx[IRI]+SBDIX: 0, 415, 1, 44, 156, 3: This mailbox check with a network response of (0) indicates that a valid response from the network was received. 5.
User Guide to Q4000/QPRO 6 QUAKE Communication Protocol (QCP) QCP mode is used to send data via AT commands or SLIP/RPC packets to the modem. API commands can be used in ‘C’ programs. There is a subset of APIs called QCP commands that are used in both ‘C’ programs and the QUAKE version of AT commands. QCP commands can be used to control the Q4000/QPRO externally with a DTE Processor.
User Guide to Q4000/QPRO foundation code. Passthrough mode is implemented with QCP commands and Direct mode is implemented with API commands. ¾ Passthrough mode connects the modem’s MTS serial port directly to either the satellite or GSM/GPRS modules in the modem. The QCP commands: • IRI_passThrough • INMR_passThrough, and • TERR_passThrough can be used to turn on Passthrough mode. Direct mode connects the user’s application to the satellite modules.
User Guide to Q4000/QPRO 7 Configuration parameters There are a number of parameters that may be configured as part of the modem’s foundation code. These parameters control logging, auto-roaming, baud rates, satellite network operations, SMTP and POP addressing, and other modem functions. In general, the foundation configuration parameters should be left at their default values, as these are appropriate for the majority of applications.
User Guide to Q4000/QPRO 7.2 QUAKE Configuration Parameters (QCFG) QUAKE uses parameters 0x80 – 0xFF. All these parameters have “QCFG_” as a prefix. For a complete list of the QCFG parameters, see Appendix B - QUAKE’s ORBCOMM configuration parms (QCFG) and Appendix C - QUAKE’s Iridium & Inmarsat config parms (QCFG). There are several ways to modify QCFG parameters. They can be modified via: • debug menus on the Logger port • QCP protocol on the MTS port • API calls made by a user’s application.
User Guide to Q4000/QPRO Type the following to obtain the output below: CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) “U” “C” “v” Figure 7-1: QCFG parameter list Document Number 1135-4713 Rev G Page 44 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.
User Guide to Q4000/QPRO 7.2.1 Changing QCFG parameters 7.2.1.1 Change via the Logger port U ***Utility Mode enabled*** (will expire in 20 Secs) C NOTE: Please conduct a controlled power down to ensure changes to configuration parameters are committed to flash memory.
User Guide to Q4000/QPRO Now type: AT+QKEFCN CFG_setNumericQCP, parmName, parmValue Figure 7-2: Using QCP to change a numeric parameter CONFIDENTIAL To change the value of a string parameter, type: AT+QKEFCN CFG_setStringQCP, parmName, parmValue This will change the parameter and save it to memory. See the example in the screen below, where the parameter QCFG_SMTP_SERVER_ADDR is given the value “mail.gmx.com”: Figure 7-3: Using QCP to change a string parameter 7.2.1.
User Guide to Q4000/QPRO 7.2.2 GPRS network parameters GPRS uses the following QCFG parameters: Table 7-1: GSM parameters Parm Name # 0x9d QCFG_MODEM_APN_ADDRESS Description Default Value Min Max Network provider name ORBCOMM.tmobile.com 0x98 QCFG_MODEM_APN_USER User login name (if required) [None] 0x99 QCFG_MODEM_APN_PASS User password (if required) [None] 0x9e QCFG_MODEM_CONNECT_DUR_S If there is no data exchange 0 65535 CONFIDENTIAL Note: 7.2.
User Guide to Q4000/QPRO In order to receive unsolicited GSM/GPRS messages on the modem, such as parameter updates, the following QCFG parameters must have valid values: Table 7-3: POP parameters Name Description Default Value 0xaa QCFG_POP_SERVER_ADDR Address of POP server [None] 0xab QCFG_POP_SERVER_PORT POP server port (usually 25) 25 0xac QCFG_POP_USER POP account user name [None] 0xad QCFG_POP_PASS POP account password [None] Min Max 0 65535 CONFIDENTIAL Information classified Co
User Guide to Q4000/QPRO 8 Installing the IAR Integrated Development Environment Code for the Q4000/QPRO modem is developed on the IAR Systems Embedded Workbench. This is a fully Integrated Development Environment (IDE) containing an optimized C compiler, assembler, linker, text editor and associated tools. QUAKE software follows open industry standards whenever possible to allow existing ‘C’ code to port over easily.
User Guide to Q4000/QPRO application. Information classified Confidential - Do not copy (See last page for obligations) 2. Select the (unzipped) Figure 8-3: IAR unzipped files screen and follow the installation wizard. CONFIDENTIAL 3. Select Figure 8-4: IAR Workbench Welcome menu Document Number 1135-4713 Rev G Page 50 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
User Guide to Q4000/QPRO The installer opens a window asking you to remove the IAR dongle from your computer if it has been plugged in at the time of installation. Figure 8-5: IAR dongle driver installation . Information classified Confidential - Do not copy (See last page for obligations) 4. Remove the IAR dongle if it is plugged in, then click . CONFIDENTIAL 5. When the installation is complete: • plug in the dongle • click . .
User Guide to Q4000/QPRO CONFIDENTIAL Information classified Confidential - Do not copy (See last page for obligations) 6. The IAR Workbench will start. Figure 8-7: IAR Information screen Document Number 1135-4713 Rev G Page 52 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.
User Guide to Q4000/QPRO Once the installation is finished you need to complete the registration. The registration can be done at: www.iar.com/register. The information that you provide in the registration is needed in order to have IAR generate a permanent license key for the software and a MyPages account for you. The MyPages page at www.iar.com can be used to download different versions of the IAR IDE.
• After the registration is submitted, IAR will need to process it before you can have access to MyPages. This process generally takes 1-2 business days. Once IAR completes the registration you will receive an email with the permanent license key. • With the permanent license key, go directly to the MyPages login screen: www.iar.com/mypages and enter your email address into the “Don’t have an account?” box. The system will automatically email your login and password information to you.
User Guide to Q4000/QPRO 9 Communicating with the modem 9.1 Sending email to the modem The modem can detect some special emails to download new foundation software or reboot (see Chapter 10 Over the Air (OTA) software update). The user application has access to configuration parameters for SMTP and POP addresses, usernames and passwords. The Internet Service Provider (ISP) should provide information on setting up accounts for SMTP and POP, similar to personal email. CONFIDENTIAL Note: 9.1.
User Guide to Q4000/QPRO Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL Figure 9-1Error! Reference source not found. is an example of an email to modem “qwaketest029.” Figure 9-1: Orbcomm email to a modem Document Number 1135-4713 Rev G Page 56 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
User Guide to Q4000/QPRO 9.1.2 Iridium Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL Iridium emails to a modem are always sent to the same address: data@sbd.iridium.com. The subject of the email MUST be the modem’s IMEI number, which is printed on the modem’s white label. Data to the modem are sent as a file attachment to the message. Figure 9-2 is an example of the email.
User Guide to Q4000/QPRO 9.1.3 GSM/GPRS Email to a modem using GSM/GPRS has an address specified by the configuration parameters and the network being used. For example, with the configuration parameters shown below, an email from the gmx.com server to a modem would have the format username@gmx.com. CONFIDENTIAL Name Value (Hex) Sample Values 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.
User Guide to Q4000/QPRO 10 Over the Air (OTA) software update 10.1 Introduction The Q4000/QPRO can update its foundation, application or configuration parameters over a GSM/GPRS network without the need to physically connect the modem to a terminal. The firmware update request is initiated by sending an unsolicited POP email or satellite message to the modem. With the correct subject line in the message, it will bypass the application and direct the foundation to begin an FTP transfer via GSM/GPRS.
User Guide to Q4000/QPRO • must be Plain Text (not HTML or Rich Text). • must have the subject line: FIRMWARE UPDATE. • should contain the following tokens in the email body: o Server: name of the FTP server o Port: port of the FTP server o Username: used to access the FTP server o Password: used to login to the FTP server, or valid text for anonymous access o File: full path and file name of the file that is to be downloaded o Retry: number of times to retry download if it fails.
User Guide to Q4000/QPRO 10.1.3 Steps 1. Place the new firmware image on the FTP server. TO: (SMTP/POP account) test11@server.com SUBJECT: FIRMWARE UPDATE (this is case-sensitive!) BODY: Server:yourftpserver.net Port:21 Username:user@yourftpserver.net File:/firmware.bin Password: password Retry:2 CONFIDENTIAL 3. The modem receives the update email by receiving a modem-terminated satellite message or by checking the POP account.
User Guide to Q4000/QPRO 10.1.4 Output Table 10-2 lists the common status emails sent by the modem after completing the firmware update process. Email Content Explanation OK (No error) Firmware has been successfully downloaded and stored in modem. However, if the downloaded firmware is incorrectly compressed and encrypted, it will not be started by boot loader. Modem is busy serving previous request Another firmware update process is ongoing.
User Guide to Q4000/QPRO 11 Network Independent Message Manager (NIMM) The Q4000 supports the ability to send messages independent of a specific network and independent of any particular protocol. This Network Independent Message Manager (NIMM) system consists of a single API to send messages for any configured network, and a mechanism to update the configuration file at any time. Note: 11.1.
User Guide to Q4000/QPRO NETWORK_TERR, NETWORK_TERR, NETWORK_TERR, NETWORK_TERR, NETWORK_ORB, NETWORK_ORB, NETWORK_ORB, NETWORK_ORB, NETWORK_ORB, NETWORK_IRI, NETWORK_IRI, NETWORK_INMR, NETWORK_INMR, Protocol TERR_UDP, TERR_TCP, TERR_SMTP, TERR_SMS, ORB_REPORT, ORB_DEFAULT_MESSAGE, ORB_MESSAGE, ORB_DEFAULT_REPORT, ORB_GLOBAL_GRAM, IRIDIUM_TEXT, IRIDIUM_BINARY, INMARSAT_TEXT, INMARSAT_BINARY, Max Size UNLIMITED, UNLIMITED, UNLIMITED, 168, 6, 8192, 8192, 6, 229, IRI_MAX_MO_BUF_LEN, IRI_MAX_MO_BUF_LEN, INMR
User Guide to Q4000/QPRO 12 Sample applications • Turnkey - demonstrates the event-driven architecture of the Q4000/QPRO. This application can be used to send a message which can be modified by changing various configuration parameters. • QuickStart – is a basic, minimal template for developing software embedded on the Q4000/QPRO. • DemoAppXXX - highlights different aspects of the Q4000/QPRO’s feature set.
Figure 12-1: The QUAKE API documentation webpage The API Function Reference lists all of the different types of calls, including those dealing with tasks, message transfers, GPS, serial interfaces and system time. The API_Parser_Output folder included in the Application Files download contains the same information that is on the website. 12.2 Turnkey application The sample applications and associated documentation are available on the QUAKE Global website at www.quakeglobal.com: 1.
User Guide to Q4000/QPRO CONFIDENTIAL Figure 12-2: API_Files_and_Manual.zip Note: You will see a folder for either APL_Iridium, APL_Orbcomm, APL_Inmarsat or APL_Globalstar, depending on your choice of satellite network. The following pages show examples using APL_ORBCOMM, but they also apply to the other satellite networks. Document Number 1135-4713 Rev G Page 67 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
User Guide to Q4000/QPRO 12.2.1 Compiling Turnkey Figure 12-3: Turnkey application workspace in the IAR IDE The files in this directory comprise an IAR compiled project that consists of a number of applications (Turnkey, DemoAppCAN, DemoAppFFS, etc.). Each of these applications demonstrates some capacity of the Q4000/QPRO product. The applications are supplied as templates for building custom applications in this project environment.
User Guide to Q4000/QPRO To build the Turnkey project: Information classified Confidential - Do not copy (See last page for obligations) CONFIDENTIAL 1. Select the Project drop-down menu and select Make, or use the F7 key as a shortcut to build the project. Figure 12-4: Project menu Document Number 1135-4713 Rev G Page 69 THIS DOCUMENT CONTAINS CONFIDENTIAL AND PROPRIETARY INFORMATION OF QUAKE GLOBAL CORPORATION.
