Public function

Functions
void	gnss3_cfg_setup (gnss3_cfg_t *cfg)
	Config Object Initialization function.
err_t	gnss3_init (gnss3_t *ctx, gnss3_cfg_t *cfg)
	Initialization function.
void	gnss3_module_wakeup (gnss3_t *ctx)
	Wake-up module.
void	gnss3_set_rst_pin (gnss3_t *ctx, uint8_t state)
	Set RST ( reset ) pin state.
uint8_t	gnss3_get_int_pin (gnss3_t *ctx)
	Get PPS pin state.
void	gnss3_generic_write (gnss3_t *ctx, char *data_buf, uint16_t len)
	Generic write function.
int32_t	gnss3_generic_read (gnss3_t *ctx, char *data_buf, uint16_t max_len)
	Generic read function.
err_t	gnss3_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
	GNSS 3 parse GNGGA function.

Detailed Description

Function Documentation

gnss3_cfg_setup()

void gnss3_cfg_setup

(

gnss3_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description This function initializes click configuration structure to init state.

Note

All used pins will be set to unconnected state.

gnss3_generic_read()

int32_t gnss3_generic_read	(	gnss3_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

Generic read function.

Parameters

gnss3	Click object.
data_buf	Data buffer for read data.
max_len	The maximum length of data that can be read.

Returns

Number of reads data.

gnss3_generic_write()

void gnss3_generic_write	(	gnss3_t *	ctx,
		char *	data_buf,
		uint16_t	len )

Generic write function.

Parameters

gnss3	Click object.
data_buf	Data buffer for sends.
len	Number of bytes for sends.

gnss3_get_int_pin()

uint8_t gnss3_get_int_pin

(

gnss3_t *

ctx

)

Get PPS pin state.

Parameters

gnss3

Click object.

Returns

current pin state.

gnss3_init()

err_t gnss3_init	(	gnss3_t *	ctx,
		gnss3_cfg_t *	cfg )

Initialization function.

Parameters

gnss3	Click object.
cfg	Click configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.

gnss3_module_wakeup()

void gnss3_module_wakeup

(

gnss3_t *

ctx

)

Wake-up module.

Parameters

gnss3

Click object.

gnss3_parse_gngga()

err_t gnss3_parse_gngga	(	char *	rsp_buf,
		uint8_t	gngga_element,
		char *	element_data )

GNSS 3 parse GNGGA function.

This function parses the GNGGA data from the read response buffer.

Parameters

[in]	rsp_buf	: Response buffer.
[in]	gngga_element	: GNGGA element position [1-14].
[out]	element_data	: Element data parsed.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

gnss3_set_rst_pin()

void gnss3_set_rst_pin	(	gnss3_t *	ctx,
		uint8_t	state )

Set RST ( reset ) pin state.

Parameters

gnss3	Click object.
state	Pin state ( 1 or 0 ).