sbgEComLogGnssPos.h

Go to the documentation of this file.

 
#ifndef SBG_ECOM_LOG_GPS_POS_H
#define SBG_ECOM_LOG_GPS_POS_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Public definitions                                                 -//
//----------------------------------------------------------------------//

#define SBG_ECOM_GNSS_POS_GPS_L1_USED       (0x00000001u << 12)             
#define SBG_ECOM_GNSS_POS_GPS_L2_USED       (0x00000001u << 13)             
#define SBG_ECOM_GNSS_POS_GPS_L5_USED       (0x00000001u << 14)             
 
#define SBG_ECOM_GNSS_POS_GLO_L1_USED       (0x00000001u << 15)             
#define SBG_ECOM_GNSS_POS_GLO_L2_USED       (0x00000001u << 16)             
#define SBG_ECOM_GNSS_POS_GLO_L3_USED       (0x00000001u << 17)             
 
#define SBG_ECOM_GNSS_POS_GAL_E1_USED       (0x00000001u << 18)             
#define SBG_ECOM_GNSS_POS_GAL_E5A_USED      (0x00000001u << 19)             
#define SBG_ECOM_GNSS_POS_GAL_E5B_USED      (0x00000001u << 20)             
#define SBG_ECOM_GNSS_POS_GAL_E5ALT_USED    (0x00000001u << 21)             
#define SBG_ECOM_GNSS_POS_GAL_E6_USED       (0x00000001u << 22)             
 
#define SBG_ECOM_GNSS_POS_BDS_B1_USED       (0x00000001u << 23)             
#define SBG_ECOM_GNSS_POS_BDS_B2_USED       (0x00000001u << 24)             
#define SBG_ECOM_GNSS_POS_BDS_B3_USED       (0x00000001u << 25)             
 
#define SBG_ECOM_GNSS_POS_QZSS_L1_USED      (0x00000001u << 26)             
#define SBG_ECOM_GNSS_POS_QZSS_L2_USED      (0x00000001u << 27)             
#define SBG_ECOM_GNSS_POS_QZSS_L5_USED      (0x00000001u << 28)             
#define SBG_ECOM_GNSS_POS_QZSS_L6_USED      (0x00000001u << 29)             

typedef enum _SbgEComGnssPosStatus
{
    SBG_ECOM_GNSS_POS_STATUS_SOL_COMPUTED      = 0,                        
    SBG_ECOM_GNSS_POS_STATUS_INSUFFICIENT_OBS  = 1,                        
    SBG_ECOM_GNSS_POS_STATUS_INTERNAL_ERROR      = 2,                        
    SBG_ECOM_GNSS_POS_STATUS_HEIGHT_LIMIT      = 3                         
} SbgEComGnssPosStatus;

typedef enum _SbgEComGnssPosType
{
    SBG_ECOM_GNSS_POS_TYPE_NO_SOLUTION            = 0,                        
    SBG_ECOM_GNSS_POS_TYPE_UNKNOWN                = 1,                        
    SBG_ECOM_GNSS_POS_TYPE_SINGLE              = 2,                        
    SBG_ECOM_GNSS_POS_TYPE_PSRDIFF                = 3,                        
    SBG_ECOM_GNSS_POS_TYPE_SBAS                  = 4,                        
    SBG_ECOM_GNSS_POS_TYPE_OMNISTAR              = 5,                        
    SBG_ECOM_GNSS_POS_TYPE_RTK_FLOAT            = 6,                        
    SBG_ECOM_GNSS_POS_TYPE_RTK_INT                = 7,                        
    SBG_ECOM_GNSS_POS_TYPE_PPP_FLOAT            = 8,                        
    SBG_ECOM_GNSS_POS_TYPE_PPP_INT                = 9,                        
    SBG_ECOM_GNSS_POS_TYPE_FIXED                = 10                        
} SbgEComGnssPosType;

typedef enum _SbgEComGnssIfmStatus
{
    SBG_ECOM_GNSS_IFM_STATUS_ERROR                = 0,                        
    SBG_ECOM_GNSS_IFM_STATUS_UNKNOWN            = 1,                        
    SBG_ECOM_GNSS_IFM_STATUS_CLEAN                = 2,                        
    SBG_ECOM_GNSS_IFM_STATUS_MITIGATED            = 3,                        
    SBG_ECOM_GNSS_IFM_STATUS_CRITICAL          = 4                         
} SbgEComGnssIfmStatus;

typedef enum _SbgEComGnssSpoofingStatus
{
    SBG_ECOM_GNSS_SPOOFING_STATUS_ERROR          = 0,                        
    SBG_ECOM_GNSS_SPOOFING_STATUS_UNKNOWN      = 1,                        
    SBG_ECOM_GNSS_SPOOFING_STATUS_CLEAN          = 2,                        
    SBG_ECOM_GNSS_SPOOFING_STATUS_SINGLE        = 3,                        
    SBG_ECOM_GNSS_SPOOFING_STATUS_MULTIPLE        = 4                         
} SbgEComGnssSpoofingStatus;

typedef enum _SbgEComGnssOsnmaStatus
{
    SBG_ECOM_GNSS_OSNMA_STATUS_ERROR            = 0,                        
    SBG_ECOM_GNSS_OSNMA_STATUS_DISABLED          = 1,                        
    SBG_ECOM_GNSS_OSNMA_STATUS_INITIALIZING      = 2,                        
    SBG_ECOM_GNSS_OSNMA_STATUS_WAITING_NTP        = 3,                        
    SBG_ECOM_GNSS_OSNMA_STATUS_VALID            = 4,                        
    SBG_ECOM_GNSS_OSNMA_STATUS_SPOOFED            = 5                         
} SbgEComGnssOsnmaStatus;
 
//----------------------------------------------------------------------//
//- Log structure definitions                                          -//
//----------------------------------------------------------------------//

typedef struct _SbgEComLogGnssPos
{
    uint32_t        timeStamp;             
    uint32_t        status;                   
    uint32_t        timeOfWeek;               
    double          latitude;               
    double          longitude;             
    double          altitude;               
    float           undulation;               
    float           latitudeAccuracy;       
    float           longitudeAccuracy;     
    float           altitudeAccuracy;       
    uint8_t         numSvUsed;             
    uint16_t        baseStationId;         
    uint16_t        differentialAge;     
    uint8_t         numSvTracked;           
    uint32_t        statusExt;             
    uint8_t         nrDiagReboots;         
    uint32_t        upTime;                   
} SbgEComLogGnssPos;
 
//----------------------------------------------------------------------//
//- Public methods                                                     -//
//----------------------------------------------------------------------//

void sbgEComLogGnssPosZeroInit(SbgEComLogGnssPos *pLogData);

SbgErrorCode sbgEComLogGnssPosReadFromStream(SbgEComLogGnssPos *pLogData, SbgStreamBuffer *pStreamBuffer);

SbgErrorCode sbgEComLogGnssPosWriteToStream(const SbgEComLogGnssPos *pLogData, SbgStreamBuffer *pStreamBuffer);
 
//----------------------------------------------------------------------//
//- Public setters/getters                                             -//
//----------------------------------------------------------------------//

void sbgEComLogGnssPosSetStatus(SbgEComLogGnssPos *pLogData, SbgEComGnssPosStatus status);

SbgEComGnssPosStatus sbgEComLogGnssPosGetStatus(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetType(SbgEComLogGnssPos *pLogData, SbgEComGnssPosType posType);

SbgEComGnssPosType sbgEComLogGnssPosGetType(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetSignalsUsed(SbgEComLogGnssPos *pLogData, uint32_t signalMask);

bool sbgEComLogGnssPosSignalsAreUsed(const SbgEComLogGnssPos *pLogData, uint32_t signalsMask);

bool sbgEComLogGnssPosNumSvTrackedIsValid(const SbgEComLogGnssPos *pLogData);

bool sbgEComLogGnssPosNumSvUsedIsValid(const SbgEComLogGnssPos *pLogData);

bool sbgEComLogGnssPosBaseStationIdIsValid(const SbgEComLogGnssPos *pLogData);

bool sbgEComLogGnssPosDifferentialAgeIsValid(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetDifferentialAge(SbgEComLogGnssPos *pLogData, float differentialAge);

float sbgEComLogGnssPosGetDifferentialAge(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetIfmStatus(SbgEComLogGnssPos *pLogData, SbgEComGnssIfmStatus status);

SbgEComGnssIfmStatus sbgEComLogGnssPosGetIfmStatus(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetSpoofingStatus(SbgEComLogGnssPos *pLogData, SbgEComGnssSpoofingStatus status);

SbgEComGnssSpoofingStatus sbgEComLogGnssPosGetSpoofingStatus(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetOsnmaStatus(SbgEComLogGnssPos *pLogData, SbgEComGnssOsnmaStatus status);

SbgEComGnssOsnmaStatus sbgEComLogGnssPosGetOsnmaStatus(const SbgEComLogGnssPos *pLogData);

void sbgEComLogGnssPosSetUpTimeInvalid(SbgEComLogGnssPos *pLogData);

bool sbgEComLogGnssPosUpTimeIsValid(const SbgEComLogGnssPos *pLogData);
 
//----------------------------------------------------------------------//
//- DEPRECATED - Used for backward compatibility                       -//
//----------------------------------------------------------------------//
 
#ifdef SBG_ECOM_USE_DEPRECATED_MACROS
    #define SBG_ECOM_GPS_POS_GPS_L1_USED        (0x00000001u << 12)
    #define SBG_ECOM_GPS_POS_GPS_L2_USED        (0x00000001u << 13)
    #define SBG_ECOM_GPS_POS_GPS_L5_USED        (0x00000001u << 14)
 
    #define SBG_ECOM_GPS_POS_GLO_L1_USED        (0x00000001u << 15)
    #define SBG_ECOM_GPS_POS_GLO_L2_USED        (0x00000001u << 16)
    #define SBG_ECOM_GPS_POS_GLO_L3_USED        (0x00000001u << 17)
 
    #define SBG_ECOM_GPS_POS_GAL_E1_USED        (0x00000001u << 18)
    #define SBG_ECOM_GPS_POS_GAL_E5A_USED       (0x00000001u << 19)
    #define SBG_ECOM_GPS_POS_GAL_E5B_USED       (0x00000001u << 20)
    #define SBG_ECOM_GPS_POS_GAL_E5ALT_USED     (0x00000001u << 21)
    #define SBG_ECOM_GPS_POS_GAL_E6_USED        (0x00000001u << 22)
 
    #define SBG_ECOM_GPS_POS_BDS_B1_USED        (0x00000001u << 23)
    #define SBG_ECOM_GPS_POS_BDS_B2_USED        (0x00000001u << 24)
    #define SBG_ECOM_GPS_POS_BDS_B3_USED        (0x00000001u << 25)
 
    #define SBG_ECOM_GPS_POS_QZSS_L1_USED       (0x00000001u << 26)
    #define SBG_ECOM_GPS_POS_QZSS_L2_USED       (0x00000001u << 27)
    #define SBG_ECOM_GPS_POS_QZSS_L5_USED       (0x00000001u << 28)
    #define SBG_ECOM_GPS_POS_QZSS_L6_USED       (0x00000001u << 29)
 
    #define SBG_ECOM_POS_SOL_COMPUTED           (SBG_ECOM_GNSS_POS_STATUS_SOL_COMPUTED)
    #define SBG_ECOM_POS_INSUFFICIENT_OBS       (SBG_ECOM_GNSS_POS_STATUS_INSUFFICIENT_OBS)
    #define SBG_ECOM_POS_INTERNAL_ERROR         (SBG_ECOM_GNSS_POS_STATUS_INTERNAL_ERROR)
    #define SBG_ECOM_POS_HEIGHT_LIMIT           (SBG_ECOM_GNSS_POS_STATUS_HEIGHT_LIMIT)
        
    #define SBG_ECOM_POS_NO_SOLUTION            (SBG_ECOM_GNSS_POS_TYPE_NO_SOLUTION)
    #define SBG_ECOM_POS_UNKNOWN_TYPE           (SBG_ECOM_GNSS_POS_TYPE_UNKNOWN)
    #define SBG_ECOM_POS_SINGLE                 (SBG_ECOM_GNSS_POS_TYPE_SINGLE)
    #define SBG_ECOM_POS_PSRDIFF                (SBG_ECOM_GNSS_POS_TYPE_PSRDIFF)
    #define SBG_ECOM_POS_SBAS                   (SBG_ECOM_GNSS_POS_TYPE_SBAS)
    #define SBG_ECOM_POS_OMNISTAR               (SBG_ECOM_GNSS_POS_TYPE_OMNISTAR)
    #define SBG_ECOM_POS_RTK_FLOAT              (SBG_ECOM_GNSS_POS_TYPE_RTK_FLOAT)
    #define SBG_ECOM_POS_RTK_INT                (SBG_ECOM_GNSS_POS_TYPE_RTK_INT)
    #define SBG_ECOM_POS_PPP_FLOAT              (SBG_ECOM_GNSS_POS_TYPE_PPP_FLOAT)  
    #define SBG_ECOM_POS_PPP_INT                (SBG_ECOM_GNSS_POS_TYPE_PPP_INT)
    #define SBG_ECOM_POS_FIXED                  (SBG_ECOM_GNSS_POS_TYPE_FIXED)
#endif
 
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComGnssPosStatus    SbgEComGpsPosStatus);
SBG_DEPRECATED_TYPEDEF(typedef enum _SbgEComGnssPosType        SbgEComGpsPosType);
SBG_DEPRECATED_TYPEDEF(typedef struct _SbgEComLogGnssPos    SbgLogGpsPos);
 
SBG_DEPRECATED(uint32_t sbgEComLogGpsPosBuildStatus(SbgEComGnssPosStatus status, SbgEComGnssPosType type, uint32_t masks));
SBG_DEPRECATED(SbgEComGnssPosStatus sbgEComLogGpsPosGetStatus(uint32_t status));
SBG_DEPRECATED(SbgEComGnssPosType sbgEComLogGpsPosGetType(uint32_t status));
 
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogParseGpsPosData(SbgStreamBuffer *pStreamBuffer, SbgEComLogGnssPos *pLogData));
SBG_DEPRECATED(SbgErrorCode sbgEComBinaryLogWriteGpsPosData(SbgStreamBuffer *pStreamBuffer, const SbgEComLogGnssPos *pLogData));
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_ECOM_LOG_GNSS_POS_H