gnss4 2.0.0.0
Public function

Functions

void gnss4_cfg_setup (gnss4_cfg_t *cfg)
 Config Object Initialization function.
 
GNSS4_RETVAL gnss4_init (gnss4_t *ctx, gnss4_cfg_t *cfg)
 Initialization function.
 
void gnss4_module_wakeup (gnss4_t *ctx)
 Wake-up module.
 
void gnss4_set_rst_pin (gnss4_t *ctx, uint8_t state)
 Set RST ( reset ) pin state.
 
void gnss4_generic_write (gnss4_t *ctx, char *data_buf, uint16_t len)
 Generic write function.
 
int32_t gnss4_generic_read (gnss4_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
gnss4_error_t gnss4_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function.
 

Detailed Description

Function Documentation

◆ gnss4_cfg_setup()

void gnss4_cfg_setup ( gnss4_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.

◆ gnss4_generic_parser()

gnss4_error_t gnss4_generic_parser ( char * rsp,
uint8_t command,
uint8_t element,
char * parser_buf )

Generic parser function.

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

◆ gnss4_generic_read()

int32_t gnss4_generic_read ( gnss4_t * ctx,
char * data_buf,
uint16_t max_len )

Generic read function.

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

◆ gnss4_generic_write()

void gnss4_generic_write ( gnss4_t * ctx,
char * data_buf,
uint16_t len )

Generic write function.

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

◆ gnss4_init()

GNSS4_RETVAL gnss4_init ( gnss4_t * ctx,
gnss4_cfg_t * cfg )

Initialization function.

Parameters
gnss4Click object.
cfgClick configuration structure.

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

◆ gnss4_module_wakeup()

void gnss4_module_wakeup ( gnss4_t * ctx)

Wake-up module.

Parameters
gnss4Click object.

◆ gnss4_set_rst_pin()

void gnss4_set_rst_pin ( gnss4_t * ctx,
uint8_t state )

Set RST ( reset ) pin state.

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