pa_gnss.h

Go to the documentation of this file.

#ifndef LEGATO_PA_GNSS_INCLUDE_GUARD
#define LEGATO_PA_GNSS_INCLUDE_GUARD

#include "legato.h"

//--------------------------------------------------------------------------------------------------
// Symbol and Enum definitions.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    uint16_t hours;               
    uint16_t minutes;             
    uint16_t seconds;             
    uint16_t milliseconds;        
}
pa_Gnss_Time_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    uint16_t year;                
    uint16_t month;               
    uint16_t day;                 
}
pa_Gnss_Date_t;

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct {
    bool               latitudeValid; 
    int32_t            latitude;  

    bool               longitudeValid; 
    int32_t            longitude; 

    bool               altitudeValid; 
    int32_t            altitude;  

    bool               hSpeedValid; 
    uint32_t           hSpeed;    

    bool               vSpeedValid; 
    uint32_t           vSpeed;    

    bool               trackValid; 
    uint32_t           track;     

    bool               headingValid; 
    uint32_t           heading;     

    bool               hdopValid; 
    uint16_t           hdop;      

    bool               hUncertaintyValid; 
    uint32_t           hUncertainty;  

    bool               vUncertaintyValid; 
    uint32_t           vUncertainty;  

    bool               hSpeedUncertaintyValid; 
    uint32_t           hSpeedUncertainty;  

    bool               vSpeedUncertaintyValid; 
    uint32_t           vSpeedUncertainty;  

    bool               headingUncertaintyValid; 
    uint32_t           headingUncertainty;  

    bool               trackUncertaintyValid; 
    uint32_t           trackUncertainty;  

    bool               vdopValid; 
    uint16_t           vdop;      

    bool               timeValid; 
    pa_Gnss_Time_t     time;  

    bool               dateValid; 
    pa_Gnss_Date_t     date;  
}
pa_Gnss_Position_t;

typedef pa_Gnss_Position_t* pa_Gnss_Position_Ref_t;

//--------------------------------------------------------------------------------------------------
// APIs.
//--------------------------------------------------------------------------------------------------

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_Init
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_Release
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_Start
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_Stop
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_SetAcquisitionRate
(
    uint32_t rate     
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void(*pa_gnss_PositionDataHandlerFunc_t)(pa_Gnss_Position_Ref_t position);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_event_HandlerRef_t pa_gnss_AddPositionDataHandler
(
    pa_gnss_PositionDataHandlerFunc_t handler 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void pa_gnss_RemovePositionDataHandler
(
    le_event_HandlerRef_t    handlerRef 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_GetLastPositionData
(
    pa_Gnss_Position_Ref_t  positionRef   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_LoadXtra
(
    const char* xtraFilePathPtr    
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_GetXtraValidityTimes
(
    le_clk_Time_t *startTimePtr,    
    le_clk_Time_t *stopTimePtr      
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_GetXtraSessionStatus
(
    bool *enablePtr 
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_EnableXtraSession
(
    void
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t pa_gnss_DisableXtraSession
(
    void
);

#endif // LEGATO_PA_GNSS_INCLUDE_GUARD