Module Name: gpsapi.h
Abstract: Contains types and prototypes for GPS API
This file contatins definitions for all of the generic GPS functions. These functions have the prefix Gps.
| Function | Description |
| GpsCheckForData | Palm Specific calls |
| GpsEnable | Enables or disables communication with the GPS device |
| GpsEnableAutoDetect | Enables or disables auto detect |
| GpsGetAltitude | Returns the current height above mean geoid in meters |
| GpsGetAltitudeEx | Gets the height above mean geoid in meters |
| GpsGetBaudRate | Returns the current baud rate used to communicate with the GPS receiver |
| GpsGetCourseOverGoundTrueEx | Gets the true course over ground in radians |
| GpsGetCourseOverGroundTrue | Gets the true course over ground in radians. |
| GpsGetData | Returns all available GPS data |
| GpsGetDataBuffer | Returns the latest raw data received from the GPS device |
| GpsGetDOP | Returns all current dilution of precision values |
| GpsGetEPE | Returns the Estimated Position Error |
| GpsGetFixType | Returns the type of solution that the GPS receiver has calculated |
| GpsGetHDOP | Returns the Horizontal Dilution Of Precision |
| GpsGetHDOPEx | Returns the HDOP |
| GpsGetLatitude | Returns the current geodetic latitude |
| GpsGetLatitudeEx | Gets the current Geodetic Latitude |
| GpsGetLongitude | Returns the current geodetic longitude |
| GpsGetLongitudeEx | Gets the current geodetic longitude |
| GpsGetPort | Returns the current communications port used to communicate with the GPS receiver |
| GpsGetPortList | Returns a list of names of the available communications ports |
| GpsGetPosition | Returns the current position including latitude and longitude as well as the current altitude and ground speed |
| GpsGetPositionEx | Gets the current position information |
| GpsGetProtocol | Returns the current protocol being used by the GPS Toolkit |
| GpsGetQuality | Returns the quality of the GPS data fix |
| GpsGetReceiver | Returns the type of GPS receiver |
| GpsGetSatellite | Gets the detailed satellite information for a specific satellite channel number. |
| GpsGetSatellites | Returns all currently visible satellites |
| GpsGetSatellitesUsed | Returns the number of satellites that are used in the current navigation solution. |
| GpsGetSatellitesVisible | Returns the number of satellites that are visible in the sky. |
| GpsGetSpeed | Returns the current speed over ground |
| GpsGetSpeedEx | Gets the current speed over ground |
| GpsGetTime | Returns the current UTC time |
| GpsGetTimeEx | |
| GpsGetUTMCoordinates | Retrieves the current UTM coordinates in reference to the returned UTM zone. |
| GpsInitialize | Initializes the GPS Toolkit |
| GpsInitializeEx | Initializes the GPS Toolkit optionally via Windows Sockets instead of a serial port. |
| GpsInitializeReceiver | Initializes the GPS receiver |
| GpsIsAutoDetectEnabled | Returns whether auto detect in enabled or disabled |
| GpsIsEnabled | Returns whether the GPS is currently enabled or disabled |
| GpsRegisterNotifications | Registers the wakeup and sleep notifications for a Palm OS application |
| GpsRequestRawData | Enables or disables the sending of raw GPS data to the notification callback function |
| GpsSendData | Sends a buffer of data directly to the GPS device |
| GpsSetBaudRate | Sets the baud rate used to communicate with the GPS receiver |
| GpsSetBluetoothAddress | Sets the GPS Toolkit to coonect to a Bluetooth GPS via Windows Sockets instead of a serial port. |
| GpsSetDatum | Sets the specified reference datum for the GPS receiver |
| GpsSetNotificationCallback | Sets an application defined callback function to receive messages from the Toolkit |
| GpsSetNotificationCallbackEx | Windows Specific calls |
| GpsSetPort | Sets the communications port |
| GpsSetProtocol | Sets the protocol to be used to communicate with the GPS device. |
| GpsSetReceiver | Sets the receiver type |
| GpsTerminate | Terminates an active GPS session and shuts down all communications with the GPS device |
| Macro | Description |
| GPS_MAX_WAYPOINT_LEN |
These are constants used by the GPS Toolkit
|
| GPS_NUMBER_OF_CHANNELS |
These are constants used by the GPS Toolkit
|
| GPSCOMMERROR_BREAK | These constants define errors encountered on the serial port. |
| GPSCOMMERROR_FRAME | These constants define errors encountered on the serial port. |
| GPSCOMMERROR_OVERRUN | These constants define errors encountered on the serial port. |
| GPSCOMMERROR_RXOVER | These constants define errors encountered on the serial port. |
| GPSCOMMERROR_RXPARITY | These constants define errors encountered on the serial port. |
| GPSCOMMERROR_TXFULL | These constants define errors encountered on the serial port. |
| GPSDATAMASK_BEARING |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_DOP |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_EPE |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_ERROR |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_POSITION |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_SATELLITE |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_SIRF_EX |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_TIME |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| GPSDATAMASK_WAYPOINT |
GPS data masks are flags that specify which GPS data elements have changed. Parameters using data masks can be any combination of the following values:
|
| LPCTSTR |
| Type | Description |
| GPSALTITUDE_HOLD_MODES | Used to configure the altitude hold mode on a SiRF receiver |
| GPSALTITUDE_HOLD_SOURCES | Used to indicate the source of altitude information on a SiRF receiver when altitude hold is in effect |
| GPSBOOL | A platform independent boolean type |
| GPSDATASTRUCT | Structure containing all of the GPS information collected from the GPS receiver |
| GPSDATUM | Defines the geodetic system in use by the GPS Toolkit |
| GPSDEGRADED_MODES | Specifies how a SiRF receiver is to operate in degraded conditions |
| GPSDOP | Structure representing the Dilution of Precision values |
| GPSENABLE | A platform independent boolean type |
| GPSEPE |
Estimated position error
|
| GPSERROR | Error codes used by the GPS toolkit |
| GPSFIXTYPE | Indicates the type of fix available from the GPS receiver. |
| GPSFORMAT | Specifies the units of angular measurement |
| GPSINITMODE | Spefies that start mode of the GpsReceiver when a GpsInitializeReceiver command is issued |
| GPSINITTIME | Specifies time information for warm starts with data |
| GPSNOTIFYCODE | Identifies the type of notification being sent to the notification callback |
| GPSNOTIFYPROC | An application-defined callback function used for communications between the GPS Toolkit and the application |
| GPSPOSITION | Structure defining position and ground speed information |
| GPSPROTOCOL | Protocol types |
| GPSQUALITY | GPS Quality is an indication of the type of solution provided by the GPS receiver. |
| GPSRAWDATA | A platform independent boolean type |
| GPSRECEIVER | Receiver types |
| GPSREGNOTIFY | Platform independant boolean type |
| GPSSATELLITE | Information about a GPS satellite |
| GPSSATELLITEEX | |
| GPSSATELLITES | An array of GPSSATELLITE structures representing the current set of satellites tracked by the receiver |
| GPSSIGNALDETECT | Enum defining whether or not a GPS signal has been detected |
| GPSUTCDATE | Represents the date in the GPS data |
| GPSUTCTIME | Structure representing Universal Time Coordinated (UTC) |
| GPSUTCTIMEEX | |
| GPSWAYPOINTS | Structure representing named waypoints |
| PGPSDATASTRUCT | Structure containing all of the GPS information collected from the GPS receiver |
| PGPSDOP | Structure representing the Dilution of Precision values |
| PGPSEPE |
Estimated position error
|
| PGPSINITTIME | Specifies time information for warm starts with data |
| PGPSPOSITION | Structure defining position and ground speed information |
| PGPSSATELLITE | Information about a GPS satellite |
| PGPSSATELLITEEX | |
| PGPSSATELLITES | An array of GPSSATELLITE structures representing the current set of satellites tracked by the receiver |
| PGPSUTCDATE | Represents the date in the GPS data |
| PGPSUTCTIME | Structure representing Universal Time Coordinated (UTC) |
| PGPSUTCTIMEEX | |
| PGPSWAYPOINTS | Structure representing named waypoints |