#include "legato.h"

Typedefs
typedef struct le_pos_Sample *	le_pos_SampleRef_t

typedef struct le_pos_MovementHandler *	le_pos_MovementHandlerRef_t

typedef void(*	le_pos_MovementHandlerFunc_t )(le_pos_SampleRef_t positionSampleRef, void *contextPtr)

Functions
void	le_pos_StartClient (const char *serviceInstanceName)

void	le_pos_StopClient (void)

le_pos_MovementHandlerRef_t	le_pos_AddMovementHandler (uint32_t horizontalMagnitude, uint32_t verticalMagnitude, le_pos_MovementHandlerFunc_t handlerPtr, void *contextPtr)

void	le_pos_RemoveMovementHandler (le_pos_MovementHandlerRef_t addHandlerRef)

le_result_t	le_pos_Get2DLocation (int32_t latitudePtr, int32_t longitudePtr, int32_t *hAccuracyPtr)

le_result_t	le_pos_Get3DLocation (int32_t latitudePtr, int32_t longitudePtr, int32_t hAccuracyPtr, int32_t altitudePtr, int32_t *vAccuracyPtr)

le_result_t	le_pos_GetMotion (uint32_t hSpeedPtrPtr, int32_t hSpeedAccuracyPtrPtr, int32_t vSpeedPtrPtr, int32_t vSpeedAccuracyPtrPtr)

le_result_t	le_pos_GetHeading (int32_t headingPtr, int32_t headingAccuracyPtr)

le_result_t	le_pos_GetDirection (int32_t directionPtr, int32_t directionAccuracyPtr)

le_result_t	le_pos_sample_Get2DLocation (le_pos_SampleRef_t positionSampleRef, int32_t latitudePtr, int32_t longitudePtr, int32_t *horizontalAccuracyPtr)

le_result_t	le_pos_sample_GetAltitude (le_pos_SampleRef_t positionSampleRef, int32_t altitudePtr, int32_t altitudeAccuracyPtr)

le_result_t	le_pos_sample_GetHorizontalSpeed (le_pos_SampleRef_t positionSampleRef, uint32_t hspeedPtr, int32_t hspeedAccuracyPtr)

le_result_t	le_pos_sample_GetVerticalSpeed (le_pos_SampleRef_t positionSampleRef, int32_t vspeedPtr, int32_t vspeedAccuracyPtr)

le_result_t	le_pos_sample_GetHeading (le_pos_SampleRef_t positionSampleRef, int32_t headingPtr, int32_t headingAccuracyPtr)

le_result_t	le_pos_sample_GetDirection (le_pos_SampleRef_t positionSampleRef, int32_t directionPtr, int32_t directionAccuracyPtr)

void	le_pos_sample_Release (le_pos_SampleRef_t positionSampleRef)

le_result_t	le_pos_LoadXtra (const char *xtraFilePathPtr)

le_result_t	le_pos_GetXtraValidity (le_clk_Time_t startTimePtrPtr, le_clk_Time_t stopTimePtrPtr)

Detailed Description

Legato Positioning Service include file.

Copyright (C) Sierra Wireless, Inc. 2014. Use of this work is subject to license.

Typedef Documentation

typedef void(* le_pos_MovementHandlerFunc_t)(le_pos_SampleRef_t positionSampleRef, void *contextPtr)

Handler for Movement changes.

Parameters

positionSampleRef	Position's sample reference
contextPtr

typedef struct le_pos_MovementHandler* le_pos_MovementHandlerRef_t

Reference type for le_pos_MovementHandler handler ADD/REMOVE functions

typedef struct le_pos_Sample* le_pos_SampleRef_t

Reference type for dealing with Position samples.

Function Documentation

le_pos_MovementHandlerRef_t le_pos_AddMovementHandler	(	uint32_t	horizontalMagnitude,
		uint32_t	verticalMagnitude,
		le_pos_MovementHandlerFunc_t	handlerPtr,
		void *	contextPtr
	)

le_pos_MovementHandler handler ADD function

Parameters

[in]	horizontalMagnitude	Horizontal magnitude in metres. 0 means that I don't care about changes in the latitude and longitude.
[in]	verticalMagnitude	Vertical magnitude in metres. 0 means that I don't care about changes in the altitude.
[in]	handlerPtr
[in]	contextPtr

le_result_t le_pos_Get2DLocation	(	int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	hAccuracyPtr
	)

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

Returns: LE_FAULT Function failed to get the 2D 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 can be set to NULL if not needed.

Parameters

[out]	latitudePtr	Latitude in degrees, positive North.
[out]	longitudePtr	Longitude in degrees, positive East.
[out]	hAccuracyPtr	Horizontal position's accuracy in metres.

le_result_t le_pos_Get3DLocation	(	int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	hAccuracyPtr,
		int32_t *	altitudePtr,
		int32_t *	vAccuracyPtr
	)

Get the 3D location's data (Latitude, Longitude, Altitude, Horizontal accuracy, Vertical accuracy).

Returns: LE_FAULT Function failed to get the 3D 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.

Parameters

[out]	latitudePtr	Latitude in degrees, positive North.
[out]	longitudePtr	Longitude in degrees, positive East.
[out]	hAccuracyPtr	Horizontal position's accuracy in metres.
[out]	altitudePtr	Altitude in metres, above Mean Sea Level.
[out]	vAccuracyPtr	Vertical position's accuracy in metres.

le_result_t le_pos_GetDirection	(	int32_t *	directionPtr,
		int32_t *	directionAccuracyPtr
	)

Get the direction indication. Direction of movement is the direction that the vehicle/person is actually moving.

Returns: LE_FAULT Function failed to get the direction indication.; LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).; LE_OK Function succeeded.

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

Parameters

[out]	directionPtr	Direction indication in degrees (where 0 is True North).
[out]	directionAccuracyPtr	Direction's accuracy in degrees.

le_result_t le_pos_GetHeading	(	int32_t *	headingPtr,
		int32_t *	headingAccuracyPtr
	)

Get the heading indication.

Returns: LE_FAULT Function failed to get the heading indication.; LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX).; LE_OK Function succeeded.

Note: headingPtr, headingAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	headingPtr	Heading in degrees (where 0 is True North).
[out]	headingAccuracyPtr	Heading's accuracy in degrees.

le_result_t le_pos_GetMotion	(	uint32_t *	hSpeedPtrPtr,
		int32_t *	hSpeedAccuracyPtrPtr,
		int32_t *	vSpeedPtrPtr,
		int32_t *	vSpeedAccuracyPtrPtr
	)

Get the motion's data (Horizontal Speed, Horizontal Speed's accuracy, Vertical Speed, Vertical Speed's accuracy).

Returns: LE_FAULT Function failed to get the motion's data.; LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX, UINT32_MAX).; LE_OK Function succeeded.

Note: hSpeedPtr, hSpeedAccuracyPtr, vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[out]	hSpeedPtrPtr	Horizontal Speed in m/sec.
[out]	hSpeedAccuracyPtrPtr	Horizontal Speed's accuracy in m/sec.
[out]	vSpeedPtrPtr	Vertical Speed in m/sec, positive up.
[out]	vSpeedAccuracyPtrPtr	Vertical Speed's accuracy in m/sec.

le_result_t le_pos_GetXtraValidity	(	le_clk_Time_t *	startTimePtrPtr,
		le_clk_Time_t *	stopTimePtrPtr
	)

This function must be called to get the validity of the last xtra.bin injected

Returns: LE_FAULT The function failed to get the validity; LE_OK The function succeeded.

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

Parameters

[out]	startTimePtrPtr	Start time
[out]	stopTimePtrPtr	Stop time

le_result_t le_pos_LoadXtra ( const char * xtraFilePathPtr )

This function must be called to load xtra.bin file into the gnss.

Returns: LE_FAULT The function failed to inject the xtra.bin file; LE_OK The function succeeded.

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

Parameters

[in] xtraFilePathPtr xtra.bin file path

void le_pos_RemoveMovementHandler ( le_pos_MovementHandlerRef_t addHandlerRef )

le_pos_MovementHandler handler REMOVE function

Parameters

[in] addHandlerRef

le_result_t le_pos_sample_Get2DLocation	(	le_pos_SampleRef_t	positionSampleRef,
		int32_t *	latitudePtr,
		int32_t *	longitudePtr,
		int32_t *	horizontalAccuracyPtr
	)

Get the position sample's 2D location (latitude, longitude, horizontal accuracy).

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: If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.; latitudePtr, longitudePtr, horizontalAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	latitudePtr	Latitude in degrees.
[out]	longitudePtr	Longitude in degrees.
[out]	horizontalAccuracyPtr	Horizontal's accuracy estimate in metres.

le_result_t le_pos_sample_GetAltitude	(	le_pos_SampleRef_t	positionSampleRef,
		int32_t *	altitudePtr,
		int32_t *	altitudeAccuracyPtr
	)

Get the position sample's altitude.

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: 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 metres.
[out]	altitudeAccuracyPtr	Altitude's accuracy estimate in metres.

le_result_t le_pos_sample_GetDirection	(	le_pos_SampleRef_t	positionSampleRef,
		int32_t *	directionPtr,
		int32_t *	directionAccuracyPtr
	)

Get the position sample's direction. Direction of movement is the direction that the vehicle/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 INT32_MAX).; LE_OK Function succeeded.

Note: If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.; directionPtr, directionAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	directionPtr	Direction in degrees (where 0 is True North).
[out]	directionAccuracyPtr	Direction's accuracy estimate in degrees.

le_result_t le_pos_sample_GetHeading	(	le_pos_SampleRef_t	positionSampleRef,
		int32_t *	headingPtr,
		int32_t *	headingAccuracyPtr
	)

Get the position sample's heading. Heading is the direction that the vehicle/person is facing.

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 TFunction succeeded.

Note: If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.; headingPtr, headingAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	headingPtr	Heading in degrees (where 0 is True North).
[out]	headingAccuracyPtr	Heading's accuracy estimate in degrees.

le_result_t le_pos_sample_GetHorizontalSpeed	(	le_pos_SampleRef_t	positionSampleRef,
		uint32_t *	hspeedPtr,
		int32_t *	hspeedAccuracyPtr
	)

Get the position sample's horizontal speed.

Returns: LE_FAULT Function failed to find the positionSample.; LE_OUT_OF_RANGE One of the retrieved parameter is invalid (set to INT32_MAX, UINT32_MAX).; LE_OK Function succeeded.

Note: If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.; hSpeedPtr, hSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	hspeedPtr	Horizontal speed.
[out]	hspeedAccuracyPtr	Horizontal speed's accuracy estimate.

le_result_t le_pos_sample_GetVerticalSpeed	(	le_pos_SampleRef_t	positionSampleRef,
		int32_t *	vspeedPtr,
		int32_t *	vspeedAccuracyPtr
	)

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: If the caller is passing an invalid Position reference into this function, it is a fatal error, the function will not return.; vSpeedPtr, vSpeedAccuracyPtr can be set to NULL if not needed.

Parameters

[in]	positionSampleRef	Position sample's reference.
[out]	vspeedPtr	Vertical speed.
[out]	vspeedAccuracyPtr	Vertical speed's accuracy estimate.

void le_pos_sample_Release ( le_pos_SampleRef_t positionSampleRef )

Release the position sample.

Note: 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.

void le_pos_StartClient ( const char * serviceInstanceName )

Start the service for the client main thread

Parameters

[in] serviceInstanceName

void le_pos_StopClient ( void )

Stop the service for the current client thread

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation