nanogps2  2.0.0.0
Functions

Functions

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

Detailed Description

Function Documentation

◆ nanogps2_cfg_setup()

void nanogps2_cfg_setup ( nanogps2_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.

◆ nanogps2_generic_parser()

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

Generic parser function.

Parameters
rspResponse buffer.
commandNEMA ( GPS/GNSS ) command.
elementElement position in command.
parser_bufParser 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
nanogps2Click object.
data_bufData buffer for read data.
max_lenThe 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
nanogps2Click object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ nanogps2_get_rts_pin()

uint8_t nanogps2_get_rts_pin ( nanogps2_t ctx)

Get RTS pin state.

Parameters
ctxClick object.
Returns
current pin state.

◆ nanogps2_get_wkp_pin()

uint8_t nanogps2_get_wkp_pin ( nanogps2_t ctx)

Get WKP pin state.

Parameters
ctxClick object.
Returns
current pin state.

◆ nanogps2_init()

NANOGPS2_RETVAL nanogps2_init ( nanogps2_t ctx,
nanogps2_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick 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
ctxClick 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
ctxClick object.
statestate 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
ctxClick object.
statestate 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
ctxClick object.
statestate of the pin