Header file for for GSM APIs related to the Location Based Services. More...

#include "SwiDataTypes.h"
#include "SwiRcodes.h"

Data Structures
struct	SWI_STRUCT_LbsLocNotifyStatus

struct	SWI_STRUCT_LbsDloadNotifyStatus

struct	SWI_STRUCT_LbsParamNotifyStatus

struct	SWI_STRUCT_LbsPdDownload

struct	SWI_STRUCT_LbsPdGetPos

struct	SWI_STRUCT_LbsPdGetStatus

struct	SWI_STRUCT_LbsPdTrack

struct	SWI_STRUCT_LbsPdEndSession

struct	SWI_STRUCT_LbsPaGetParam

struct	SWI_STRUCT_LbsPdData

struct	SWI_STRUCT_LbsPdDone

struct	SWI_STRUCT_LbsPdEnd

struct	SWI_STRUCT_LbsPdBegin

struct	SWI_STRUCT_LbsPdUpdateFailure

struct	SWI_STRUCT_LbsPdDloadBegin

struct	SWI_STRUCT_LbsPdDloadData

struct	SWI_STRUCT_LbsPdDloadDone

struct	SWI_STRUCT_LbsPdDloadEnd

struct	SWI_STRUCT_LbsPaIpAddr

struct	SWI_STRUCT_LbsPaGpsLock

struct	SWI_STRUCT_LbsPaPtlmMode

struct	SWI_STRUCT_LbsPaPortId

struct	SWI_STRUCT_LbsPaPrivacy

struct	SWI_STRUCT_LbsPaNetAccess

struct	SWI_STRUCT_LbsPaBsInfo

struct	SWI_STRUCT_SatView

struct	SWI_STRUCT_LbsSatInfo

struct	SWI_STRUCT_LbsClearAssistance

Macros
#define	MAX_NUM_LBS_SV 12

#define	LENGTH_LbsReqId 33

#define	LENGTH_LbsClientName 33

#define	LENGTH_TimeStamp 16

Typedefs
typedef struct SWI_STRUCT_LbsLocNotifyStatus	SWI_STRUCT_LbsLocNotifyStatus

typedef struct SWI_STRUCT_LbsDloadNotifyStatus	SWI_STRUCT_LbsDloadNotifyStatus

typedef struct SWI_STRUCT_LbsParamNotifyStatus	SWI_STRUCT_LbsParamNotifyStatus

typedef struct SWI_STRUCT_LbsPdDownload	SWI_STRUCT_LbsPdDownload

typedef struct SWI_STRUCT_LbsPdGetPos	SWI_STRUCT_LbsPdGetPos

typedef struct SWI_STRUCT_LbsPdGetStatus	SWI_STRUCT_LbsPdGetStatus

typedef struct SWI_STRUCT_LbsPdTrack	SWI_STRUCT_LbsPdTrack

typedef struct SWI_STRUCT_LbsPdEndSession	SWI_STRUCT_LbsPdEndSession

typedef struct SWI_STRUCT_LbsPaGetParam	SWI_STRUCT_LbsPaGetParam

typedef struct SWI_STRUCT_LbsPdData	SWI_STRUCT_LbsPdData

typedef struct SWI_STRUCT_LbsPdDone	SWI_STRUCT_LbsPdDone

typedef struct SWI_STRUCT_LbsPdEnd	SWI_STRUCT_LbsPdEnd

typedef struct SWI_STRUCT_LbsPdBegin	SWI_STRUCT_LbsPdBegin

typedef struct SWI_STRUCT_LbsPdUpdateFailure	SWI_STRUCT_LbsPdUpdateFailure

typedef struct SWI_STRUCT_LbsPdDloadBegin	SWI_STRUCT_LbsPdDloadBegin

typedef struct SWI_STRUCT_LbsPdDloadData	SWI_STRUCT_LbsPdDloadData

typedef struct SWI_STRUCT_LbsPdDloadDone	SWI_STRUCT_LbsPdDloadDone

typedef struct SWI_STRUCT_LbsPdDloadEnd	SWI_STRUCT_LbsPdDloadEnd

typedef struct SWI_STRUCT_LbsPaIpAddr	SWI_STRUCT_LbsPaIpAddr

typedef struct SWI_STRUCT_LbsPaGpsLock	SWI_STRUCT_LbsPaGpsLock

typedef struct SWI_STRUCT_LbsPaPtlmMode	SWI_STRUCT_LbsPaPtlmMode

typedef struct SWI_STRUCT_LbsPaPortId	SWI_STRUCT_LbsPaPortId

typedef struct SWI_STRUCT_LbsPaPrivacy	SWI_STRUCT_LbsPaPrivacy

typedef struct SWI_STRUCT_LbsPaNetAccess	SWI_STRUCT_LbsPaNetAccess

typedef struct SWI_STRUCT_LbsPaBsInfo	SWI_STRUCT_LbsPaBsInfo

typedef struct SWI_STRUCT_SatView	SWI_STRUCT_SatView

typedef struct SWI_STRUCT_LbsSatInfo	SWI_STRUCT_LbsSatInfo

typedef struct SWI_STRUCT_LbsClearAssistance	SWI_STRUCT_LbsClearAssistance

Enumerations
enum	SWI_TYPE_LbsPdEndStatus { SWI_LBSPDENDSTATUS_Offline, SWI_LBSPDENDSTATUS_NoService, SWI_LBSPDENDSTATUS_NoConnection, SWI_LBSPDENDSTATUS_NoData, SWI_LBSPDENDSTATUS_SessionBusy, SWI_LBSPDENDSTATUS_CdmaLock, SWI_LBSPDENDSTATUS_GpsLock, SWI_LBSPDENDSTATUS_ConnectionFailed, SWI_LBSPDENDSTATUS_ErrorState, SWI_LBSPDENDSTATUS_ClientEnded, SWI_LBSPDENDSTATUS_UiEnded, SWI_LBSPDENDSTATUS_NetworkEnded, SWI_LBSPDENDSTATUS_Timeout, SWI_LBSPDENDSTATUS_PrivacyLevel, SWI_LBSPDENDSTATUS_NetworkAccessError, SWI_LBSPDENDSTATUS_FixError, SWI_LBSPDENDSTATUS_PdeRejected, SWI_LBSPDENDSTATUS_TrafficChannelExited, SWI_LBSPDENDSTATUS_E911, SWI_LBSPDENDSTATUS_ServerError, SWI_LBSPDENDSTATUS_StaleBsInformation }

enum	SWI_TYPE_LbsPdErr { SWI_LBSPDERR_NoError, SWI_LBSPDERR_InternalModemError, SWI_LBSPDERR_BadServiceType, SWI_LBSPDERR_BadSessionType, SWI_LBSPDERR_InvalidPrivacy, SWI_LBSPDERR_InvalidDataDownload, SWI_LBSPDERR_InvalidNetworkAccess, SWI_LBSPDERR_InvalidOperationMode, SWI_LBSPDERR_InvalidNumberOfFixes, SWI_LBSPDERR_InvalidServerInfo, SWI_LBSPDERR_InvalidTimeout, SWI_LBSPDERR_InvalidQosParameter, SWI_LBSPDERR_NoSessionActive, SWI_LBSPDERR_SessionAlreadyActive, SWI_LBSPDERR_SessionBusy, SWI_LBSPDERR_PhoneIsOffline, SWI_LBSPDERR_CDMALockError, SWI_LBSPDERR_GPSLockError, SWI_LBSPDERR_InvalidState, SWI_LBSPDERR_ConnectionFailure, SWI_LBSPDERR_NoBuffersAvailable, SWI_LBSPDERR_SearcherError, SWI_LBSPDERR_CannotReportNow, SWI_LBSPDERR_ModeNotSupported, SWI_LBSPDERR_OtherError, SWI_LBSPDERR_FixRateForTrackingTooLarge }

enum	SWI_MASK_LbsPdService { MASK_LbsPdService_Position = 0x01, MASK_LbsPdService_Velocity = 0x02, MASK_LbsPdService_Height = 0x04 }

enum	SWI_TYPE_LbsPdDloadOption { SWI_LBSPDDLOADOPTION_Periodic = 0x01, SWI_LBSPDDLOADOPTION_Single }

enum	SWI_TYPE_LbsSession { SWI_LBSSESSION_LocationFix, SWI_LBSSESSION_Download }

enum	SWI_MASK_LbsLocNotifyStatus { MASK_LbsPdLocNotifyStatus_Begin = 0x0001, MASK_LbsPdLocNotifyStatus_Data = 0x0002, MASK_LbsPdLocNotifyStatus_End = 0x0004, MASK_LbsPdLocNotifyStatus_Done = 0x0008, MASK_LbsPdLocNotifyStatus_UpdateFailure = 0x0010 }

enum	SWI_MASK_LbsDloadNotifyStatus { MASK_LbsPdDloadNotifyStatus_Begin = 0x0001, MASK_LbsPdDloadNotifyStatus_Data = 0x0002, MASK_LbsPdDloadNotifyStatus_End = 0x0004, MASK_LbsPdDloadNotifyStatus_Done = 0x0008 }

enum	SWI_MASK_LbsParamNotifyStatus { MASK_LbsPaParamNotifyStatus_Address = 0x0001, MASK_LbsPaParamNotifyStatus_GpsLock = 0x0002, MASK_LbsPaParamNotifyStatus_PtlmMode = 0x0004, MASK_LbsPaParamNotifyStatus_PortId = 0x0008, MASK_LbsPaParamNotifyStatus_Privacy = 0x0010, MASK_LbsPaParamNotifyStatus_NetAccess = 0x0020 }

enum	SWI_TYPE_LbsNotifyState { SWI_LBSNOTIFYSTATE_Off, SWI_LBSNOTIFYSTATE_On }

enum	SWI_TYPE_LbsFix { SWI_LBSFIX_Autonomous = 1, SWI_LBSFIX_MsBased, SWI_LBSFIX_MsAssisted, SWI_LBSFIX_OptimizedSpeed, SWI_LBSFIX_OptimizedAccuracy, SWI_LBSFIX_OptimizedData }

enum	SWI_TYPE_LbsPdStatus { SWI_LBSPDSTATUS_None = 0, SWI_LBSPDSTATUS_Active = 1, SWI_LBSPDSTATUS_Success = 2, SWI_LBSPDSTATUS_Error = 3 }

enum	SWI_TYPE_LbsPaGpsLock { SWI_LBSPAGPSLOCK_NoLockActive, SWI_LBSPAGPSLOCK_MiSessionsLocked, SWI_LBSPAGPSLOCK_MtSessionsLocked, SWI_LBSPAGPSLOCK_AllSessionsLocked }

enum	SWI_TYPE_LbsPaTransMech { SWI_LBSPATRANSMECH_TcpIp, SWI_LBSPATRANSMECH_DataBurst }

enum	SWI_TYPE_LbsPaPrivacy { SWI_LBSPAPRIVACY_High, SWI_LBSPAPRIVACY_Medium, SWI_LBSPAPRIVACY_Low }

enum	SWI_TYPE_LbsPaNetAccess { SWI_LBSPANETACCESS_NetworkOnly, SWI_LBSPANETACCESS_NoNetworkAccess, SWI_LBSPANETACCESS_NetworkWithDemodulation, SWI_LBSPANETACCESS_NetworkWithoutDemodulation }

enum	SWI_TYPE_LbsFixDim { SWI_LBSFIXDIM_2D, SWI_LBSFIXDIM_3D }

enum	SWI_TYPE_SDPU { SWI_SDPU_0Dot5, SWI_SDPU_0Dot75, SWI_SDPU_1, SWI_SDPU_1Dot5, SWI_SDPU_2, SWI_SDPU_3, SWI_SDPU_4, SWI_SDPU_6, SWI_SDPU_8, SWI_SDPU_12, SWI_SDPU_16, SWI_SDPU_24, SWI_SDPU_32, SWI_SDPU_48, SWI_SDPU_64, SWI_SDPU_96, SWI_SDPU_128, SWI_SDPU_192, SWI_SDPU_256, SWI_SDPU_384, SWI_SDPU_512, SWI_SDPU_768, SWI_SDPU_1024, SWI_SDPU_1536, SWI_SDPU_2048, SWI_SDPU_3072, SWI_SDPU_4096, SWI_SDPU_6144, SWI_SDPU_8192, SWI_SDPU_12288, SWI_SDPU_GreaterThan12288, SWI_SDPU_NotComputable }

enum	SWI_TYPE_LbsDloadData { SWI_LBSDLOADDATA_Location, SWI_LBSDLOADDATA_AA, SWI_LBSDLOADDATA_SA, SWI_LBSDLOADDATA_Epemeris, SWI_LBSDLOADDATA_Almanac }

enum	SWI_TYPE_LbsDloadSource { SWI_LBSDLOADSOURCE_Mobile, SWI_LBSDLOADSOURCE_Pde }

Functions
SWI_API SWI_RCODE	SwiSetLbsPdGetPos (const struct SWI_STRUCT_LbsPdGetPos *psLbsPdGetPos, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPdStatus (struct SWI_STRUCT_LbsPdGetStatus *psLbsPdGetStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPdTrack (const struct SWI_STRUCT_LbsPdTrack *psLbsPdTrack, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPdEndSession (const struct SWI_STRUCT_LbsPdEndSession *psLbsPdEndSession, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaParam (struct SWI_STRUCT_LbsPaGetParam *psLbsPdGetParam, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPdData (struct SWI_STRUCT_LbsPdData *psLbsPdData, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaIpAddr (struct SWI_STRUCT_LbsPaIpAddr *psPaIpAddr, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaIpAddr (const struct SWI_STRUCT_LbsPaIpAddr *psPaIpAddr, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsPaPortId (struct SWI_STRUCT_LbsPaPortId *psPaPortId, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsPaPortId (const struct SWI_STRUCT_LbsPaPortId *psPAPortID, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetLbsSatInfo (struct SWI_STRUCT_LbsSatInfo *psSatInfo, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetLbsClearAssistance (const struct SWI_STRUCT_LbsClearAssistance *psLbsClearAssistance, swi_uint32 timeout)

Detailed Description

Header file for for GSM APIs related to the Location Based Services.

Macro Definition Documentation

#define LENGTH_LbsClientName 33

Maximum client name length

#define LENGTH_LbsReqId 33

Maximum requestor ID length

#define LENGTH_TimeStamp 16

Time stamp string length

#define MAX_NUM_LBS_SV 12

Maximum number of sattelites

Typedef Documentation

typedef struct SWI_STRUCT_LbsClearAssistance SWI_STRUCT_LbsClearAssistance

Structure containing clear assistance parameters

Used by SwiSetLbsClearAssistance to clear various location assistance parameters to simulate a cold start.

See Also: SwiSetLbsClearAssistance

typedef struct SWI_STRUCT_LbsDloadNotifyStatus SWI_STRUCT_LbsDloadNotifyStatus

Used to enable/disable or check the current notification state of the following group of notifications:

SWI_NOTIFY_LbsPdDloadBegin
SWI_NOTIFY_LbsPdDloadData
SWI_NOTIFY_LbsPdDloadDone
SWI_NOTIFY_LbsPdDloadEnd

See Also: SWI_TYPE_LbsNotifyState; SWI_NOTIFY_LbsPdDloadBegin; SWI_NOTIFY_LbsPdDloadData; SWI_NOTIFY_LbsPdDloadDone; SWI_NOTIFY_LbsPdDloadEnd; SwiGetLbsDloadNotifyStatus; SwiSetLbsDloadNotifyStatus

typedef struct SWI_STRUCT_LbsLocNotifyStatus SWI_STRUCT_LbsLocNotifyStatus

Used to enable/disable or check the current notification state of the following group of notifications:

SWI_NOTIFY_LbsPdData
SWI_NOTIFY_LbsPdDone
SWI_NOTIFY_LbsPdEnd
SWI_NOTIFY_LbsPdBegin
SWI_NOTIFY_LbsPdUpdateFailure
SWI_NOTIFY_LbsSatInfo

See Also: SWI_TYPE_LbsNotifyState; SWI_NOTIFY_LbsPdData; SWI_NOTIFY_LbsPdDone; SWI_NOTIFY_LbsPdEnd; SWI_NOTIFY_LbsPdBegin; SWI_NOTIFY_LbsPdUpdateFailure; SWI_NOTIFY_LbsSatInfo; SwiGetLbsLocNotifyStatus; SwiSetLbsLocNotifyStatus

typedef struct SWI_STRUCT_LbsPaBsInfo SWI_STRUCT_LbsPaBsInfo

Structure containing base station information.

See Also: SWI_NOTIFY_LbsPaBsInfo; SwiGetLbsPaBsInfo

typedef struct SWI_STRUCT_LbsPaGetParam SWI_STRUCT_LbsPaGetParam

Structure containing the modem's default parameter settings.

Entire set of position determination parameters is returned to the host (IP address, port ID, GPS lock, transport mechanism, privacy, network access).

See Also: SWI_TYPE_LbsPaGpsLock; SWI_TYPE_LbsPaTransMech; SWI_TYPE_LbsPaPrivacy; SWI_TYPE_LbsPaNetAccess; SwiGetLbsPaParam

typedef struct SWI_STRUCT_LbsPaGpsLock SWI_STRUCT_LbsPaGpsLock

Structure containing GPS lock used in LBS sessions.

See Also: SWI_TYPE_LbsPaGpsLock; SWI_NOTIFY_LbsPaGpsLock; SwiGetLbsPaGpsLock; SwiSetLbsPaGpsLock

typedef struct SWI_STRUCT_LbsPaIpAddr SWI_STRUCT_LbsPaIpAddr

Structure containing TCP/IP address used in LBS sessions.

See Also: SWI_NOTIFY_LbsPaIpAddr; SwiGetLbsPaIpAddr; SwiSetLbspaIpAddr

typedef struct SWI_STRUCT_LbsPaNetAccess SWI_STRUCT_LbsPaNetAccess

Structure containing network access permission used during LBS sessions.

See Also: SWI_TYPE_LbsPaNetAccess; SWI_NOTIFY_LbsPaNetAccess; SwiGetLbsPaNetAccess; SwiSetLbsPaNetAccess

typedef struct SWI_STRUCT_LbsPaPortId SWI_STRUCT_LbsPaPortId

Structure containing port ID used in LBS sessions.

See Also: SWI_NOTIFY_LbsPaPortId; SwiGetLbsPaPortId; SwiSetLbsPaortId

typedef struct SWI_STRUCT_LbsPaPrivacy SWI_STRUCT_LbsPaPrivacy

Structure containing privacy level used in LBS sessions.

See Also: SWI_TYPE_LbsPaPrivacy; SWI_NOTIFY_LbsPaPrivacy; SwiGetLbsPaPrivacy; SwiSetLbsPaPrivacy

typedef struct SWI_STRUCT_LbsPaPtlmMode SWI_STRUCT_LbsPaPtlmMode

Structure containing mechanism used to transport LBS messages.

See Also: SWI_TYPE_LbsPaTransMech; SWI_NOTIFY_LbsPaPtlmMode; SwiGetLbsPaPtlmMode; SwiSetLbsPaPtlmMode

typedef struct SWI_STRUCT_LbsParamNotifyStatus SWI_STRUCT_LbsParamNotifyStatus

Used to enable/disable or check the current notification state of the following group of notifications:

SWI_NOTIFY_LbsPaIpAddr
SWI_NOTIFY_LbsPaGpsLock
SWI_NOTIFY_LbsPaPtlmMode
SWI_NOTIFY_LbsPaPortId
SWI_NOTIFY_LbsPaPrivacy
SWI_NOTIFY_LbsPaNetAccess

See Also: SWI_TYPE_LbsNotifyState; SWI_NOTIFY_LbsPaIpAddr; SWI_NOTIFY_LbsPaGpsLock; SWI_NOTIFY_LbsPaPtlmMode; SWI_NOTIFY_LbsPaPortId; SWI_NOTIFY_LbsPaPrivacy; SWI_NOTIFY_LbsPaNetAccess; SwiGetLbsParamNotifyStatus; SwiSetLbsParamNotifyStatus

typedef struct SWI_STRUCT_LbsPdBegin SWI_STRUCT_LbsPdBegin

Skeleton structure returned when a position determination fix session has begun.

See Also: SWI_NOTIFY_LbsPdBegin

typedef struct SWI_STRUCT_LbsPdData SWI_STRUCT_LbsPdData

Structure containing position fix information.

This object is sent to notify the registered host client of the result of the position fix. If the host performs a get on this object when there is no position fix to report the modem will respond with a generic error message.

See Also: SWI_TYPE_SDPU; SWI_TYPE_LbsFixDim; SWI_TYPE_SDPU; SWI_NOTIFY_LbsPdData; SwiGetLbsPdData

typedef struct SWI_STRUCT_LbsPdDloadBegin SWI_STRUCT_LbsPdDloadBegin

Skeleton structure returned when a data download session has begun.

See Also: SWI_NOTIFY_LbsPdDloadBegin

typedef struct SWI_STRUCT_LbsPdDloadData SWI_STRUCT_LbsPdDloadData

Structure containing information on downloaded LBS data.

This object is sent to notify the registered host client that ephemeris and almanac data has been downloaded.

See Also: SWI_TYPE_LbsDloadData; SWI_TYPE_LbsDloadSource; SWI_NOTIFY_LbsPdDloadData

typedef struct SWI_STRUCT_LbsPdDloadDone SWI_STRUCT_LbsPdDloadDone

Skeleton structure returned when a position determination download session has completed.

See Also: SWI_NOTIFY_LbsPdDloadDone

typedef struct SWI_STRUCT_LbsPdDloadEnd SWI_STRUCT_LbsPdDloadEnd

Structure containing status of a position determination download session.

This object is typically sent to notify the registered host clients that a position determination fix session had an error.

See Also: SWI_NOTIFY_LbsPdDloadEnd

typedef struct SWI_STRUCT_LbsPdDone SWI_STRUCT_LbsPdDone

Skeleton structure returned when a position determination fix session has completed.

See Also: SWI_NOTIFY_LbsPdDone

typedef struct SWI_STRUCT_LbsPdDownload SWI_STRUCT_LbsPdDownload

Used to specify the download option and duration.

The host can use the download option to indicate whether the data download should occur just once or periodically, in an effort to keep the data "warm". If the application that will be requesting this data will be requiring the use of the data over a period of time, the application should indicate that the download should be periodic.

See Also: SWI_TYPE_LbsPdDloadOption; SwiSetLbsPdDownload

typedef struct SWI_STRUCT_LbsPdEnd SWI_STRUCT_LbsPdEnd

Structure returned when a position determination fix session encountered an error.

See Also: SWI_TYPE_LbsPdEndStatus; SWI_NOTIFY_LbsPdEnd; SwiSetLbsPdEndSession

typedef struct SWI_STRUCT_LbsPdEndSession SWI_STRUCT_LbsPdEndSession

Structure containing information related to ending a tracking session

See Also: SWI_TYPE_LbsSession; SwiSetLbsPdEndSession

typedef struct SWI_STRUCT_LbsPdGetPos SWI_STRUCT_LbsPdGetPos

Structure containing location fix data

See Also: SWI_TYPE_LbsFix; SwiSetLbsPdGetPos

typedef struct SWI_STRUCT_LbsPdGetStatus SWI_STRUCT_LbsPdGetStatus

Structure containing LBS status information.

See Also: SWI_TYPE_LbsPdStatus; SWI_TYPE_LbsPdErr; SwiGetLbsPdStatus

typedef struct SWI_STRUCT_LbsPdTrack SWI_STRUCT_LbsPdTrack

Structure containing information related to starting a tracking session.

See Also: SWI_TYPE_LbsFix; SwiSetLbsPdTrack

typedef struct SWI_STRUCT_LbsPdUpdateFailure SWI_STRUCT_LbsPdUpdateFailure

Skeleton structure returned when a position determination fix session has failed

See Also: SWI_NOTIFY_LbsPdUpdateFailure

typedef struct SWI_STRUCT_LbsSatInfo SWI_STRUCT_LbsSatInfo

Structure containing base station information.

Used by SwiGetLbsSatInfo to retrieve information about the current base station currently being accessed.

See Also: SWI_NOTIFY_LbsSatInfo; SwiGetLbsSatInfo

typedef struct SWI_STRUCT_SatView SWI_STRUCT_SatView

Structure containing satellite information

See Also: SWI_STRUCT_LbsSatInfo

Enumeration Type Documentation

enum SWI_MASK_LbsDloadNotifyStatus

LBS download notification status bit masks

Enumerator
MASK_LbsPdDloadNotifyStatus_Begin
MASK_LbsPdDloadNotifyStatus_Data
MASK_LbsPdDloadNotifyStatus_End
MASK_LbsPdDloadNotifyStatus_Done

enum SWI_MASK_LbsLocNotifyStatus

LBS location notification status bit masks

Enumerator
MASK_LbsPdLocNotifyStatus_Begin
MASK_LbsPdLocNotifyStatus_Data
MASK_LbsPdLocNotifyStatus_End
MASK_LbsPdLocNotifyStatus_Done
MASK_LbsPdLocNotifyStatus_UpdateFailure

enum SWI_MASK_LbsParamNotifyStatus

LBS parameter notificatoin status bit masks

Enumerator
MASK_LbsPaParamNotifyStatus_Address
MASK_LbsPaParamNotifyStatus_GpsLock
MASK_LbsPaParamNotifyStatus_PtlmMode
MASK_LbsPaParamNotifyStatus_PortId
MASK_LbsPaParamNotifyStatus_Privacy
MASK_LbsPaParamNotifyStatus_NetAccess

enum SWI_MASK_LbsPdService

PD service mask values

Enumerator
MASK_LbsPdService_Position
MASK_LbsPdService_Velocity
MASK_LbsPdService_Height

enum SWI_TYPE_LbsDloadData

Enumeration of download data types

See Also: SWI_STRUCT_LbsPdDloadData

Enumerator
SWI_LBSDLOADDATA_Location
SWI_LBSDLOADDATA_AA
SWI_LBSDLOADDATA_SA
SWI_LBSDLOADDATA_Epemeris
SWI_LBSDLOADDATA_Almanac

enum SWI_TYPE_LbsDloadSource

Enumeration of download source types

See Also: SWI_STRUCT_LbsPdDloadData

Enumerator
SWI_LBSDLOADSOURCE_Mobile
SWI_LBSDLOADSOURCE_Pde

enum SWI_TYPE_LbsFix

Enumeration of location fix types

See Also: SWI_STRUCT_LbsPdGetPos; SWI_STRUCT_LbsPdTrack

Enumerator
SWI_LBSFIX_Autonomous	Mobile does everything involved in computing its position. No PDE required.
SWI_LBSFIX_MsBased	Mobile gets assistance from the PDE but the mobile computes position.
SWI_LBSFIX_MsAssisted	Mobile provides information to the PDE so that the PDE can compute the mobiles position.
SWI_LBSFIX_OptimizedSpeed	MS Based or MS Assisted depending on Performance and Accuracy settings.
SWI_LBSFIX_OptimizedAccuracy	MS-Assisted preferred, MS-Based if MS-Assisted fails
SWI_LBSFIX_OptimizedData	MS-Based preferred, MS-Assisted if MS-Based fails

enum SWI_TYPE_LbsFixDim

Enumeration of location fix dimensions.

See Also: SWI_STRUCT_LbsPdData

Enumerator
SWI_LBSFIXDIM_2D
SWI_LBSFIXDIM_3D

enum SWI_TYPE_LbsNotifyState

An enumeration of LBS notification state

See Also: SWI_STRUCT_LbsLocNotifyStatus; SWI_STRUCT_LbsDloadNotifyStatus; SWI_STRUCT_LbsParamNotifyStatus

Enumerator
SWI_LBSNOTIFYSTATE_Off
SWI_LBSNOTIFYSTATE_On

enum SWI_TYPE_LbsPaGpsLock

Enumeration of GPS lock values

See Also: SWI_STRUCT_LbsPaGetParam; SWI_STRUCT_LbsPaGpsLock

Enumerator
SWI_LBSPAGPSLOCK_NoLockActive
SWI_LBSPAGPSLOCK_MiSessionsLocked
SWI_LBSPAGPSLOCK_MtSessionsLocked
SWI_LBSPAGPSLOCK_AllSessionsLocked

enum SWI_TYPE_LbsPaNetAccess

Enumeration of network access values.

See Also: SWI_STRUCT_LbsPaGetParam; SWI_STRUCT_LbsPaNetAccess

Enumerator
SWI_LBSPANETACCESS_NetworkOnly
SWI_LBSPANETACCESS_NoNetworkAccess
SWI_LBSPANETACCESS_NetworkWithDemodulation
SWI_LBSPANETACCESS_NetworkWithoutDemodulation

enum SWI_TYPE_LbsPaPrivacy

Enumeration of privacy values.

See Also: SWI_STRUCT_LbsPaGetParam; SWI_STRUCT_LbsPaPrivacy

Enumerator
SWI_LBSPAPRIVACY_High
SWI_LBSPAPRIVACY_Medium
SWI_LBSPAPRIVACY_Low

enum SWI_TYPE_LbsPaTransMech

Enumeration of PD transport mechanisms

See Also: SWI_STRUCT_LbsPaGetParam; SWI_STRUCT_LbsPaPtlmMode

Enumerator
SWI_LBSPATRANSMECH_TcpIp
SWI_LBSPATRANSMECH_DataBurst

enum SWI_TYPE_LbsPdDloadOption

Enumeration of PD download options

See Also: SWI_STRUCT_LbsPdDownload

Enumerator
SWI_LBSPDDLOADOPTION_Periodic
SWI_LBSPDDLOADOPTION_Single

enum SWI_TYPE_LbsPdEndStatus

Enumeration of PD end status values.

See Also: SWI_NOTIFY_LbsPdEnd; SWI_STRUCT_LbsPdEnd; SWI_STRUCT_LbsPdDloadEnd

Enumerator
SWI_LBSPDENDSTATUS_Offline
SWI_LBSPDENDSTATUS_NoService
SWI_LBSPDENDSTATUS_NoConnection
SWI_LBSPDENDSTATUS_NoData
SWI_LBSPDENDSTATUS_SessionBusy
SWI_LBSPDENDSTATUS_CdmaLock
SWI_LBSPDENDSTATUS_GpsLock
SWI_LBSPDENDSTATUS_ConnectionFailed
SWI_LBSPDENDSTATUS_ErrorState
SWI_LBSPDENDSTATUS_ClientEnded
SWI_LBSPDENDSTATUS_UiEnded
SWI_LBSPDENDSTATUS_NetworkEnded
SWI_LBSPDENDSTATUS_Timeout
SWI_LBSPDENDSTATUS_PrivacyLevel
SWI_LBSPDENDSTATUS_NetworkAccessError
SWI_LBSPDENDSTATUS_FixError
SWI_LBSPDENDSTATUS_PdeRejected
SWI_LBSPDENDSTATUS_TrafficChannelExited
SWI_LBSPDENDSTATUS_E911
SWI_LBSPDENDSTATUS_ServerError
SWI_LBSPDENDSTATUS_StaleBsInformation

enum SWI_TYPE_LbsPdErr

Enumeration of PD error types

See Also: SWI_STRUCT_LbsPdGetStatus

Enumerator
SWI_LBSPDERR_NoError
SWI_LBSPDERR_InternalModemError
SWI_LBSPDERR_BadServiceType
SWI_LBSPDERR_BadSessionType
SWI_LBSPDERR_InvalidPrivacy
SWI_LBSPDERR_InvalidDataDownload
SWI_LBSPDERR_InvalidNetworkAccess
SWI_LBSPDERR_InvalidOperationMode
SWI_LBSPDERR_InvalidNumberOfFixes
SWI_LBSPDERR_InvalidServerInfo
SWI_LBSPDERR_InvalidTimeout
SWI_LBSPDERR_InvalidQosParameter
SWI_LBSPDERR_NoSessionActive
SWI_LBSPDERR_SessionAlreadyActive
SWI_LBSPDERR_SessionBusy
SWI_LBSPDERR_PhoneIsOffline
SWI_LBSPDERR_CDMALockError
SWI_LBSPDERR_GPSLockError
SWI_LBSPDERR_InvalidState
SWI_LBSPDERR_ConnectionFailure
SWI_LBSPDERR_NoBuffersAvailable
SWI_LBSPDERR_SearcherError
SWI_LBSPDERR_CannotReportNow
SWI_LBSPDERR_ModeNotSupported
SWI_LBSPDERR_OtherError
SWI_LBSPDERR_FixRateForTrackingTooLarge

enum SWI_TYPE_LbsPdStatus

Enumeration of LBS PD status

See Also: SWI_STRUCT_LbsPdGetStatus

Enumerator
SWI_LBSPDSTATUS_None
SWI_LBSPDSTATUS_Active
SWI_LBSPDSTATUS_Success
SWI_LBSPDSTATUS_Error

enum SWI_TYPE_LbsSession

Enumeration of session types

See Also: SWI_STRUCT_LbsPdEndSession

Enumerator
SWI_LBSSESSION_LocationFix
SWI_LBSSESSION_Download

enum SWI_TYPE_SDPU

Enumeration representing the Standard Deviation for Position Uncertainty

From IS801-1 Values are 0 - 31 and map to the list below it (in Meters)

0, 1,2, 3,4,5,6,7,8, 9,10,11,12,13,14,15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30,31,32
.5,.75,1,1.5,2,3,4,6,8,12,16,24,32,48,64,96,128,192,256,384,512,768,1024,1536,2048,3072,4096,6144,8192,12288,12288, 0,0

Doxygen formatting of the same information presented above

0	1	2	3	4	5	6	7	8	9	10	11	12	13	14	15	16	17	18	19	20	21	22	23	24	25	26	27	28	29	30	31	32
.5	.75	1	1.5	2	3	4	6	8	12	16	24	32	48	64	96	128	192	256	384	512	768	1024	1536	2048	3072	4096	6144	8192	12288	12288	0	0

See Also: SWI_STRUCT_LbsPdData

Enumerator
SWI_SDPU_0Dot5
SWI_SDPU_0Dot75
SWI_SDPU_1
SWI_SDPU_1Dot5
SWI_SDPU_2
SWI_SDPU_3
SWI_SDPU_4
SWI_SDPU_6
SWI_SDPU_8
SWI_SDPU_12
SWI_SDPU_16
SWI_SDPU_24
SWI_SDPU_32
SWI_SDPU_48
SWI_SDPU_64
SWI_SDPU_96
SWI_SDPU_128
SWI_SDPU_192
SWI_SDPU_256
SWI_SDPU_384
SWI_SDPU_512
SWI_SDPU_768
SWI_SDPU_1024
SWI_SDPU_1536
SWI_SDPU_2048
SWI_SDPU_3072
SWI_SDPU_4096
SWI_SDPU_6144
SWI_SDPU_8192
SWI_SDPU_12288
SWI_SDPU_GreaterThan12288
SWI_SDPU_NotComputable

Function Documentation

SWI_API SWI_RCODE SwiGetLbsPaIpAddr	(	struct SWI_STRUCT_LbsPaIpAddr *	psPaIpAddr,
		swi_uint32	timeout
	)

This function is used to get GPS IP Address settings from the modem.

The PDE IP Address is a write only field and is not to be displayed to users. This API will return:

0.0.0.0 : The IP address is 0.0.0.0 or PDE NV Item is inactive (GPS not supported).
255.255.255.255 : The device has valid PDE IP address.
IP Address : The device is internally unlocked and will return the true address.

Parameters

psPaIpAddr,:	[OUT] A pointer to a SWI_STRUCT_LbsPaIpAddr structure which contains the TCP/IP address information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsPaParam	(	struct SWI_STRUCT_LbsPaGetParam *	psLbsPdGetParam,
		swi_uint32	timeout
	)

This function requests the modem's default parameter settings.

Parameters

psLbsPdGetParam,:	[OUT] A pointer to a SWI_STRUCT_LbsPaGetParam structure which contains the position determination parameters.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsPaPortId	(	struct SWI_STRUCT_LbsPaPortId *	psPaPortId,
		swi_uint32	timeout
	)

This function is used to get the GPS port ID used in LBS sessions.

Parameters

psPaPortId,:	[OUT] A pointer to a SWI_STRUCT_LbsPaPortId structure which contains the port ID.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsPdData	(	struct SWI_STRUCT_LbsPdData *	psLbsPdData,
		swi_uint32	timeout
	)

This function gets the results of the position fix.

Parameters

psLbsPdData,:	[OUT] A pointer to a SWI_STRUCT_LbsPdData structure which contains the position fix results.
timeout,:	[IN] Function timeout in milliseconds.

Returns: An error will be returned if there is no position fix information to report. See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsPdStatus	(	struct SWI_STRUCT_LbsPdGetStatus *	psLbsPdGetStatus,
		swi_uint32	timeout
	)

This function requests that the modem provide the current status of the LBS.

Parameters

psLbsPdGetStatus	[OUT] A pointer to a SWI_STRUCT_LbsPdGetStatus structure which contains the current status of the LBS.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiGetLbsSatInfo	(	struct SWI_STRUCT_LbsSatInfo *	psSatInfo,
		swi_uint32	timeout
	)

Use this function to get current GPS satellite information.

Parameters

psSatInfo,:	[OUT] A pointer to a SWI_STRUCT_LbsSatInfo structure which contains satellite information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsClearAssistance	(	const struct SWI_STRUCT_LbsClearAssistance *	psLbsClearAssistance,
		swi_uint32	timeout
	)

This function requests that the modem clear various location parameters to simulate a cold start.

Parameters

psLbsClearAssistance,:	[IN] A pointer to a SWI_STRUCT_LbsClearAssistance structure which contains parameters to clear.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsPaIpAddr	(	const struct SWI_STRUCT_LbsPaIpAddr *	psPaIpAddr,
		swi_uint32	timeout
	)

This function is used to set current GPS IP Address.

Parameters

psPaIpAddr,:	[IN] A pointer to a SWI_STRUCT_LbsPaIpAddr structure which contains the TCP/IP address information.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsPaPortId	(	const struct SWI_STRUCT_LbsPaPortId *	psPAPortID,
		swi_uint32	timeout
	)

This function is used to set the GPS port ID used in LBS sessions.

Parameters

psPAPortID,:	[IN] A pointer to a SWI_STRUCT_LbsPaPortId structure which contains the port ID.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsPdEndSession	(	const struct SWI_STRUCT_LbsPdEndSession *	psLbsPdEndSession,
		swi_uint32	timeout
	)

This function is used to end current LBS tracking session.

This API will respond with a SWI_NOTIFY_LbsPdDone/SWI_NOTIFY_LbsPdEnd notification that includes the End status.

There may be one of each type of session active simultaneously.

Parameters

psLbsPdEndSession,:	[IN] A pointer to a SWI_STRUCT_LbsPdEndSession structure which contains the current tracking session to terminate.
timeout,:	[IN] Function timeout in milliseconds.

Returns: See SWI_RCODE for additional information.

SWI_API SWI_RCODE SwiSetLbsPdGetPos	(	const struct SWI_STRUCT_LbsPdGetPos *	psLbsPdGetPos,
		swi_uint32	timeout
	)

This function is used to initiate a location fix.

If the location fix initiation is successful, the following notifications will inform the host of the location fix progress and termination:

   - SWI_NOTIFY_LbsPdDone
   - SWI_NOTIFY_LbsPdData
   - SWI_NOTIFY_LbsPdEnd
   - SWI_NOTIFY_LbsPdBegin
   - SWI_NOTIFY_LbsPdUpdateFailure
   - SWI_NOTIFY_LbsSatInfo

Parameters

psLbsPdGetPos,:	[IN] A pointer to a SWI_STRUCT_LbsPdGetPos structure which contains the location fix configuration.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK is returned if the modem is able to initiate a location fix.; If the modem is unable to initiate the location fix, an error code will be returned. See SwiRcodes.h for additional information.

SWI_API SWI_RCODE SwiSetLbsPdTrack	(	const struct SWI_STRUCT_LbsPdTrack *	psLbsPdTrack,
		swi_uint32	timeout
	)

This function requests that the modem start a tracking session.

If the track session was initiated successfully, the following notifications will inform the host of the location fix progress and termination:

SWI_NOTIFY_LbsPdDone
SWI_NOTIFY_LbsPdData
SWI_NOTIFY_LbsPdEnd
SWI_NOTIFY_LbsPdBegin
SWI_NOTIFY_LbsPdUpdateFailure
SWI_NOTIFY_LbsSatInfo

This command should be used when an application requires multiple location fixes over a small period of time (ex. a fix between every 1 to 240 seconds).

Due to the potential need for first updating the ephemeris, almanac and/or location data, the "time to first fix" may require more time than the subsequent fixes. Tracking applications need to consider this possible initial delay and may want to behave "pro actively" by initiating a Data Download session and/or a single location fix as part of their startup sequence. As a guideline, almanac data is valid for 3 to 4 days, ephemeris data is valid for 30 to 120 minutes, coarse location data is valid for 4 minutes.

Parameters

psLbsPdTrack,:	[IN] A pointer to a SWI_STRUCT_LbsPdTrack structure which contains the track session configuration.
timeout,:	[IN] Function timeout in milliseconds.

Returns: SWI_RCODE_OK is returned if the modem is able to initiate a location fix.; If the modem is unable to initiate the location fix, an error code will be returned. See SwiRcodes.h for additional information.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation