LinuxQMISDK: qaGobiApiPds.h Source File

LinuxQMISDK SLQS03.03.11

- Main Page
- Modules
- References
- Data Structures

- File List
- Globals

All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
qaGobiApiPds.h
Go to the documentation of this file.
1
9 /*
10 * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
11 */
12 #ifndef __GOBI_API_PDS_H__
13 #define __GOBI_API_PDS_H__
14
15 #define DEFAULTBYTEVALUE 0xFF
16 #define DEFAULTWORDVALUE 0xFFFF
17 #define DEFAULTLONGVALUE 0xFFFFFFFF
18
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22
44 ULONG GetPDSState(
45 ULONG *pEnabledStatus,
46 ULONG *pTrackingStatus );
47
63 ULONG SetPDSState(
64 ULONG enable );
65
106 ULONG StartPDSTrackingSessionExt(
107 BYTE sessionControl,
108 BYTE sessionType,
109 BYTE sessionOperation,
110 BYTE sessionServerOption,
111 BYTE fixTimeout,
112 ULONG fixInterval,
113 ULONG fixCount,
114 ULONG fixAccuracy );
115
126 ULONG StopPDSTrackingSession();
127
144 ULONG PDSInjectTimeReference(
145 ULONGLONG systemTime,
146 USHORT systemDiscontinuities );
147
176 ULONG GetPDSDefaults(
177 ULONG *pOperation,
178 BYTE *pTimeout,
179 ULONG *pInterval,
180 ULONG *pAccuracy );
181
210 ULONG SetPDSDefaults(
211 ULONG operation,
212 BYTE timeout,
213 ULONG interval,
214 ULONG accuracy );
215
234 ULONG GetXTRAAutomaticDownload(
235 ULONG *pbEnabled,
236 USHORT *pInterval );
237
256 ULONG SetXTRAAutomaticDownload(
257 ULONG bEnabled,
258 USHORT interval );
259
279 ULONG GetXTRANetwork(
280 ULONG *pPreference );
281
301 ULONG SetXTRANetwork(
302 ULONG preference );
303
326 ULONG GetXTRAValidity(
327 USHORT *pGPSWeek,
328 USHORT *pGPSWeekOffset,
329 USHORT *pDuration );
330
343 ULONG ForceXTRADownload();
344
360 ULONG GetServiceAutomaticTracking(
361 ULONG *pbAuto );
362
363 enum {
364 eSetServiceAutomaticTrackingDisable=0,
365 eSetServiceAutomaticTrackingEnable=1
366 };
388 ULONG SetServiceAutomaticTracking(
389 ULONG bAuto );
390
406 ULONG GetPortAutomaticTracking(
407 ULONG *pbAuto );
408
424 ULONG SetPortAutomaticTracking(
425 ULONG bAuto );
426
466 ULONG ResetPDSData(
467 ULONG *pGPSDataMask,
468 ULONG *pCellDataMask );
469
500 ULONG SLQSSetAGPSConfig(
501 ULONG *pServerAddress,
502 ULONG *pServerPort,
503 BYTE *pServerURL,
504 BYTE *pServerURLLength,
505 BYTE *pNetworkMode );
506
533 ULONG SLQSPDSInjectAbsoluteTimeReference(
534 ULONGLONG timeMsec,
535 ULONG timeUncMsec,
536 BYTE timeBase,
537 BYTE forceFlag );
538
567 ULONG SLQSGetAGPSConfig(
568 ULONG *pServerAddress,
569 ULONG *pServerPort,
570 BYTE *pServerURL,
571 BYTE *pServerURLLength,
572 BYTE *pNetworkMode);
573
648 struct PDSPositionData
649 {
650 ULONGLONG *pTimeStamp;
651 ULONGLONG *pLatitude;
652 ULONGLONG *pLongitude;
653 ULONG *pAltitudeWrtEllipsoid;
654 ULONG *pAltitudeWrtSealevel;
655 ULONG *pHorizontalUncCircular;
656 ULONG *pVerticalUnc;
657 BYTE *pHorizontalConfidence;
658 BYTE *pVerticalConfidence;
659 BYTE *pPositionSource;
660 BYTE *pTimeType;
661 };
662
676 ULONG SLQSPDSInjectPositionData( struct PDSPositionData *pPositionData );
677
689 ULONG SLQSPDSDeterminePosition( );
690
831 typedef struct
832 {
833 BYTE EngineState;
834 ULONG ValidMask;
835 ULONGLONG Latitude;
836 ULONGLONG Longitude;
837 ULONG HorizontalUncertainty;
838 ULONG Altitude;
839 ULONG VerticalUncertainty;
840 ULONG TimeStmp_tow_ms;
841 WORD TimeStmp_gps_week;
842 ULONG Time_uncert_ms;
843 BYTE Iono_valid;
844 ULONG gps_ephemeris_sv_msk;
845 ULONG gps_almanac_sv_msk;
846 ULONG gps_health_sv_msk;
847 ULONG gps_visible_sv_msk;
848 ULONG glo_ephemeris_sv_msk;
849 ULONG glo_almanac_sv_msk;
850 ULONG glo_health_sv_msk;
851 ULONG glo_visible_sv_msk;
852 ULONG sbas_ephemeris_sv_msk;
853 ULONG sbas_almanac_sv_msk;
854 ULONG sbas_health_sv_msk;
855 ULONG sbas_visible_sv_msk;
856 WORD xtra_start_gps_week;
857 WORD xtra_start_gps_minutes;
858 WORD xtra_valid_duration_hours;
859 }GPSStateInfo;
860
875 ULONG SLQSGetGPSStateInfo( GPSStateInfo *pGPSStateInfo );
876
898 typedef struct
899 {
900 BYTE *pXtraTimeState;
901 BYTE *pXtraDataState ;
902 BYTE *pWifiState;
903 }PDSPosMethodStateReq;
904
918 ULONG SLQSSetPositionMethodState( PDSPosMethodStateReq *pPDSPosMethodStateReq );
919
920 #ifdef __cplusplus
921 } /* extern "C" { */
922 #endif
923
924 #endif /* __GOBI_API_PDS_H__ */
PDSPositionData::pLatitude
ULONGLONG * pLatitude
Definition: qaGobiApiPds.h:651
SLQSPDSInjectPositionData
ULONG SLQSPDSInjectPositionData(struct PDSPositionData *pPositionData)
PDSPositionData::pAltitudeWrtEllipsoid
ULONG * pAltitudeWrtEllipsoid
Definition: qaGobiApiPds.h:653
SLQSPDSDeterminePosition
ULONG SLQSPDSDeterminePosition()
GPSStateInfo::glo_health_sv_msk
ULONG glo_health_sv_msk
Definition: qaGobiApiPds.h:850
SetXTRAAutomaticDownload
ULONG SetXTRAAutomaticDownload(ULONG bEnabled, USHORT interval)
GPSStateInfo::gps_almanac_sv_msk
ULONG gps_almanac_sv_msk
Definition: qaGobiApiPds.h:845
GPSStateInfo::glo_ephemeris_sv_msk
ULONG glo_ephemeris_sv_msk
Definition: qaGobiApiPds.h:848
PDSPositionData::pTimeType
BYTE * pTimeType
Definition: qaGobiApiPds.h:660
GPSStateInfo::Latitude
ULONGLONG Latitude
Definition: qaGobiApiPds.h:835
GPSStateInfo::xtra_valid_duration_hours
WORD xtra_valid_duration_hours
Definition: qaGobiApiPds.h:858
GPSStateInfo::Altitude
ULONG Altitude
Definition: qaGobiApiPds.h:838
GetPDSState
ULONG GetPDSState(ULONG *pEnabledStatus, ULONG *pTrackingStatus)
PDSPositionData::pLongitude
ULONGLONG * pLongitude
Definition: qaGobiApiPds.h:652
BYTE
unsigned char BYTE
Definition: SwiDataTypes.h:28
PDSPosMethodStateReq::pXtraDataState
BYTE * pXtraDataState
Definition: qaGobiApiPds.h:901
PDSInjectTimeReference
ULONG PDSInjectTimeReference(ULONGLONG systemTime, USHORT systemDiscontinuities)
GPSStateInfo::EngineState
BYTE EngineState
Definition: qaGobiApiPds.h:833
GPSStateInfo::glo_almanac_sv_msk
ULONG glo_almanac_sv_msk
Definition: qaGobiApiPds.h:849
eSetServiceAutomaticTrackingEnable
Definition: qaGobiApiPds.h:365
GPSStateInfo::Iono_valid
BYTE Iono_valid
Definition: qaGobiApiPds.h:843
PDSPositionData::pTimeStamp
ULONGLONG * pTimeStamp
Definition: qaGobiApiPds.h:650
GPSStateInfo::glo_visible_sv_msk
ULONG glo_visible_sv_msk
Definition: qaGobiApiPds.h:851
GPSStateInfo::Time_uncert_ms
ULONG Time_uncert_ms
Definition: qaGobiApiPds.h:842
PDSPositionData::pAltitudeWrtSealevel
ULONG * pAltitudeWrtSealevel
Definition: qaGobiApiPds.h:654
SetXTRANetwork
ULONG SetXTRANetwork(ULONG preference)
SLQSPDSInjectAbsoluteTimeReference
ULONG SLQSPDSInjectAbsoluteTimeReference(ULONGLONG timeMsec, ULONG timeUncMsec, BYTE timeBase, BYTE forceFlag)
GPSStateInfo::VerticalUncertainty
ULONG VerticalUncertainty
Definition: qaGobiApiPds.h:839
GPSStateInfo::TimeStmp_gps_week
WORD TimeStmp_gps_week
Definition: qaGobiApiPds.h:841
eSetServiceAutomaticTrackingDisable
Definition: qaGobiApiPds.h:364
GPSStateInfo::gps_ephemeris_sv_msk
ULONG gps_ephemeris_sv_msk
Definition: qaGobiApiPds.h:844
PDSPositionData::pVerticalUnc
ULONG * pVerticalUnc
Definition: qaGobiApiPds.h:656
GetPDSDefaults
ULONG GetPDSDefaults(ULONG *pOperation, BYTE *pTimeout, ULONG *pInterval, ULONG *pAccuracy)
SLQSGetAGPSConfig
ULONG SLQSGetAGPSConfig(ULONG *pServerAddress, ULONG *pServerPort, BYTE *pServerURL, BYTE *pServerURLLength, BYTE *pNetworkMode)
PDSPosMethodStateReq::pWifiState
BYTE * pWifiState
Definition: qaGobiApiPds.h:902
USHORT
unsigned short USHORT
Definition: SwiDataTypes.h:31
GPSStateInfo::sbas_ephemeris_sv_msk
ULONG sbas_ephemeris_sv_msk
Definition: qaGobiApiPds.h:852
PDSPositionData
Definition: qaGobiApiPds.h:648
StartPDSTrackingSessionExt
ULONG StartPDSTrackingSessionExt(BYTE sessionControl, BYTE sessionType, BYTE sessionOperation, BYTE sessionServerOption, BYTE fixTimeout, ULONG fixInterval, ULONG fixCount, ULONG fixAccuracy)
GPSStateInfo::sbas_health_sv_msk
ULONG sbas_health_sv_msk
Definition: qaGobiApiPds.h:854
ResetPDSData
ULONG ResetPDSData(ULONG *pGPSDataMask, ULONG *pCellDataMask)
PDSPosMethodStateReq
Definition: qaGobiApiPds.h:898
PDSPositionData::pPositionSource
BYTE * pPositionSource
Definition: qaGobiApiPds.h:659
PDSPositionData::pHorizontalConfidence
BYTE * pHorizontalConfidence
Definition: qaGobiApiPds.h:657
PDSPosMethodStateReq::pXtraTimeState
BYTE * pXtraTimeState
Definition: qaGobiApiPds.h:900
GetXTRAAutomaticDownload
ULONG GetXTRAAutomaticDownload(ULONG *pbEnabled, USHORT *pInterval)
GPSStateInfo::TimeStmp_tow_ms
ULONG TimeStmp_tow_ms
Definition: qaGobiApiPds.h:840
ULONGLONG
unsigned long long ULONGLONG
Definition: SwiDataTypes.h:26
GetXTRANetwork
ULONG GetXTRANetwork(ULONG *pPreference)
ULONG
unsigned long ULONG
Definition: SwiDataTypes.h:25
GPSStateInfo
Definition: qaGobiApiPds.h:831
SetPortAutomaticTracking
ULONG SetPortAutomaticTracking(ULONG bAuto)
GPSStateInfo::Longitude
ULONGLONG Longitude
Definition: qaGobiApiPds.h:836
GPSStateInfo::HorizontalUncertainty
ULONG HorizontalUncertainty
Definition: qaGobiApiPds.h:837
GPSStateInfo::gps_health_sv_msk
ULONG gps_health_sv_msk
Definition: qaGobiApiPds.h:846
PDSPositionData::pVerticalConfidence
BYTE * pVerticalConfidence
Definition: qaGobiApiPds.h:658
SLQSSetPositionMethodState
ULONG SLQSSetPositionMethodState(PDSPosMethodStateReq *pPDSPosMethodStateReq)
SLQSGetGPSStateInfo
ULONG SLQSGetGPSStateInfo(GPSStateInfo *pGPSStateInfo)
ForceXTRADownload
ULONG ForceXTRADownload()
SLQSSetAGPSConfig
ULONG SLQSSetAGPSConfig(ULONG *pServerAddress, ULONG *pServerPort, BYTE *pServerURL, BYTE *pServerURLLength, BYTE *pNetworkMode)
PDSPositionData::pHorizontalUncCircular
ULONG * pHorizontalUncCircular
Definition: qaGobiApiPds.h:655
GPSStateInfo::xtra_start_gps_minutes
WORD xtra_start_gps_minutes
Definition: qaGobiApiPds.h:857
GPSStateInfo::sbas_visible_sv_msk
ULONG sbas_visible_sv_msk
Definition: qaGobiApiPds.h:855
SetPDSState
ULONG SetPDSState(ULONG enable)
GetPortAutomaticTracking
ULONG GetPortAutomaticTracking(ULONG *pbAuto)
GPSStateInfo::ValidMask
ULONG ValidMask
Definition: qaGobiApiPds.h:834
GPSStateInfo::gps_visible_sv_msk
ULONG gps_visible_sv_msk
Definition: qaGobiApiPds.h:847
WORD
unsigned short WORD
Definition: SwiDataTypes.h:30
GPSStateInfo::xtra_start_gps_week
WORD xtra_start_gps_week
Definition: qaGobiApiPds.h:856
GetServiceAutomaticTracking
ULONG GetServiceAutomaticTracking(ULONG *pbAuto)
GetXTRAValidity
ULONG GetXTRAValidity(USHORT *pGPSWeek, USHORT *pGPSWeekOffset, USHORT *pDuration)
SetServiceAutomaticTracking
ULONG SetServiceAutomaticTracking(ULONG bAuto)
SetPDSDefaults
ULONG SetPDSDefaults(ULONG operation, BYTE timeout, ULONG interval, ULONG accuracy)
GPSStateInfo::sbas_almanac_sv_msk
ULONG sbas_almanac_sv_msk
Definition: qaGobiApiPds.h:853
StopPDSTrackingSession
ULONG StopPDSTrackingSession()