gnss16  2.1.0.0
Modules | Functions
GNSS 16 Click Driver

API for configuring and manipulating GNSS 16 Click driver. More...

Modules

 GNSS 16 Device Settings
 Settings for registers of GNSS 16 Click driver.
 
 GNSS 16 MikroBUS Map
 MikroBUS pin mapping of GNSS 16 Click driver.
 

Functions

void gnss16_cfg_setup (gnss16_cfg_t *cfg)
 GNSS 16 configuration object setup function. More...
 
err_t gnss16_init (gnss16_t *ctx, gnss16_cfg_t *cfg)
 GNSS 16 initialization function. More...
 
void gnss16_set_rst_pin (gnss16_t *ctx, uint8_t state)
 GNSS 16 set RST pin function. More...
 
void gnss16_reset_device (gnss16_t *ctx)
 GNSS 16 reset device function. More...
 
err_t gnss16_generic_write (gnss16_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 16 data writing function. More...
 
err_t gnss16_generic_read (gnss16_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 16 data reading function. More...
 
err_t gnss16_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
 GNSS 16 parse GNGGA function. More...
 
uint8_t gnss16_get_int_pin (gnss16_t *ctx)
 GNSS 16 get interrupt pin state function. More...
 

Detailed Description

API for configuring and manipulating GNSS 16 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ gnss16_cfg_setup()

void gnss16_cfg_setup ( gnss16_cfg_t cfg)

GNSS 16 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See gnss16_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ gnss16_generic_read()

err_t gnss16_generic_read ( gnss16_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

GNSS 16 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnss16_t object definition for detailed explanation.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.
Note
None.

◆ gnss16_generic_write()

err_t gnss16_generic_write ( gnss16_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

GNSS 16 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnss16_t object definition for detailed explanation.
[in]data_in: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ gnss16_get_int_pin()

uint8_t gnss16_get_int_pin ( gnss16_t ctx)

GNSS 16 get interrupt pin state function.

This function returns the INT pin logic state.

Parameters
[in]ctx: Click context object. See gnss16_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ gnss16_init()

err_t gnss16_init ( gnss16_t ctx,
gnss16_cfg_t cfg 
)

GNSS 16 initialization function.

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

Parameters
[out]ctx: Click context object. See gnss16_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See gnss16_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ gnss16_parse_gngga()

err_t gnss16_parse_gngga ( char *  rsp_buf,
uint8_t  gngga_element,
char *  element_data 
)

GNSS 16 parse GNGGA function.

This function parses the GNGGA data from the read response buffer.

Parameters
[in]rsp_buf: Response buffer.
[in]gngga_element: GNGGA element position [1-14].
[out]element_data: Element data parsed.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ gnss16_reset_device()

void gnss16_reset_device ( gnss16_t ctx)

GNSS 16 reset device function.

This function resets the device by toggling the RST pin.

Parameters
[in]ctx: Click context object. See gnss16_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ gnss16_set_rst_pin()

void gnss16_set_rst_pin ( gnss16_t ctx,
uint8_t  state 
)

GNSS 16 set RST pin function.

This function sets the RST pin logic state.

Parameters
[in]ctx: Click context object. See gnss16_t object definition for detailed explanation.
[in]state: Pin logic state.
Note
None.