SWI_API SWI_RCODE SwiGetLbsFixSettings | ( | SWI_STRUCT_LbsFixSettings * | psLbsFixSettings, | |
U32 | timeout | |||
) |
Use this function to retrieve location fix settings stored on the device.
[OUT] | psLbsSettings: A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings. | |
[IN] | timeout: Function timeout in milliseconds. |
See SWI_STRUCT_LbsFixSettings for actual results of the transaction.
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiGetLbsPaIpAddr | ( | SWI_STRUCT_LbsPaIpAddr * | psPaIpAddr, | |
U32 | 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:
[OUT] | psPaIpAddr: A pointer to a SWI_STRUCT_LbsPaIpAddr structure which contains the TCP/IP address information. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsPaParam | ( | SWI_STRUCT_LbsPaGetParam * | psLbsPdGetParam, | |
U32 | timeout | |||
) |
This function requests the modem's default parameter settings.
[OUT] | psLbsPdGetParam: A pointer to a SWI_STRUCT_LbsPaGetParam structure which contains the position determination parameters. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsPaPortId | ( | SWI_STRUCT_LbsPaPortId * | psPaPortId, | |
U32 | timeout | |||
) |
This function is used to get the GPS port ID used in LBS sessions.
[OUT] | psPaPortId: A pointer to a SWI_STRUCT_LbsPaPortId structure which contains the port ID. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsPaWarmStatus | ( | SWI_STRUCT_LbsPaWarmStatus * | psLbsPaWarmStatus, | |
U32 | timeout | |||
) |
Use this function to get the Keep Warm processing status.
[OUT] | psLbsPaWarmStatus: A pointer to a SWI_STRUCT_LbsPaWarmStatus structure which contains warm status information. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsPdData | ( | SWI_STRUCT_LbsPdData * | psLbsPdData, | |
U32 | timeout | |||
) |
This function gets the results of the position fix.
[OUT] | psLbsPdData: A pointer to a SWI_STRUCT_LbsPdData structure which contains the position fix results. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsPdStatus | ( | SWI_STRUCT_LbsPdGetStatus * | psLbsPdGetStatus, | |
U32 | timeout | |||
) |
This function requests that the modem provide the current status of the LBS.
[IN] | psLbsPdGetStatus: A pointer to a SWI_STRUCT_LbsPdGetStatus structure which contains the current status of the LBS. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiGetLbsSatInfo | ( | SWI_STRUCT_LbsSatInfo * | psSatInfo, | |
U32 | timeout | |||
) |
Use this function to get current GPS satellite information.
[OUT] | psSatInfo: A pointer to a SWI_STRUCT_LbsSatInfo structure which contains satellite information. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsClearAssistance | ( | const SWI_STRUCT_LbsClearAssistance * | psLbsClearAssistance, | |
U32 | timeout | |||
) |
This function requests that the modem clear various location parameters to simulate a cold start.
[IN] | psLbsClearAssistance: A pointer to a SWI_STRUCT_LbsClearAssistance structure which contains parameters to clear. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsFixSettings | ( | SWI_STRUCT_LbsFixSettings * | psLbsFixSettings, | |
U32 | timeout | |||
) |
Use this function to change location fix settings stored on the device.
[IN] | psLbsSettings: A pointer to a SWI_STRUCT_LbsFixSettings structure which contains location fix settings. | |
[IN] | timeout: Function timeout in milliseconds. |
See SWI_STRUCT_LbsFixSettings for actual results of the transaction.
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiSetLbsNiReq | ( | SWI_STRUCT_LbsNiReq * | pLbsNiReq, | |
U32 | timeout | |||
) |
Use this function to respond to a network initiated location fix request.
The host is notified of a network initiated location fix request via SWI_NOTIFY_LbsNiReq.
[IN/OUT] | pLbsNiReq: A pointer to a SWI_STRUCT_LbsNiReq structure which contains network initiated request information. | |
[IN] | timeout: Function timeout in milliseconds. |
See SWI_STRUCT_LbsNiReq::eErrCode for actual results of the transaction.
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiSetLbsPaIpAddr | ( | const SWI_STRUCT_LbsPaIpAddr * | psPaIpAddr, | |
U32 | timeout | |||
) |
This function is used to set current GPS IP Address.
[IN] | psPaIpAddr: A pointer to a SWI_STRUCT_LbsPaIpAddr structure which contains the TCP/IP address information. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStart | ( | U32 | timeout | ) |
Use this function to start Keep Warm processing.
This downloads GPS assistance data over the network. The status of the process can be monitored using:
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsPaKeepWarmStop | ( | U32 | timeout | ) |
Use this function to stop the Keep Warm processing.
SWI_NOTIFY_LbsPaWarmDone is generated when the process completes.
[IN] | timeout: Function timeout in milliseconds. |
See SWI_RCODE for additional information.
SWI_API SWI_RCODE SwiSetLbsPaPortId | ( | const SWI_STRUCT_LbsPaPortId * | psPAPortID, | |
U32 | timeout | |||
) |
This function is used to set the GPS port ID used in LBS sessions.
[IN] | psPAPortID: A pointer to a SWI_STRUCT_LbsPaPortId structure which contains the port ID. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsPdEndSession | ( | const SWI_STRUCT_LbsPdEndSession * | psLbsPdEndSession, | |
U32 | 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.
[IN] | psLbsPdEndSession: A pointer to a SWI_STRUCT_LbsPdEndSession structure which contains the current tracking session to terminate. | |
[IN] | timeout: Function timeout in milliseconds. |
SWI_API SWI_RCODE SwiSetLbsPdGetPos | ( | const SWI_STRUCT_LbsPdGetPos * | psLbsPdGetPos, | |
U32 | 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:
[IN] | psLbsPdGetPos: A pointer to a SWI_STRUCT_LbsPdGetPos structure which contains the location fix configuration. | |
[IN] | timeout: Function timeout in milliseconds. |
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 SWI_STRUCT_LbsPdTrack * | psLbsPdTrack, | |
U32 | 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:
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.
[IN] | psLbsPdTrack: A pointer to a SWI_STRUCT_LbsPdTrack structure which contains the track session configuration. | |
[IN] | timeout: Function timeout in milliseconds. |
If the modem is unable to initiate the location fix, an error code will be returned. See SwiRcodes.h for additional information.