gnss21 2.2.1
Loading...
Searching...
No Matches
GNSS 21 Click Driver

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

Topics

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

Functions

void gnss21_cfg_setup (gnss21_cfg_t *cfg)
 GNSS 21 configuration object setup function.
void gnss21_drv_interface_sel (gnss21_cfg_t *cfg, gnss21_drv_t drv_sel)
 GNSS 21 driver interface setup function.
err_t gnss21_init (gnss21_t *ctx, gnss21_cfg_t *cfg)
 GNSS 21 initialization function.
err_t gnss21_generic_write (gnss21_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 21 data writing function.
err_t gnss21_generic_read (gnss21_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 21 data reading function.
uint8_t gnss21_get_pps_pin (gnss21_t *ctx)
 GNSS 21 get PPS pin function.
void gnss21_set_rst_pin (gnss21_t *ctx, uint8_t state)
 GNSS 21 set RST pin function.
void gnss21_reset_device (gnss21_t *ctx)
 GNSS 21 reset device function.
err_t gnss21_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS 21 parse GGA function.

Detailed Description

API for configuring and manipulating GNSS 21 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

◆ gnss21_cfg_setup()

void gnss21_cfg_setup ( gnss21_cfg_t * cfg)

GNSS 21 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ gnss21_drv_interface_sel()

void gnss21_drv_interface_sel ( gnss21_cfg_t * cfg,
gnss21_drv_t drv_sel )

GNSS 21 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters
[out]cfg: Click configuration structure. See gnss21_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See gnss21_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ gnss21_generic_read()

err_t gnss21_generic_read ( gnss21_t * ctx,
uint8_t * data_out,
uint16_t len )

GNSS 21 data reading function.

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

Parameters
[in]ctx: Click context object. See gnss21_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.

◆ gnss21_generic_write()

err_t gnss21_generic_write ( gnss21_t * ctx,
uint8_t * data_in,
uint16_t len )

GNSS 21 data writing function.

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

Parameters
[in]ctx: Click context object. See gnss21_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.

◆ gnss21_get_pps_pin()

uint8_t gnss21_get_pps_pin ( gnss21_t * ctx)

GNSS 21 get PPS pin function.

This function returns the pulse per second (PPS) pin logic state.

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

◆ gnss21_init()

err_t gnss21_init ( gnss21_t * ctx,
gnss21_cfg_t * cfg )

GNSS 21 initialization function.

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

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

◆ gnss21_parse_gga()

err_t gnss21_parse_gga ( uint8_t * rsp_buf,
uint8_t gga_element,
uint8_t * element_data )

GNSS 21 parse GGA function.

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

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

◆ gnss21_reset_device()

void gnss21_reset_device ( gnss21_t * ctx)

GNSS 21 reset device function.

This function resets the device by toggling the RST pin.

Parameters
[in]ctx: Click context object. See gnss21_t object definition for detailed explanation.
Returns
None.
Note
None.

◆ gnss21_set_rst_pin()

void gnss21_set_rst_pin ( gnss21_t * ctx,
uint8_t state )

GNSS 21 set RST pin function.

This function sets the RST pin logic state.

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