Public function

Functions
void	nanogps2_cfg_setup (nanogps2_cfg_t *cfg)
	Config Object Initialization function.
NANOGPS2_RETVAL	nanogps2_init (nanogps2_t *ctx, nanogps2_cfg_t *cfg)
	Initialization function.
void	nanogps2_module_wakeup (nanogps2_t *ctx)
	Wake-up module.
void	nanogps2_set_fon_pin_state (nanogps2_t *ctx, uint8_t state)
	Generic function for setting fon pin status.
void	nanogps2_set_cts_pin_state (nanogps2_t *ctx, uint8_t state)
	Generic function for setting cts pin status.
uint8_t	nanogps2_get_wkp_pin (nanogps2_t *ctx)
	Get WKP pin state.
uint8_t	nanogps2_get_rts_pin (nanogps2_t *ctx)
	Get RTS pin state.
void	nanogps2_set_en_pin_state (nanogps2_t *ctx, uint8_t state)
	Generic function for setting en pin status.
void	nanogps2_generic_write (nanogps2_t *ctx, char *data_buf, uint16_t len)
	Generic write function.
int32_t	nanogps2_generic_read (nanogps2_t *ctx, char *data_buf, uint16_t max_len)
	Generic read function.
nanogps2_error_t	nanogps2_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
	Generic parser function.

Detailed Description

Function Documentation

nanogps2_cfg_setup()

void nanogps2_cfg_setup

(

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

nanogps2_generic_parser()

nanogps2_error_t nanogps2_generic_parser	(	char *	rsp,
		uint8_t	command,
		uint8_t	element,
		char *	parser_buf )

Generic parser function.

Parameters

rsp	Response buffer.
command	NEMA ( GPS/GNSS ) command.
element	Element position in command.
parser_buf	Parser buffer for data storage.

Returns

error data

nanogps2_generic_read()

int32_t nanogps2_generic_read	(	nanogps2_t *	ctx,
		char *	data_buf,
		uint16_t	max_len )

Generic read function.

Parameters

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

nanogps2_generic_write()

void nanogps2_generic_write	(	nanogps2_t *	ctx,
		char *	data_buf,
		uint16_t	len )

Generic write function.

Parameters

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

nanogps2_get_rts_pin()

uint8_t nanogps2_get_rts_pin

(

nanogps2_t *

ctx

)

Get RTS pin state.

Parameters

ctx	Click object.

Returns

current pin state.

nanogps2_get_wkp_pin()

uint8_t nanogps2_get_wkp_pin

(

nanogps2_t *

ctx

)

Get WKP pin state.

Parameters

ctx	Click object.

Returns

current pin state.

nanogps2_init()

NANOGPS2_RETVAL nanogps2_init	(	nanogps2_t *	ctx,
		nanogps2_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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

nanogps2_module_wakeup()

void nanogps2_module_wakeup

(

nanogps2_t *

ctx

)

Wake-up module.

Parameters

ctx	Click object.

nanogps2_set_cts_pin_state()

void nanogps2_set_cts_pin_state	(	nanogps2_t *	ctx,
		uint8_t	state )

Generic function for setting cts pin status.

Parameters

ctx	Click object.
state	state of the pin

nanogps2_set_en_pin_state()

void nanogps2_set_en_pin_state	(	nanogps2_t *	ctx,
		uint8_t	state )

Generic function for setting en pin status.

Parameters

ctx	Click object.
state	state of the pin

nanogps2_set_fon_pin_state()

void nanogps2_set_fon_pin_state	(	nanogps2_t *	ctx,
		uint8_t	state )

Generic function for setting fon pin status.

Parameters

ctx	Click object.
state	state of the pin