gps3  2.0.0.0
Functions
Public function

Functions

void gps3_cfg_setup (gps3_cfg_t *cfg)
 Config Object Initialization function. More...
 
GPS3_RETVAL gps3_init (gps3_t *ctx, gps3_cfg_t *cfg)
 Initialization function. More...
 
void gps3_module_wakeup (gps3_t *ctx)
 Wake-up module. More...
 
void gps3_set_rst_pin (gps3_t *ctx, uint8_t state)
 Set RST ( reset ) pin state. More...
 
void gps3_generic_write (gps3_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int16_t gps3_generic_read (gps3_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 
gps3_error_t gps3_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf)
 Generic parser function. More...
 

Detailed Description

Function Documentation

◆ gps3_cfg_setup()

void gps3_cfg_setup ( gps3_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ gps3_generic_parser()

gps3_error_t gps3_generic_parser ( char *  rsp,
uint8_t  command,
uint8_t  element,
char *  parser_buf 
)

Generic parser function.

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

◆ gps3_generic_read()

int16_t gps3_generic_read ( gps3_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

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

◆ gps3_generic_write()

void gps3_generic_write ( gps3_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

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

◆ gps3_init()

GPS3_RETVAL gps3_init ( gps3_t ctx,
gps3_cfg_t cfg 
)

Initialization function.

Parameters
gps3Click object.
cfgClick configuration structure.

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

◆ gps3_module_wakeup()

void gps3_module_wakeup ( gps3_t ctx)

Wake-up module.

Parameters
gps3Click object.

◆ gps3_set_rst_pin()

void gps3_set_rst_pin ( gps3_t ctx,
uint8_t  state 
)

Set RST ( reset ) pin state.

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