le_gnss_interface.h
Go to the documentation of this file.
24 * GNSS or Global Navigation Satellite System is a satellite navigation system with global coverage.103 * The le_gnss_InjectUtcTime() function injects the UTC time into the location engine. Providing an105 * @note It is mandatory to enable the 'Extended Ephemeris' file injection into the GNSS device with109 * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for113 * The le_gnss_ForceHotRestart() function performs a "HOT" restart of the GNSS device. The current118 * The le_gnss_ForceWarmRestart() function performs a "WARM" restart of the GNSS device. The current125 * The le_gnss_ForceColdRestart() function performs a "COLD" restart of the GNSS device. The current135 * The GNSS position is computed and delivered each acquisition rate. The acquisition rate defines152 * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for155 * Combinations of constellation for GPS, GLONASS, BDS, GALILEO and QZSS satellites are currently162 * le_gnss_SetConstellationArea sets the area for a GNSS constellation. le_gnss_GetConstellationArea181 * @ref le_gnss_NMEA with a bit mask. The supported values are listed in @ref le_gnss_NmeaBitMask_t.184 * Please refer to your platform documentation @ref platformConstraintsGnss_SettingConfiguration for189 * The le_gnss_GetNmeaSentences() function gets the bit mask of the enabled NMEA sentences in the199 * ''LE_OK or error code'' means the function is authorized in the corresponding state, the request200 * is performed and the result is returned; otherwise the returned error is indicated for each state203 *| ----------------------------- | --------------------------- | -----------------------------| --------------------------- | --------------------------- |206 *| le_gnss_ForceHotRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |207 *| le_gnss_ForceWarmRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |208 *| le_gnss_ForceColdRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |209 *| le_gnss_ForceFactoryRestart() | LE_NOT_PERMITTED | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED |210 *| le_gnss_Disable() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_DUPLICATE |212 *| le_gnss_SetConstellation() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |213 *| le_gnss_GetConstellation() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |214 *| le_gnss_SetConstellationArea() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |215 *| le_gnss_GetConstellationArea() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |216 *| le_gnss_GetTtff() | LE_NOT_PERMITTED | LE_OK or error code | LE_OK or error code | LE_NOT_PERMITTED |217 *| le_gnss_SetAcquisitionRate() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |218 *| le_gnss_GetAcquisitionRate() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |219 *| le_gnss_SetNmeaSentences() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |220 *| le_gnss_GetNmeaSentences() | LE_NOT_PERMITTED | LE_OK or error code | LE_NOT_PERMITTED | LE_NOT_PERMITTED |296 * With le_gnss_GetExtendedEphemerisValidity(), you will to get the validity of the last injected309 * That 3GPP User Plane A-GNSS (Assisted GNSS) protocol is defined by two different standardization310 * bodies, 3GPP and Open Mobile Alliance (OMA). For more information, please refer to the standard.315 *, then returns the retrieved GNSS data to the SUPL (Secure User Plan Location) server, where the319 * server. The MS measures the signals from the GNSS satellites and makes the position calculation.332 * The SUPL server is configured using the le_gnss_SetSuplServerUrl() function. That function sets336 * le_gnss_InjectSuplCertificate() function and deleted through the le_gnss_DeleteSuplCertificate()338 * The SUPL certificate lenght given as parameter to le_gnss_InjectSuplCertificate() must be less410 //--------------------------------------------------------------------------------------------------414 //--------------------------------------------------------------------------------------------------417 //--------------------------------------------------------------------------------------------------420 * Connect the current client thread to the service providing this API. Block until the service is423 * For each thread that wants to use this API, either ConnectService or TryConnectService must be424 * called before any other functions in this API. Normally, ConnectService is automatically called429 //--------------------------------------------------------------------------------------------------435 //--------------------------------------------------------------------------------------------------438 * Try to connect the current client thread to the service providing this API. Return with an error441 * For each thread that wants to use this API, either ConnectService or TryConnectService must be442 * called before any other functions in this API. Normally, ConnectService is automatically called451 * - LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).454 //--------------------------------------------------------------------------------------------------460 //--------------------------------------------------------------------------------------------------464 * When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants467 //--------------------------------------------------------------------------------------------------474 //--------------------------------------------------------------------------------------------------480 * longer a connection to the service, and the functions in this API can't be used. For details, see485 //--------------------------------------------------------------------------------------------------492 //--------------------------------------------------------------------------------------------------496 //--------------------------------------------------------------------------------------------------499 //--------------------------------------------------------------------------------------------------504 //--------------------------------------------------------------------------------------------------507 //--------------------------------------------------------------------------------------------------511 //--------------------------------------------------------------------------------------------------514 //--------------------------------------------------------------------------------------------------519 //--------------------------------------------------------------------------------------------------522 //--------------------------------------------------------------------------------------------------526 //--------------------------------------------------------------------------------------------------529 //--------------------------------------------------------------------------------------------------535 //--------------------------------------------------------------------------------------------------538 //--------------------------------------------------------------------------------------------------542 //--------------------------------------------------------------------------------------------------545 //--------------------------------------------------------------------------------------------------552 //--------------------------------------------------------------------------------------------------555 //--------------------------------------------------------------------------------------------------558 //--------------------------------------------------------------------------------------------------561 //--------------------------------------------------------------------------------------------------564 //--------------------------------------------------------------------------------------------------567 //--------------------------------------------------------------------------------------------------570 //--------------------------------------------------------------------------------------------------573 //--------------------------------------------------------------------------------------------------576 //--------------------------------------------------------------------------------------------------579 //--------------------------------------------------------------------------------------------------582 //--------------------------------------------------------------------------------------------------585 //--------------------------------------------------------------------------------------------------589 //--------------------------------------------------------------------------------------------------593 //--------------------------------------------------------------------------------------------------597 //--------------------------------------------------------------------------------------------------614 //--------------------------------------------------------------------------------------------------618 //--------------------------------------------------------------------------------------------------633 //--------------------------------------------------------------------------------------------------637 //--------------------------------------------------------------------------------------------------659 //--------------------------------------------------------------------------------------------------663 //--------------------------------------------------------------------------------------------------692 //--------------------------------------------------------------------------------------------------696 //--------------------------------------------------------------------------------------------------709 //--------------------------------------------------------------------------------------------------713 //--------------------------------------------------------------------------------------------------732 //--------------------------------------------------------------------------------------------------736 //--------------------------------------------------------------------------------------------------749 //--------------------------------------------------------------------------------------------------755 //--------------------------------------------------------------------------------------------------773 //--------------------------------------------------------------------------------------------------785 //--------------------------------------------------------------------------------------------------792 LE_GNSS_NMEA_MASK_GPVTG = 0x10, ///< GPVTG type enabled: GPS vector track and speed over the ground.800 LE_GNSS_NMEA_MASK_GAVTG = 0x1000, ///< GAVTG type enabled: Galileo vector track and speed over the ground.802 LE_GNSS_NMEA_MASK_PQXFI = 0x4000, ///< PQXFI type enabled: Proprietary Qualcomm eXtended Fix Information.805 LE_GNSS_NMEA_MASK_GPGLL = 0x20000, ///< GPGLL type enabled: GPS Geographic position, latitude / longitude.811 //--------------------------------------------------------------------------------------------------815 //--------------------------------------------------------------------------------------------------819 //--------------------------------------------------------------------------------------------------824 //--------------------------------------------------------------------------------------------------826 (833 //--------------------------------------------------------------------------------------------------846 //--------------------------------------------------------------------------------------------------853 //--------------------------------------------------------------------------------------------------861 //--------------------------------------------------------------------------------------------------868 //--------------------------------------------------------------------------------------------------882 //--------------------------------------------------------------------------------------------------891 //--------------------------------------------------------------------------------------------------901 //--------------------------------------------------------------------------------------------------910 //--------------------------------------------------------------------------------------------------921 //--------------------------------------------------------------------------------------------------927 //--------------------------------------------------------------------------------------------------938 //--------------------------------------------------------------------------------------------------944 //--------------------------------------------------------------------------------------------------955 //--------------------------------------------------------------------------------------------------962 //--------------------------------------------------------------------------------------------------971 //--------------------------------------------------------------------------------------------------980 //--------------------------------------------------------------------------------------------------989 * @note It is mandatory to enable the 'Extended Ephemeris' file injection into the GNSS device with992 //--------------------------------------------------------------------------------------------------1001 //--------------------------------------------------------------------------------------------------1012 //--------------------------------------------------------------------------------------------------1018 //--------------------------------------------------------------------------------------------------1029 //--------------------------------------------------------------------------------------------------1035 //--------------------------------------------------------------------------------------------------1045 //--------------------------------------------------------------------------------------------------1051 //--------------------------------------------------------------------------------------------------1063 //--------------------------------------------------------------------------------------------------1069 //--------------------------------------------------------------------------------------------------1079 //--------------------------------------------------------------------------------------------------1085 //--------------------------------------------------------------------------------------------------1095 //--------------------------------------------------------------------------------------------------1101 //--------------------------------------------------------------------------------------------------1111 //--------------------------------------------------------------------------------------------------1118 //--------------------------------------------------------------------------------------------------1131 //--------------------------------------------------------------------------------------------------1137 //--------------------------------------------------------------------------------------------------1150 //--------------------------------------------------------------------------------------------------1156 //--------------------------------------------------------------------------------------------------1168 * @warning This function may be subject to limitations depending on the platform. Please refer to1174 //--------------------------------------------------------------------------------------------------1181 //--------------------------------------------------------------------------------------------------1190 //--------------------------------------------------------------------------------------------------1197 //--------------------------------------------------------------------------------------------------1207 //--------------------------------------------------------------------------------------------------1216 //--------------------------------------------------------------------------------------------------1220 //--------------------------------------------------------------------------------------------------1227 //--------------------------------------------------------------------------------------------------1237 //--------------------------------------------------------------------------------------------------1246 //--------------------------------------------------------------------------------------------------1268 //--------------------------------------------------------------------------------------------------1281 //--------------------------------------------------------------------------------------------------1290 * @note Altitude is in meters, above Mean Sea Level, with 3 decimal places (3047 = 3.047 meters).1299 //--------------------------------------------------------------------------------------------------1310 //--------------------------------------------------------------------------------------------------1322 //--------------------------------------------------------------------------------------------------1337 //--------------------------------------------------------------------------------------------------1349 //--------------------------------------------------------------------------------------------------1360 //--------------------------------------------------------------------------------------------------1375 //--------------------------------------------------------------------------------------------------1384 //--------------------------------------------------------------------------------------------------1396 //--------------------------------------------------------------------------------------------------1405 //--------------------------------------------------------------------------------------------------1414 * @note The leap seconds in advance is the accumulated time in seconds since the start of GPS Epoch1417 * @note Insertion of each UTC leap second is usually decided about six months in advance by the1420 * @note If the caller is passing an invalid position sample reference or a null pointer into this1423 //--------------------------------------------------------------------------------------------------1432 //--------------------------------------------------------------------------------------------------1444 //--------------------------------------------------------------------------------------------------1457 //--------------------------------------------------------------------------------------------------1470 //--------------------------------------------------------------------------------------------------1482 //--------------------------------------------------------------------------------------------------1499 //--------------------------------------------------------------------------------------------------1512 //--------------------------------------------------------------------------------------------------1514 * Get the position sample's direction. Direction of movement is the direction that the vehicle or1530 //--------------------------------------------------------------------------------------------------1543 //--------------------------------------------------------------------------------------------------1562 //--------------------------------------------------------------------------------------------------1602 //--------------------------------------------------------------------------------------------------1607 //--------------------------------------------------------------------------------------------------1615 //--------------------------------------------------------------------------------------------------1627 //--------------------------------------------------------------------------------------------------1640 //--------------------------------------------------------------------------------------------------1657 //--------------------------------------------------------------------------------------------------1670 //--------------------------------------------------------------------------------------------------1686 //--------------------------------------------------------------------------------------------------1697 //--------------------------------------------------------------------------------------------------1709 * @note For a 2D position fix, the altitude with respect to the WGS-84 ellipsoid will be indicated1715 //--------------------------------------------------------------------------------------------------1725 //--------------------------------------------------------------------------------------------------1741 //--------------------------------------------------------------------------------------------------1750 //--------------------------------------------------------------------------------------------------1760 //--------------------------------------------------------------------------------------------------1766 //--------------------------------------------------------------------------------------------------1773 //--------------------------------------------------------------------------------------------------1780 //--------------------------------------------------------------------------------------------------1793 //--------------------------------------------------------------------------------------------------1800 //--------------------------------------------------------------------------------------------------1808 //--------------------------------------------------------------------------------------------------1815 //--------------------------------------------------------------------------------------------------1833 //--------------------------------------------------------------------------------------------------1840 //--------------------------------------------------------------------------------------------------1856 //--------------------------------------------------------------------------------------------------1868 //--------------------------------------------------------------------------------------------------1879 //--------------------------------------------------------------------------------------------------1887 //--------------------------------------------------------------------------------------------------1899 * @warning This function may be subject to limitations depending on the platform. Please refer to1908 //--------------------------------------------------------------------------------------------------1915 //--------------------------------------------------------------------------------------------------1929 //--------------------------------------------------------------------------------------------------1936 //--------------------------------------------------------------------------------------------------1941 //--------------------------------------------------------------------------------------------------1947 //--------------------------------------------------------------------------------------------------1960 //--------------------------------------------------------------------------------------------------1967 //--------------------------------------------------------------------------------------------------1979 //--------------------------------------------------------------------------------------------------Definition: le_gnss_interface.h:640le_result_t le_gnss_GetDirection(le_gnss_SampleRef_t positionSampleRef, uint32_t *directionPtr, uint32_t *directionAccuracyPtr)le_result_t le_gnss_GetAltitude(le_gnss_SampleRef_t positionSampleRef, int32_t *altitudePtr, int32_t *vAccuracyPtr)le_gnss_SbasConstellationCategory_t le_gnss_GetSbasConstellationCategory(uint16_t satId)le_result_t le_gnss_InjectSuplCertificate(uint8_t suplCertificateId, uint16_t suplCertificateLen, const char *LE_NONNULL suplCertificate)le_result_t le_gnss_GetSatellitesInfo(le_gnss_SampleRef_t positionSampleRef, uint16_t *satIdPtr, size_t *satIdSizePtr, le_gnss_Constellation_t *satConstPtr, size_t *satConstSizePtr, bool *satUsedPtr, size_t *satUsedSizePtr, uint8_t *satSnrPtr, size_t *satSnrSizePtr, uint16_t *satAzimPtr, size_t *satAzimSizePtr, uint8_t *satElevPtr, size_t *satElevSizePtr)Definition: le_gnss_interface.h:677le_result_t le_gnss_GetExtendedEphemerisValidity(uint64_t *startTimePtr, uint64_t *stopTimePtr)GNGSA type enabled: GNSS DOP and active satellites.Definition: le_gnss_interface.h:795le_result_t le_gnss_Start(void)le_gnss_PositionHandlerRef_t le_gnss_AddPositionHandler(le_gnss_PositionHandlerFunc_t handlerPtr, void *contextPtr)Russian satellite navigation system.Definition: le_gnss_interface.h:760le_result_t le_gnss_GetEpochTime(le_gnss_SampleRef_t positionSampleRef, uint64_t *millisecondsPtr)le_result_t le_gnss_ForceFactoryRestart(void)le_result_t le_gnss_LoadExtendedEphemerisFile(int fd)PSTIS type enabled: GPS session start indication.Definition: le_gnss_interface.h:801le_result_t le_gnss_GetAcquisitionRate(uint32_t *ratePtr)void le_gnss_DisconnectService(void)Definition: le_gnss_interface.h:649Definition: le_gnss_interface.h:668PTYPE type enabled: Proprietary Type mask.Definition: le_gnss_interface.h:803Definition: le_gnss_interface.h:680Chinese satellite navigation system.Definition: le_gnss_interface.h:762le_result_t le_gnss_ForceColdRestart(void)GAGSA type enabled: Galileo DOP and active satellites.Definition: le_gnss_interface.h:797Estimated (i.e. forward predicted) position fix.Definition: le_gnss_interface.h:627le_result_t le_gnss_ForceWarmRestart(void)le_result_t le_gnss_InjectUtcTime(uint64_t timeUtc, uint32_t timeUnc)GPGSV type enabled: GPS satellites in view.Definition: le_gnss_interface.h:790Definition: le_gnss_interface.h:674le_result_t le_gnss_SetConstellationArea(le_gnss_Constellation_t satConstellation, le_gnss_ConstellationArea_t constellationArea)le_result_t le_gnss_GetTtff(uint32_t *ttffPtr)le_result_t le_gnss_GetConstellation(le_gnss_ConstellationBitMask_t *constellationMaskPtr)void le_gnss_RemovePositionHandler(le_gnss_PositionHandlerRef_t handlerRef)le_result_t le_gnss_SetSuplServerUrl(const char *LE_NONNULL suplServerUrl)le_result_t le_gnss_EnableExtendedEphemerisFile(void)le_result_t le_gnss_GetAltitudeOnWgs84(le_gnss_SampleRef_t positionSampleRef, int32_t *altitudeOnWgs84Ptr)le_result_t le_gnss_GetTime(le_gnss_SampleRef_t positionSampleRef, uint16_t *hoursPtr, uint16_t *minutesPtr, uint16_t *secondsPtr, uint16_t *millisecondsPtr)le_result_t le_gnss_GetSuplAssistedMode(le_gnss_AssistedMode_t *assistedModePtr)le_result_t le_gnss_GetLocation(le_gnss_SampleRef_t positionSampleRef, int32_t *latitudePtr, int32_t *longitudePtr, int32_t *hAccuracyPtr)le_result_t le_gnss_DisableExtendedEphemerisFile(void)GAVTG type enabled: Galileo vector track and speed over the ground.Definition: le_gnss_interface.h:800le_result_t le_gnss_TryConnectService(void)le_result_t le_gnss_SetAcquisitionRate(uint32_t rate)le_result_t le_gnss_SetMinElevation(uint8_t minElevation)Definition: le_gnss_interface.h:643le_result_t le_gnss_GetDilutionOfPrecision(le_gnss_SampleRef_t positionSampleRef, le_gnss_DopType_t dopType, uint16_t *dopPtr)le_result_t le_gnss_DeleteSuplCertificate(uint8_t suplCertificateId)North American satellite navigation system.Definition: le_gnss_interface.h:758le_result_t le_gnss_GetMagneticDeviation(le_gnss_SampleRef_t positionSampleRef, int32_t *magneticDeviationPtr)Definition: le_gnss_interface.h:683void le_gnss_ReleaseSampleRef(le_gnss_SampleRef_t positionSampleRef)Definition: le_gnss_interface.h:671le_result_t le_gnss_GetNmeaSentences(le_gnss_NmeaBitMask_t *nmeaMaskPtrPtr)DEBUG type enabled: Debug NMEA indication.Definition: le_gnss_interface.h:806GPGLL type enabled: GPS Geographic position, latitude / longitude.Definition: le_gnss_interface.h:805le_result_t le_gnss_GetVerticalSpeed(le_gnss_SampleRef_t positionSampleRef, int32_t *vspeedPtr, int32_t *vspeedAccuracyPtr)le_result_t le_gnss_SetSuplAssistedMode(le_gnss_AssistedMode_t assistedMode)le_result_t le_gnss_GetDate(le_gnss_SampleRef_t positionSampleRef, uint16_t *yearPtr, uint16_t *monthPtr, uint16_t *dayPtr)GPVTG type enabled: GPS vector track and speed over the ground.Definition: le_gnss_interface.h:792void le_gnss_ConnectService(void)GPRMC type enabled: GPS recommended minimum data.Definition: le_gnss_interface.h:791le_result_t le_gnss_GetSatellitesStatus(le_gnss_SampleRef_t positionSampleRef, uint8_t *satsInViewCountPtr, uint8_t *satsTrackingCountPtr, uint8_t *satsUsedCountPtr)PQXFI type enabled: Proprietary Qualcomm eXtended Fix Information.Definition: le_gnss_interface.h:802European Union satellite navigation system.Definition: le_gnss_interface.h:764le_result_t le_gnss_Stop(void)Definition: le_gnss_interface.h:652le_gnss_State_t le_gnss_GetState(void)le_result_t le_gnss_SetNmeaSentences(le_gnss_NmeaBitMask_t nmeaMask)le_result_t le_gnss_GetPositionState(le_gnss_SampleRef_t positionSampleRef, le_gnss_FixState_t *statePtr)le_result_t le_gnss_GetMinElevation(uint8_t *minElevationPtrPtr)le_result_t le_gnss_Disable(void)void le_gnss_SetServerDisconnectHandler(le_gnss_DisconnectHandler_t disconnectHandler, void *contextPtr)Definition: le_gnss_interface.h:646le_result_t le_gnss_GetHorizontalSpeed(le_gnss_SampleRef_t positionSampleRef, uint32_t *hspeedPtr, uint32_t *hspeedAccuracyPtr)void(* le_gnss_PositionHandlerFunc_t)(le_gnss_SampleRef_t positionSampleRef, void *contextPtr)Definition: le_gnss_interface.h:826le_gnss_SampleRef_t le_gnss_GetLastSampleRef(void)le_result_t le_gnss_SetConstellation(le_gnss_ConstellationBitMask_t constellationMask)GNSS constellation field not defined.Definition: le_gnss_interface.h:666le_result_t le_gnss_ForceHotRestart(void)le_result_t le_gnss_Enable(void)void(* le_gnss_DisconnectHandler_t)(void *)Definition: le_gnss_interface.h:415le_result_t le_gnss_GetGpsTime(le_gnss_SampleRef_t positionSampleRef, uint32_t *gpsWeekPtr, uint32_t *gpsTimeOfWeekPtr)GPGSA type enabled: GPS DOP and active satellites.Definition: le_gnss_interface.h:789le_gnss_SbasConstellationCategory_tDefinition: le_gnss_interface.h:638le_result_t le_gnss_GetConstellationArea(le_gnss_Constellation_t satConstellation, le_gnss_ConstellationArea_t *constellationAreaPtr)le_result_t le_gnss_GetGpsLeapSeconds(le_gnss_SampleRef_t positionSampleRef, uint8_t *leapSecondsPtr)GLGSV type enabled: GLONASS satellites in view.Definition: le_gnss_interface.h:793GAGSV type enabled: Galileo satellites in view.Definition: le_gnss_interface.h:798le_result_t le_gnss_GetTimeAccuracy(le_gnss_SampleRef_t positionSampleRef, uint32_t *timeAccuracyPtr)struct le_gnss_PositionHandler * le_gnss_PositionHandlerRef_tDefinition: le_gnss_interface.h:816GARMC type enabled: Galileo recommended minimum data.Definition: le_gnss_interface.h:799le_result_t le_gnss_GetDop(le_gnss_SampleRef_t positionSampleRef, uint16_t *hdopPtr, uint16_t *vdopPtr, uint16_t *pdopPtr)