Linux SDK (lite-qmi)  MBPL_SDK_R25_ENG3
LocStartReq Struct Reference

#include <qaGobiApiLoc.h>

Data Fields

BYTE sessionId
 
ULONG * pFixRecurrence
 
ULONG * pHorizontalAccuracyLevel
 
ULONG * pIntermediateReportState
 
ULONG * pMinInterval
 
struct LocApplicationInfopApplicationInfo
 
ULONG * pConfigAltitudeAssumed
 
ULONG * pMinIntermediatePositionReportInterval
 
ULONG * pPositionReportTimeout
 
BYTE * pSharePosition
 
BYTE * pReportGnssOnlyPosition
 
struct LocGNSSPowerModepGNSSPowerMode
 

Detailed Description

This structure contains the LOC Start Request

Parameters
sessionId[IN]
  • ID of the session as identified by the control point. The session ID is reported back in the position reports.
    • The control point must specify the same session ID in the QMI_LOC_STOP_REQ message.
  • Range: 0 to 255
pFixRecurrence[IN][OPTIONAL]
  • Specifies the type of session in which the control point is interested.
  • If this TLV is not specified, recurrence defaults toDefaults to SINGLE.
  • Valid values:
    • eQMI_LOC_RECURRENCE_PERIODIC (1) - Request periodic position fixes
    • eQMI_LOC_RECURRENCE_SINGLE (2) - Request a single position fix
pHorizontalAccuracyLevel[IN][OPTIONAL]
  • Specifies the horizontal accuracy level required by the control point.
  • . If not specified, accuracy defaults to LOW.
  • Valid values:
    • eQMI_LOC_ACCURACY_LOW (1) - Low accuracy
    • eQMI_LOC_ACCURACY_MED (2) - Medium accuracy
    • eQMI_LOC_ACCURACY_HIGH (3) - High accuracy
pIntermediateReportState[IN][OPTIONAL]
  • Enable/Disable Intermediate Reports
    • Specifies whether the control point is interested in receiving intermediate reports.
    • The control point must explicitly set this field to OFF if it does not wish to receive intermediate position reports.
    • Intermediate position reports are generated at 1 Hz and are ON by default. If intermediate reports are turned ON,
    • the client receives position reports even if the accuracy criteria are not met.
    • The status in such a position report is set to IN_PROGRESS in order for the control point to identify intermediate reports.
      • Valid values:
        • eQMI_LOC_INTERMEDIATE_REPORTS_ON (1) - Intermediate reports are turned on
        • eQMI_LOC_INTERMEDIATE_REPORTS_OFF (2) - Intermediate reports are turned off
pMinInterval[IN][OPTIONAL]
  • Minimum Interval Between Final Position Reports
  • Minimum time interval, specified by the control point, that must elapse between position reports.
  • Units - Milliseconds
  • Default - 1000 ms
Parameters
pApplicationInfo[IN][OPTIONAL]
  • ID of the Application that Sent this Request
    • Application provider, name, and version.
  • See LocApplicationInfo for more information
pConfigAltitudeAssumed[IN][OPTIONAL]
  • Configuration for Altitude Assumed Info in GNSS SV Info Event Info Event
  • Specifies the configuration to include Altitude Assumed information in the GNSS SV Info Event. When enabled, an additional GNSS SV Info event
    • indication is sent to the control point that also includes the altitude assumed information.
    • If not specified, the configuration defaults to ENABLED.
      • Valid values:
        • eQMI_LOC_ALTITUDE_ASSUMED_IN_GNSS_SV_INFO_ENABLED (1) - Enable Altitude Assumed information in GNSS SV Info Event.
        • eQMI_LOC_ALTITUDE_ASSUMED_IN_GNSS_SV_INFO_DISABLED (2) - Disable Altitude Assumed information in GNSS SV Info Event.
pMinIntermediatePositionReportInterval[IN][OPTIONAL]
  • Minimum Interval Between Intermediate Position Report
  • Minimum time interval for intermediate position reports, specified by the control point, that, between the position reports elapsed time,
  • must be longer than the interval time. If this optional value is not set or set to the default value (0), the intermediate position is reported when it is ready.
    • Units: Milliseconds
    • Default: 0 ms
pPositionReportTimeout[IN][OPTIONAL]
  • Maximum Wait Time to Get a Position Report
  • Maximum time to work on each fix, specified by the control point. The GPS engine returns QMI_ERR_INTERNAL
  • if a position cannot be obtained within the positionReportTimeout value.
    • Units: Milliseconds
    • Default: 255*1000 ms
    • Range: 1000 - 255*1000 ms
pSharePosition[IN][OPTIONAL]
  • Share Position Report with Other Clients
  • Share the position report with the other QMI_LOC clients:
  • 0x00 (FALSE) - Do not share the position report
  • 0x01 (TRUE) – Share the position report If this optional TLV is not set, the GPS engine allows the position sharing.
pReportGnssOnlyPosition[IN][OPTIONAL]
  • Report GNSS Only Position
  • Requests the GPS engine to report positions that could be GNSS only or combined with other technologies, such as Sensors.
    • Values:
      • 0x00 (FALSE) - Report GNSS only positions is disabled (default)
      • 0x01 (TRUE) – Report GNSS only positions is enabled
pGNSSPowerMode[IN][OPTIONAL]
  • GNSS Power Mode If the power mode is not set by the client,
  • eQMI_LOC_POWER_MODE_NORMAL is the default value. Please note that there may be other client with different powerMode setting.
  • In such cases, the GNSS receiver is configured with powerMode with highest power consumption among the requesting clients.
  • LocGNSSPowerMode for more information

The documentation for this struct was generated from the following file: