pa_gnss.h File Reference

#include "legato.h"

Go to the source code of this file.

Data Structures
struct	pa_Gnss_Time_t
struct	pa_Gnss_Date_t
struct	pa_Gnss_Position_t

Typedefs
typedef pa_Gnss_Position_t *	pa_Gnss_Position_Ref_t
typedef void(*	pa_gnss_PositionDataHandlerFunc_t )(pa_Gnss_Position_Ref_t position)

Functions
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)
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)

Detailed Description

Legato Platform Adapter Global Navigation Satellite System API include file.

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

Typedef Documentation

typedef pa_Gnss_Position_t* pa_Gnss_Position_Ref_t

Reference to a position structure.

typedef void(* pa_gnss_PositionDataHandlerFunc_t)(pa_Gnss_Position_Ref_t position)

Prototype for handler functions used to get GNSS position data.

Parameters

position

The new position.

Function Documentation

le_event_HandlerRef_t pa_gnss_AddPositionDataHandler

(

pa_gnss_PositionDataHandlerFunc_t

handler

)

This function must be called to register an handler for GNSS position data notifications.

Returns

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]

handler

The handler function.

le_result_t pa_gnss_DisableXtraSession

(

void

)

This function must be called to disable Xtra session.

Returns

LE_FAULT The function failed to disable.

LE_OK The function succeeded.

le_result_t pa_gnss_EnableXtraSession

(

void

)

This function must be called to enable Xtra session.

Returns

LE_FAULT The function failed to enable.

LE_OK The function succeeded.

le_result_t pa_gnss_GetLastPositionData

(

pa_Gnss_Position_Ref_t

positionRef

)

This function must be called to get the location's data.

Returns

LE_NOT_POSSIBLE The function cannot get internal position information

LE_OK The function succeeded.

Note

If the caller is passing a bad pointer into this function, it is a fatal error, the function will not return.

Parameters

[out]

positionRef

Reference to a position struct

le_result_t pa_gnss_GetXtraSessionStatus

(

bool *

enablePtr

)

This function must be called to get the status of Xtra session

Returns

LE_FAULT The function failed to get the status

LE_OK The function succeeded.

Parameters

[out]

enablePtr

enable/disable

le_result_t pa_gnss_GetXtraValidityTimes	(	le_clk_Time_t *	startTimePtr,
		le_clk_Time_t *	stopTimePtr
	)

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.

Parameters

[out]	startTimePtr	Start time
[out]	stopTimePtr	Stop time

le_result_t pa_gnss_Init

(

void

)

This function must be called to initialize the PA GNSS Module.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_gnss_LoadXtra

(

const char *

xtraFilePathPtr

)

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

Returns

LE_FAULT The function failed to load the xtra.bin file

LE_NOT_FOUND The file path does not exist

LE_OK The function succeeded.

Parameters

[in]

xtraFilePathPtr

xtra.bin file path

le_result_t pa_gnss_Release

(

void

)

This function must be called to release the PA GNSS Module.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

void pa_gnss_RemovePositionDataHandler

(

le_event_HandlerRef_t

handlerRef

)

This function must be called to remove a handler for GNSS position data notifications.

Note

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

Parameters

[in]

handlerRef

The handler reference.

le_result_t pa_gnss_SetAcquisitionRate

(

uint32_t

rate

)

This function must be called to set the rate of GNSS fix reception

Returns

LE_NOT_POSSIBLE The function failed.

LE_TIMEOUT No response was received.

LE_OK The function succeeded.

Parameters

[in]

rate

rate in seconds

le_result_t pa_gnss_Start

(

void

)

This function must be called to start the GNSS acquisition.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.

le_result_t pa_gnss_Stop

(

void

)

This function must be called to stop the GNSS acquisition.

Returns

LE_FAULT The function failed.

LE_OK The function succeed.