User Manual Part 2

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 65
CONFIDENTIAL
Information classified Confidential
-
Do not copy (See last page for obligations)
12 Sample applications
The simplest approach to programming Q4000/QPRO modems is to use the sample ‘C’ code
applications supplied at www.quakeglobal.com under Downloads/Application Files. These
include the following:
• 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.
These sample applications provide a starting point for building more complex custom
applications. All the examples use QUAKE’s event-driven architecture which is discussed in
more detail in Chapter 14. When various events such as a POWER_ON or GPS POSITION_FIX
occur, the foundation code detects the change and posts the event to the application. The
application determines its response based on the type of event.
12.1 Accessing the QUAKE Application Programming Interface (API)
The QUAKE API gives information on all the function calls used in the sample applications.
These are the building blocks for any user application. It is accessible from the API tab on the
website. The downloadable version of the API is available by following these steps: go onto the
QUAKE website: www.quakeglobal.com
• log in to your account
• select the Downloads tab
• select the “Application Files” link for your modem
• save, and then extract the zip file
• open the “API_Parser_Output” folder
• open the index.html file.