Public function

Functions
void	gps4_cfg_setup (gps4_cfg_t *cfg)
	Config Object Initialization function.
GPS4_RETVAL	gps4_init (gps4_t *ctx, gps4_cfg_t *cfg)
	Initialization function.
void	gps4_module_wakeup (gps4_t *ctx)
	Wake-up module.
void	gps4_module_reset (gps4_t *ctx)
	Reset module.
void	gps4_set_wkp_pin (gps4_t *ctx, uint8_t state)
	Set WKP ( wake-up ) pin state.
void	gps4_set_rst_pin (gps4_t *ctx, uint8_t state)
	Set RST ( reset ) pin state.
uint8_t	gps4_get_pps_pin (gps4_t *ctx)
	Get PPS pin state.
void	gps4_generic_write (gps4_t *ctx, char *data_buf, uint16_t len)
	Generic write function.
int32_t	gps4_generic_read (gps4_t *ctx, char *data_buf, uint16_t max_len)
	Generic read function.
gps4_error_t	gps4_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
	Generic parser function.

Detailed Description

Function Documentation

gps4_cfg_setup()

void gps4_cfg_setup

(

gps4_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.

gps4_generic_parser()

gps4_error_t gps4_generic_parser	(	char *	rsp,
		uint8_t	command,
		uint8_t	element,
		char *	parser_buf )

Generic parser function.

Parameters

gps4	Click object.
command	NEMA ( GPS/GNSS ) command.
element	Element position in command.
parser_buf	Parser buffer for data storage.

Returns

error data

gps4_generic_read()

int32_t gps4_generic_read	(	gps4_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

Generic read function.

Parameters

gps4	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.

gps4_generic_write()

void gps4_generic_write	(	gps4_t *	ctx,
		char *	data_buf,
		uint16_t	len )

Generic write function.

Parameters

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

gps4_get_pps_pin()

uint8_t gps4_get_pps_pin

(

gps4_t *

ctx

)

Get PPS pin state.

Parameters

gps4	Click object.

Returns

current pin state.

gps4_init()

GPS4_RETVAL gps4_init	(	gps4_t *	ctx,
		gps4_cfg_t *	cfg )

Initialization function.

Parameters

gps4	Click object.
cfg	Click configuration structure.

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

gps4_module_reset()

void gps4_module_reset

(

gps4_t *

ctx

)

Reset module.

Parameters

gps4	Click object.

gps4_module_wakeup()

void gps4_module_wakeup

(

gps4_t *

ctx

)

Wake-up module.

Parameters

gps4	Click object.

gps4_set_rst_pin()

void gps4_set_rst_pin	(	gps4_t *	ctx,
		uint8_t	state )

Set RST ( reset ) pin state.

Parameters

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

gps4_set_wkp_pin()

void gps4_set_wkp_pin	(	gps4_t *	ctx,
		uint8_t	state )

Set WKP ( wake-up ) pin state.

Parameters

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