qaGobiApiLoc.h File Reference

Location API function prototypes. More...

Go to the source code of this file.

Data Structures
struct	LOCEventRegisterReqResp
struct	LOCExtPowerStateReqResp
struct	LocApplicationInfo
struct	LOCStartReq
struct	LOCStopReq
struct	SV
struct	SVInfo
struct	GnssData
struct	CellDb
struct	ClkInfo
struct	BdsSV
struct	BdsSVInfo
struct	LocDelAssDataReq
struct	SwiLocGetAutoStartResp
struct	SwiLocSetAutoStartReq
struct	altitudeSrcInfo
struct	LocInjectPositionReq
struct	LocSetCradleMountReq
struct	sensorData
struct	tempratureData
struct	LocInjectSensorDataReq

Macros
#define	MAX_SENSOR_DATA_LEN   64
#define	MAX_TEMP_DATA_LEN   64

Functions
ULONG	SLQSLOCEventRegister (LOCEventRegisterReqResp *pLOCEventRegisterReqResp)
ULONG	SLQSLOCSetExtPowerState (LOCExtPowerStateReqResp *pLOCExtPowerStateReqResp)
ULONG	SLQSLOCStart (LOCStartReq *pLOCStartReq)
ULONG	SLQSLOCStop (LOCStopReq *pLOCStopReq)
ULONG	SLQSLOCSetOpMode (ULONG mode)
ULONG	SLQSLOCDelAssData (LocDelAssDataReq request)
ULONG	SwiLocGetAutoStart (SwiLocGetAutoStartResp *resp)
ULONG	SwiLocSetAutoStart (SwiLocSetAutoStartReq *req)
ULONG	SLQSLOCInjectUTCTime (ULONGLONG timeMsec, ULONG timeUncMsec)
ULONG	SLQSLOCInjectPosition (LocInjectPositionReq *pLocInjectPositionReq)
ULONG	SLQSLOCSetCradleMountConfig (LocSetCradleMountReq *pLocSetCradleMountReq)
ULONG	SLQSLOCInjectSensorData (LocInjectSensorDataReq *pLocInjectSensorDataReq)

Detailed Description

Location API function prototypes.

Macro Definition Documentation

#define MAX_SENSOR_DATA_LEN   64

#define MAX_TEMP_DATA_LEN   64

Function Documentation

ULONG SLQSLOCDelAssData

(

LocDelAssDataReq

request

)

Used by the control point to delete the location engine assistance data

Parameters

request[IN]

request structure parameters should contain all NULL pointers to delete all assistance data. Otherwise, specify optional fields to be deleted. See LocDelAssDataReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCEventRegister

(

LOCEventRegisterReqResp *

pLOCEventRegisterReqResp

)

Used by the control point to register for events from the location subsystem.

Parameters

pLOCEventRegisterReqResp[IN]

See LOCEventRegisterReqResp for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCInjectPosition

(

LocInjectPositionReq *

pLocInjectPositionReq

)

Injects a position to the location engine.

Parameters

pLocInjectPositionReq[IN]

See LocInjectPositionReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCInjectSensorData

(

LocInjectSensorDataReq *

pLocInjectSensorDataReq

)

Control point to to inject sensor data into the GNSS location engine.

Parameters

pLocInjectSensorDataReq[IN]

See LocInjectSensorDataReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCInjectUTCTime	(	ULONGLONG	timeMsec,
		ULONG	timeUncMsec
	)

Injects UTC time in the location engine.

Parameters

timeMsec[IN]	The UTC time since Jan. 1, 1970
timeUncMsec[IN]	The time Uncertainty

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCSetCradleMountConfig

(

LocSetCradleMountReq *

pLocSetCradleMountReq

)

Control point to set the current cradle mount configuration.

Parameters

pLocSetCradleMountReq[IN]

See LocSetCradleMountReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCSetExtPowerState

(

LOCExtPowerStateReqResp *

pLOCExtPowerStateReqResp

)

Used by the control point to set the current external power configuration.

Parameters

pLOCExtPowerStateReqResp[IN]

See LOCExtPowerStateReqResp for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCSetOpMode

(

ULONG

mode

)

Used by the control point to tells the engine to use the specified operation mode while making the position fixes

Parameters

mode[IN]

Valid values: eQMI_LOC_OPER_MODE_DEFAULT (1) - Use the default engine mode eQMI_LOC_OPER_MODE_MSB (2) - Use the MS-based mode eQMI_LOC_OPER_MODE_MSA (3) - Use the MS-assisted mode eQMI_LOC_OPER_MODE_STANDALONE (4) - Use Standalone mode eQMI_LOC_OPER_MODE_CELL_ID (5) - Use cell ID; this mode is only valid for GSM/UMTS networks eQMI_LOC_OPER_MODE_WWAN (6) - Use WWAN measurements to calculate the position; if this mode is set, AFLT will be used for 1X networks and OTDOA will be used for LTE networks

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCStart

(

LOCStartReq *

pLOCStartReq

)

Used by the control point to initiate a GPS session.

Parameters

pLOCStartReqReq[IN]

See LOCStartReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SLQSLOCStop

(

LOCStopReq *

pLOCStopReq

)

Used by the control point to stop a GPS session.

Parameters

pLOCStopReqResp[IN]

See LOCStopReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

Note

Timeout: 5 seconds

ULONG SwiLocGetAutoStart

(

SwiLocGetAutoStartResp *

resp

)

Used by the control point to Get Loc Auto Start settings

Parameters

resp[OUT]

See SwiLocGetAutoStartResp for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values

ULONG SwiLocSetAutoStart

(

SwiLocSetAutoStartReq *

req

)

Used by the control point to Set Loc Auto Start settings

Parameters

req[IN]

See SwiLocSetAutoStartReq for more information

Returns

eQCWWAN_ERR_NONE on success, eQCWWAN_xxx error value otherwise

See Also

See qmerrno.h for eQCWWAN_xxx error values