nanogps 2.0.0.0
Public function

Functions

void nanogps_cfg_setup (nanogps_cfg_t *cfg)
 Config Object Initialization function.
 
NANOGPS_RETVAL nanogps_init (nanogps_t *ctx, nanogps_cfg_t *cfg)
 Initialization function.
 
void nanogps_module_wakeup (nanogps_t *ctx)
 Wake-up module.
 
void nanogps_set_pwr_pin (nanogps_t *ctx, uint8_t state)
 Set PWR ( powerS ) pin state.
 
void nanogps_set_rst_pin (nanogps_t *ctx, uint8_t state)
 Set RST ( reset ) pin state.
 
uint8_t nanogps_get_wkp_pin (nanogps_t *ctx)
 Get WKP pin state.
 
void nanogps_generic_write (nanogps_t *ctx, char *data_buf, uint16_t len)
 Generic write function.
 
int32_t nanogps_generic_read (nanogps_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
nanogps_error_t nanogps_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function.
 

Detailed Description

Function Documentation

◆ nanogps_cfg_setup()

void nanogps_cfg_setup ( nanogps_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

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

Note
All used pins will be set to unconnected state.

◆ nanogps_generic_parser()

nanogps_error_t nanogps_generic_parser ( char * rsp,
uint8_t command,
uint8_t element,
char * parser_buf )

Generic parser function.

Parameters
nanogpsClick object.
commandNEMA ( GPS/GNSS ) command.
elementElement position in command.
parser_bufParser buffer for data storage.
Returns
error data

◆ nanogps_generic_read()

int32_t nanogps_generic_read ( nanogps_t * ctx,
char * data_buf,
uint16_t max_len )

Generic read function.

Parameters
nanogpsClick object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ nanogps_generic_write()

void nanogps_generic_write ( nanogps_t * ctx,
char * data_buf,
uint16_t len )

Generic write function.

Parameters
nanogpsClick object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ nanogps_get_wkp_pin()

uint8_t nanogps_get_wkp_pin ( nanogps_t * ctx)

Get WKP pin state.

Parameters
nanogpsClick object.
Returns
current pin state.

◆ nanogps_init()

NANOGPS_RETVAL nanogps_init ( nanogps_t * ctx,
nanogps_cfg_t * cfg )

Initialization function.

Parameters
nanogpsClick object.
cfgClick configuration structure.

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

◆ nanogps_module_wakeup()

void nanogps_module_wakeup ( nanogps_t * ctx)

Wake-up module.

Parameters
nanogpsClick object.

◆ nanogps_set_pwr_pin()

void nanogps_set_pwr_pin ( nanogps_t * ctx,
uint8_t state )

Set PWR ( powerS ) pin state.

Parameters
nanogpsClick object.
statePin state ( 1 or 0 ).

◆ nanogps_set_rst_pin()

void nanogps_set_rst_pin ( nanogps_t * ctx,
uint8_t state )

Set RST ( reset ) pin state.

Parameters
nanogpsClick object.
statePin state ( 1 or 0 ).