qaGobiApiLoc.h

Go to the documentation of this file.

/*
 * Copyright: © 2011-2015 Sierra Wireless, Inc. all rights reserved
 */
#ifndef __GOBI_API_LOC_H__
#define __GOBI_API_LOC_H__

#ifdef __cplusplus
extern "C" {
#endif

#define  MAX_SENSOR_DATA_LEN       64
#define  MAX_TEMP_DATA_LEN         64

typedef struct
{
    ULONGLONG eventRegister;
} LOCEventRegisterReqResp;

typedef struct
{
    ULONG extPowerState;
} LOCExtPowerStateReqResp;

struct LocApplicationInfo
{
    BYTE appProviderLength;
    CHAR *pAppProvider;
    BYTE appNameLength;
    CHAR *pAppName;
    BYTE appVersionValid;
    CHAR appVersionLength;
    CHAR *pAppVersion;
};

typedef struct
{
     BYTE    SessionId;
     ULONG   *pRecurrenceType;
     ULONG   *pHorizontalAccuracyLvl;
     ULONG   *pIntermediateReportState;
     ULONG   *pMinIntervalTime;
     struct   LocApplicationInfo *pApplicationInfo;
     ULONG   *pConfigAltitudeAssumed;
} LOCStartReq;

typedef struct
{
     BYTE     sessionId;
}LOCStopReq;



typedef struct
{
    WORD    id;
    ULONG   system;
    BYTE    mask;
}SV;


typedef struct
{
    BYTE    len;
    SV      *pSV;
}SVInfo;

typedef struct
{
    ULONGLONG   mask;
}GnssData;

typedef struct
{
    ULONG   mask;
}CellDb;

typedef struct
{
    ULONG   mask;
}ClkInfo;

typedef struct
{
    WORD    id;
    BYTE    mask;
}BdsSV;

typedef struct
{
    BYTE    len;
    BdsSV   *pSV;
}BdsSVInfo;



typedef struct
{
    SVInfo *pSVInfo;
    GnssData *pGnssData;
    CellDb *pCellDb;
    ClkInfo *pClkInfo;
    BdsSVInfo *pBdsSVInfo;
}LocDelAssDataReq;

ULONG SLQSLOCEventRegister (
        LOCEventRegisterReqResp *pLOCEventRegisterReqResp );
ULONG SLQSLOCSetExtPowerState(
        LOCExtPowerStateReqResp *pLOCExtPowerStateReqResp);

ULONG SLQSLOCStart(LOCStartReq *pLOCStartReq);
ULONG SLQSLOCStop(LOCStopReq *pLOCStopReq);

ULONG SLQSLOCSetOpMode(ULONG mode);

ULONG SLQSLOCDelAssData(LocDelAssDataReq request);

typedef struct
{
    BYTE function;
    BOOL function_reported;
    BYTE fix_type;
    BOOL fix_type_reported;
    BYTE max_time;
    BOOL max_time_reported;
    ULONG max_dist;
    BOOL max_dist_reported;
    ULONG fix_rate;
    BOOL fix_rate_reported;
} SwiLocGetAutoStartResp;

ULONG SwiLocGetAutoStart(SwiLocGetAutoStartResp *resp);

typedef struct
{
    BYTE function;
    BOOL set_function;
    BYTE fix_type;
    BOOL set_fix_type;
    BYTE max_time;
    BOOL set_max_time;
    ULONG max_dist;
    BOOL set_max_dist;
    ULONG fix_rate;
    BOOL set_fix_rate;
} SwiLocSetAutoStartReq;

ULONG SwiLocSetAutoStart(SwiLocSetAutoStartReq *req);

ULONG SLQSLOCInjectUTCTime(ULONGLONG timeMsec, ULONG timeUncMsec);

typedef struct
{
    ULONG    source;
    ULONG    linkage;
    ULONG    coverage;
}altitudeSrcInfo;

typedef struct
{
    ULONGLONG               *pLatitude;
    ULONGLONG               *pLongitude;
    ULONG                   *pHorUncCircular;
    BYTE                    *pHorConfidence;
    ULONG                   *pHorReliability;
    ULONG                   *pAltitudeWrtEllipsoid;
    ULONG                   *pAltitudeWrtMeanSeaLevel;
    ULONG                   *pVertUnc;
    BYTE                    *pVertConfidence;
    ULONG                   *pVertReliability;
    altitudeSrcInfo         *pAltitudeSrcInfo;
    ULONGLONG               *pTimestampUtc;
    ULONG                   *pTimestampAge;
    ULONG                   *pPositionSrc;
    ULONG                   *pRawHorUncCircular;
    BYTE                    *pRawHorConfidence;
} LocInjectPositionReq;

ULONG SLQSLOCInjectPosition(LocInjectPositionReq *pLocInjectPositionReq);

typedef struct
{
    ULONG               state;
    BYTE               *pConfidence;
} LocSetCradleMountReq;

ULONG SLQSLOCSetCradleMountConfig(LocSetCradleMountReq *pLocSetCradleMountReq);

typedef struct
{
    ULONG    timeOfFirstSample ;
    BYTE     flags;
    BYTE     sensorDataLen;
    WORD     timeOffset[MAX_SENSOR_DATA_LEN];
    ULONG    xAxis[MAX_SENSOR_DATA_LEN];
    ULONG    yAxis[MAX_SENSOR_DATA_LEN];
    ULONG    zAxis[MAX_SENSOR_DATA_LEN];
}sensorData;

typedef struct
{
    ULONG    timeSource;
    ULONG    timeOfFirstSample;
    BYTE     temperatureDataLen;
    WORD     timeOffset[MAX_TEMP_DATA_LEN];
    ULONG    temperature[MAX_TEMP_DATA_LEN];
}tempratureData;

typedef struct
{
    ULONG                *pOpaqueIdentifier;
    sensorData           *pAcceleroData;
    sensorData           *pGyroData;
    ULONG                *pAcceleroTimeSrc;
    ULONG                *pGyroTimeSrc;
    tempratureData       *pAcceleroTempData;
    tempratureData       *pGyroTempData;
} LocInjectSensorDataReq;

ULONG SLQSLOCInjectSensorData(LocInjectSensorDataReq *pLocInjectSensorDataReq);

ULONG SLQSLOCGetBestAvailPos(ULONG xid);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /* __GOBI_API_LOC_H__ */