le_gnss_interface.h File Reference

Define the maximal degree for the minimal elevation

Define the maximal bit mask for enabled NMEA sentences

Note

This maximal value should be coherent with le_gnss_NmeaBitMask_t

Satellite Vehicle (SV) ID to PRN offset definitions

Note

SV ID is given both in le_gnss_GetSatellitesInfo() API and NMEA flow. Its corresponding PRN code can be computed adding the following offset according to its constellation.

Maximum SUPL certificate string size. One extra byte is added for the null character.

Maximum SUPL certificate size.

Maximum length of the SUP Server URL string. One extra byte is added for the null character.

Maximum length of the SUP Server URL string.

Define the maximum length of the Satellites Vehicle information list

Type for handler called when a server disconnects.

Handler for position information.

Reference type used by Add/Remove functions for EVENT 'le_gnss_Position'

Reference type for dealing with GNSS position samples.

Assisted-GNSS mode

GNSS constellation type.

GNSS constellation area type

GNSS constellation Bit Mask (8 bits) indicating the GNSS constellation(s) used in solution.

Dilution of precision type

GNSS fix position states.

NMEA sentences Bit Mask indicating the NMEA sentences enabled in the NMEA flow.

Warning

The supported NMEA sentences depend on the platform. Please refer to your platform documentation for further details.

Note

The bit mask values should be coherent with LE_GNSS_NMEA_SENTENCES_MAX

SBAS constellation category

Enumeration for GNSS device state

Add handler function for EVENT 'le_gnss_Position'

This event provides information on position.

• A handler reference, which is only needed for later removal of the handler.

Note

Doesn't return on failure, so there's no need to check the return value for errors.

Parameters

[in]	handlerPtr
[in]	contextPtr

Connect the current client thread to the service providing this API. Block until the service is available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

This function deletes the SUPL certificate.

Returns

• LE_OK on success
• LE_BAD_PARAMETER on invalid parameter
• LE_FAULT on failure
• LE_BUSY service is busy
• LE_TIMEOUT a time-out occurred

Parameters

[in]

suplCertificateId

ID of the SUPL certificate. Certificate ID range is 0 to 9

This function disables the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_DUPLICATE If the GNSS device is already disabled.
• LE_NOT_PERMITTED If the GNSS device is not initialized or started.
• LE_OK The function succeeded.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

This function disables the use of the 'Extended Ephemeris' file into the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_OK The function succeeded.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Disconnect the current client thread from the service providing this API.

Normally, this function doesn't need to be called. After this function is called, there's no longer a connection to the service, and the functions in this API can't be used. For details, see Client-specific Functions.

This function is created automatically.

This function enables the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_DUPLICATE If the GNSS device is already enabled.
• LE_NOT_PERMITTED If the GNSS device is not initialized.
• LE_OK The function succeeded.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

This function enables the use of the 'Extended Ephemeris' file into the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_OK The function succeeded.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

This function performs a "COLD" restart of the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
• LE_OK The function succeeded.

This function performs a "FACTORY" restart of the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
• LE_OK The function succeeded.

This function performs a "HOT" restart of the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
• LE_OK The function succeeded.

This function performs a "WARM" restart of the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
• LE_OK The function succeeded.

This API has a platform dependent feature. Please refer to GNSS WARM restart for further details.

This function gets the GNSS device acquisition rate.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_NOT_PERMITTED If the GNSS device is not in "ready" state.

Parameters

[out]

ratePtr

Acquisition rate in milliseconds.

Get the position sample's altitude.

Returns

• LE_FAULT Function failed to get the altitude. Invalid Position reference provided.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
• LE_OK Function succeeded.

Note

Altitude is in meters, above Mean Sea Level, with 3 decimal places (3047 = 3.047 meters).

For a 2D position fix, the altitude will be indicated as invalid and set to INT32_MAX

If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.

altitudePtr, altitudeAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	altitudePtr	Altitude in meters, above Mean Sea Level [resolution 1e-3].
[out]	vAccuracyPtr	Vertical position's accuracy in meters [resolution 1e-1].

Get the position sample's altitude with respect to the WGS-84 ellipsoid

Returns

• LE_FAULT Function failed to get the altitude.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
• LE_OK Function succeeded.

Note

altitudeOnWgs84 is in meters, with respect to the WGS-84 ellipsoid with 3 decimal places (3047 = 3.047 meters).

For a 2D position fix, the altitude with respect to the WGS-84 ellipsoid will be indicated as invalid and set to INT32_MAX.

If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	altitudeOnWgs84Ptr	Altitude in meters, between WGS-84 earth ellipsoid and mean sea level [resolution 1e-3].

Get the GNSS constellation bit mask

Returns

• LE_OK on success
• LE_FAULT on failure

Parameters

[out]

constellationMaskPtr

GNSS constellation used in solution.

Get the area for the GNSS constellation

Returns

• LE_OK On success
• LE_FAULT On failure
• LE_UNSUPPORTED Request not supported
• LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.

Parameters

[in]	satConstellation	GNSS constellation type.
[out]	constellationAreaPtr	GNSS constellation area.

Get the position sample's date.

Returns

• LE_FAULT Function failed to get the date.
• LE_OUT_OF_RANGE The retrieved date is invalid (all fields are set to 0).
• LE_OK Function succeeded.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	yearPtr	UTC Year A.D. [e.g. 2014].
[out]	monthPtr	UTC Month into the year [range 1...12].
[out]	dayPtr	UTC Days into the month [range 1...31].

Get the DOP parameter (Dilution Of Precision) for the fixed position.

Returns

• LE_FAULT Function failed to find the DOP value.
• LE_OUT_OF_RANGE The retrieved parameter is invalid (set to INT16_MAX).
• LE_OK Function succeeded.

Note

This function replaces the deprecated function le_gnss_GetDop().

The DOP value is given with 3 decimal places like: DOP value 2200 = 2.200

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[in]	dopType	Dilution of Precision type.
[out]	dopPtr	Dilution of Precision corresponding to the dopType

Get the position sample's direction. Direction of movement is the direction that the vehicle or person is actually moving.

Returns

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
• LE_OK Function succeeded.

Note

Direction is given in degrees with 1 decimal place: 1755 = 175,5 degrees. Direction ranges from 0 to 359.9 degrees, where 0 is True North.

directionPtr, directionAccuracyPtr can be set to NULL if not needed.

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	directionPtr	Direction in degrees [resolution 1e-1]. Range: 0 to 359.9, where 0 is True North
[out]	directionAccuracyPtr	Direction's accuracy estimate in degrees [resolution 1e-1].

Get the DOP parameters (Dilution Of Precision) for the fixed position.

Returns

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT16_MAX).
• LE_OK Function succeeded.

Note

The DOP values are given with 3 decimal places like: DOP value 2200 = 2.200

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	hdopPtr	Horizontal Dilution of Precision [resolution 1e-3].
[out]	vdopPtr	Vertical Dilution of Precision [resolution 1e-3].
[out]	pdopPtr	Position Dilution of Precision [resolution 1e-3].

Get the position sample's epoch time.

Returns

• LE_FAULT Function failed to acquire the epoch time.
• LE_OK Function succeeded.
• LE_OUT_OF_RANGE The retrieved time is invalid (all fields are set to 0).

Note

The epoch time is the number of seconds elapsed since January 1, 1970 (midnight UTC/GMT), not counting leaps seconds.

If the caller is passing an invalid position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	millisecondsPtr	Milliseconds since Jan. 1, 1970.

This function must be called to get the validity of the last injected Extended Ephemeris.

Returns

• LE_FAULT The function failed to get the validity
• LE_OK The function succeeded.

Parameters

[out]	startTimePtr	Start time in seconds (since Jan. 1, 1970)
[out]	stopTimePtr	Stop time in seconds (since Jan. 1, 1970)

Get the position sample's UTC leap seconds in advance

Returns

• LE_FAULT Function failed to get the leap seconds.
• LE_OUT_OF_RANGE The retrieved time accuracy is invalid (set to UINT8_MAX).
• LE_OK Function succeeded.

Note

The leap seconds in advance is the accumulated time in seconds since the start of GPS Epoch time (Jan 6, 1980). This value has to be added to the UTC time (since Jan. 1, 1970)

Insertion of each UTC leap second is usually decided about six months in advance by the International Earth Rotation and Reference Systems Service (IERS).

If the caller is passing an invalid position sample reference or a null pointer into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	leapSecondsPtr	UTC leap seconds in advance in seconds

Get the position sample's GPS time.

Returns

• LE_FAULT Function failed to get the time.
• LE_OUT_OF_RANGE The retrieved time is invalid (all fields are set to 0).
• LE_OK Function succeeded.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	gpsWeekPtr	GPS week number from midnight, Jan. 6, 1980.
[out]	gpsTimeOfWeekPtr	Amount of time in milliseconds into the GPS week.

Get the position sample's horizontal speed.

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to UINT32_MAX).
• LE_OK Function succeeded.

Note

hSpeedPtr, hSpeedAccuracyPtr can be set to NULL if not needed.

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	hspeedPtr	Horizontal speed in meters/second [resolution 1e-2].
[out]	hspeedAccuracyPtr	Horizontal speed's accuracy estimate in meters/second [resolution 1e-1].

This function gets the last updated position sample object reference.

Returns

A reference to last Position's sample.

Note

On failure, the process exits, so you don't have to worry about checking the returned reference for validity.

Get the location's data (Latitude, Longitude, Horizontal accuracy).

Returns

• LE_FAULT Function failed to get the location's data
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
• LE_OK Function succeeded.

Note

latitudePtr, longitudePtr, hAccuracyPtr, altitudePtr, vAccuracyPtr can be set to NULL if not needed.

The latitude and longitude values are based on the WGS84 standard coordinate system.

The latitude and longitude values are given in degrees with 6 decimal places like: Latitude +48858300 = 48.858300 degrees North Longitude +2294400 = 2.294400 degrees East (The latitude and longitude values are given in degrees, minutes, seconds in NMEA frame)

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	latitudePtr	WGS84 Latitude in degrees, positive North [resolution 1e-6].
[out]	longitudePtr	WGS84 Longitude in degrees, positive East [resolution 1e-6].
[out]	hAccuracyPtr	Horizontal position's accuracy in meters [resolution 1e-2].

Get the position sample's magnetic deviation. It is the difference between the bearing to true north and the bearing shown on a magnetic compass. The deviation is positive when the magnetic north is east of true north.

Returns

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).
• LE_OK Function succeeded.

Note

magneticDeviation is in degrees, with 1 decimal places (47 = 4.7 degree).

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	magneticDeviationPtr	MagneticDeviation in degrees [resolution 1e-1].

This function gets the GNSS minimum elevation.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_UNSUPPORTED request not supported

Note

If the caller is passing an null pointer to this function, it is a fatal error and the function will not return.

Parameters

[out]

minElevationPtrPtr

Minimum elevation in degrees [range 0..90].

This function gets the bit mask for the enabled NMEA sentences.

Returns

• LE_OK Success
• LE_FAULT Failure
• LE_BUSY Service is busy
• LE_TIMEOUT Timeout occurred
• LE_NOT_PERMITTED GNSS device is not in "ready" state

Note

If the caller is passing an null pointer to this function, it is a fatal error and the function will not return.

Parameters

[out]

nmeaMaskPtrPtr

Bit mask for enabled NMEA sentences.

This function gets the position sample's fix state

• LE_OK on success
• LE_FAULT on failure

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	statePtr	Position fix state.

Get the Satellites Vehicle information.

Returns

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid.
• LE_OK Function succeeded.

Note

satId[] can be set to 0 if that information list index is not configured, so all satellite parameters (satConst[], satSnr[],satAzim[], satElev[]) are fixed to 0.

For LE_OUT_OF_RANGE returned code, invalid value depends on field type: UINT16_MAX for satId, LE_GNSS_SV_CONSTELLATION_UNDEFINED for satConst, false for satUsed, UINT8_MAX for satSnr, UINT16_MAX for satAzim, UINT8_MAX for satElev.

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	satIdPtr	Satellites in View ID number, referring to NMEA standard.
[in,out]	satIdSizePtr
[out]	satConstPtr	GNSS constellation type.
[in,out]	satConstSizePtr
[out]	satUsedPtr	TRUE if satellite in View Used for Navigation.
[in,out]	satUsedSizePtr
[out]	satSnrPtr	Satellites in View Signal To Noise Ratio [dBHz].
[in,out]	satSnrSizePtr
[out]	satAzimPtr	Satellites in View Azimuth [degrees]. Range: 0 to 360 If Azimuth angle is currently unknown, the value is set to UINT16_MAX.
[in,out]	satAzimSizePtr
[out]	satElevPtr	Satellites in View Elevation [degrees]. Range: 0 to 90 If Elevation angle is currently unknown, the value is set to UINT8_MAX.
[in,out]	satElevSizePtr

Get the Satellites Vehicle status.

Returns

• LE_FAULT Function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is invalid.
• LE_OK Function succeeded.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	satsInViewCountPtr	Number of satellites expected to be in view.
[out]	satsTrackingCountPtr	Number of satellites in view, when tracking.
[out]	satsUsedCountPtr	Number of satellites in view used for Navigation.

Get the SBAS constellation category

Parameters

[in]

satId

Satellites in View ID number, referring to NMEA standard.

This function returns the status of the GNSS device.

This function gets the SUPL Assisted-GNSS mode.

Returns

• LE_OK on success
• LE_FAULT on failure

Parameters

[out]

assistedModePtr

Assisted-GNSS mode.

Get the position sample's time.

Returns

• LE_FAULT Function failed to get the time.
• LE_OUT_OF_RANGE The retrieved time is invalid (all fields are set to 0).
• LE_OK Function succeeded.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	hoursPtr	UTC Hours into the day [range 0..23].
[out]	minutesPtr	UTC Minutes into the hour [range 0..59].
[out]	secondsPtr	UTC Seconds into the minute [range 0..59].
[out]	millisecondsPtr	UTC Milliseconds into the second [range 0..999].

Get the position sample's time accurary.

Returns

• LE_FAULT Function failed to get the time.
• LE_OUT_OF_RANGE The retrieved time accuracy is invalid (set to UINT16_MAX).
• LE_OK Function succeeded.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	timeAccuracyPtr	Estimated time accuracy in milliseconds

Get the TTFF in milliseconds

Returns

• LE_BUSY The position is not fixed and TTFF can't be measured.
• LE_NOT_PERMITTED If the GNSS device is not enabled or not started.
• LE_OK Function succeeded.

Parameters

[out]

ttffPtr

TTFF in milliseconds

Get the position sample's vertical speed.

Returns

• LE_FAULT The function failed to find the positionSample.
• LE_OUT_OF_RANGE One of the retrieved parameter is not valid (set to INT32_MAX).
• LE_OK The function succeeded.

Note

vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not needed.

For a 2D position Fix, the vertical speed will be indicated as invalid and set to INT32_MAX.

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	vspeedPtr	Vertical speed in meters/second [resolution 1e-2], positive up.
[out]	vspeedAccuracyPtr	Vertical speed's accuracy estimate in meters/second [resolution 1e-1].

This function injects the SUPL certificate to be used in A-GNSS sessions. Certificates must be encoded in DER. Other certificate encryptions (e.g., PEM, CER and CRT) aren't supported.

Returns

• LE_OK on success
• LE_BAD_PARAMETER on invalid parameter
• LE_FAULT on failure
• LE_BUSY service is busy
• LE_TIMEOUT a time-out occurred

Note

If the SUPL certificate size is bigger than the Maximum SUPL certificate size, it is a fatal error, the function will not return.

Parameters

[in]	suplCertificateId	ID of the SUPL certificate. Certificate ID range is 0 to 9
[in]	suplCertificateLen	SUPL certificate size in Bytes.
[in]	suplCertificate	SUPL certificate contents.

This function must be called to inject the UTC time into the GNSS device.

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed to inject the UTC time.
• LE_TIMEOUT A time-out occurred.

Note

It is mandatory to enable the 'Extended Ephemeris' file injection into the GNSS device with le_gnss_EnableExtendedEphemerisFile() before injecting time with this API.

Parameters

[in]	timeUtc	[IN] UTC time since Jan. 1, 1970 in milliseconds
[in]	timeUnc	[IN] Time uncertainty in milliseconds

This function must be called to load an 'Extended Ephemeris' file into the GNSS device.

Returns

• LE_FAULT The function failed to inject the 'Extended Ephemeris' file.
• LE_TIMEOUT A time-out occurred.
• LE_FORMAT_ERROR 'Extended Ephemeris' file format error.
• LE_OK The function succeeded.

Parameters

[in]

fd

Extended ephemeris file descriptor

This function must be called to release the position sample.

Note

If the caller is passing an invalid Position sample reference into this function, it is a fatal error, the function will not return.

Parameters

[in]

positionSampleRef

Position sample's reference.

Remove handler function for EVENT 'le_gnss_Position'

Parameters

[in]

handlerRef

This function sets the GNSS device acquisition rate.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_UNSUPPORTED request not supported
• LE_TIMEOUT a time-out occurred
• LE_NOT_PERMITTED If the GNSS device is not in "ready" state.
• LE_OUT_OF_RANGE if acquisition rate value is equal to zero

Warning

This function may be subject to limitations depending on the platform. Please refer to the GNSS platform constraints page.

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

rate

Acquisition rate in milliseconds.

Set the GNSS constellation bit mask

Returns

• LE_FAULT The function failed.
• LE_UNSUPPORTED If the request is not supported.
• LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.
• LE_OK The function succeeded.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

constellationMask

GNSS constellation used in solution.

Set the area for the GNSS constellation

Returns

• LE_OK The function succeeded.
• LE_FAULT The function failed.
• LE_UNSUPPORTED If the request is not supported.
• LE_NOT_PERMITTED If the GNSS device is not initialized, disabled or active.
• LE_BAD_PARAMETER Invalid constellation area.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]	satConstellation	GNSS constellation type.
[in]	constellationArea	GNSS constellation area.

This function sets the GNSS minimum elevation.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_OUT_OF_RANGE if the minimum elevation is above range
• LE_UNSUPPORTED request not supported

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

minElevation

Minimum elevation in degrees [range 0..90].

This function sets the enabled NMEA sentences using a bit mask.

Returns

• LE_OK Success
• LE_BAD_PARAMETER Bit mask exceeds the maximal value
• LE_FAULT Failure
• LE_BUSY Service is busy
• LE_TIMEOUT Timeout occurred
• LE_NOT_PERMITTED GNSS device is not in "ready" state

Warning

This function may be subject to limitations depending on the platform. Please refer to the GNSS platform constraints page.

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

nmeaMask

Bit mask for enabled NMEA sentences.

Set handler called when server disconnection is detected.

When a server connection is lost, call this handler then exit with LE_FATAL. If a program wants to continue without exiting, it should call longjmp() from inside the handler.

This function sets the SUPL Assisted-GNSS mode.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_UNSUPPORTED request not supported
• LE_TIMEOUT a time-out occurred

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

assistedMode

Assisted-GNSS mode.

This function sets the SUPL server URL. That server URL is a NULL-terminated string with a maximum string length (including NULL terminator) equal to 256. Optionally the port number is specified after a colon.

Returns

• LE_OK on success
• LE_FAULT on failure
• LE_BUSY service is busy
• LE_TIMEOUT a time-out occurred

Note

If the SUPL server URL size is bigger than the maximum string length (including NULL terminator) size, it is a fatal error, the function will not return.

Warning

The settings are platform dependent. Please refer to Setting configuration section for full details.

Parameters

[in]

suplServerUrl

SUPL server URL.

This function starts the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_DUPLICATE If the GNSS device is already started.
• LE_NOT_PERMITTED If the GNSS device is not initialized or disabled.
• LE_OK The function succeeded.

This function stops the GNSS device.

Returns

• LE_FAULT The function failed.
• LE_DUPLICATE If the GNSS device is already stopped.
• LE_NOT_PERMITTED If the GNSS device is not initialized or disabled.
• LE_OK The function succeeded.

Try to connect the current client thread to the service providing this API. Return with an error if the service is not available.

For each thread that wants to use this API, either ConnectService or TryConnectService must be called before any other functions in this API. Normally, ConnectService is automatically called for the main thread, but not for any other thread. For details, see Client-specific Functions.

This function is created automatically.

Returns

• LE_OK if the client connected successfully to the service.
• LE_UNAVAILABLE if the server is not currently offering the service to which the client is bound.
• LE_NOT_PERMITTED if the client interface is not bound to any service (doesn't have a binding).
• LE_COMM_ERROR if the Service Directory cannot be reached.