gnss17  2.1.0.0
Modules | Functions
GNSS 17 Click Driver

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

Modules

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

Functions

void gnss17_cfg_setup (gnss17_cfg_t *cfg)
 GNSS 17 configuration object setup function. More...
 
err_t gnss17_init (gnss17_t *ctx, gnss17_cfg_t *cfg)
 GNSS 17 initialization function. More...
 
err_t gnss17_generic_write (gnss17_t *ctx, uint8_t *data_in, uint16_t len)
 GNSS 17 data writing function. More...
 
err_t gnss17_generic_read (gnss17_t *ctx, uint8_t *data_out, uint16_t len)
 GNSS 17 data reading function. More...
 
void gnss17_set_en_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set EN pin function. More...
 
void gnss17_set_aon_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set AON pin function. More...
 
void gnss17_set_rts_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set RTS pin function. More...
 
void gnss17_set_rtc_pin (gnss17_t *ctx, uint8_t state)
 GNSS 17 set RTC pin function. More...
 
void gnss17_reset_device (gnss17_t *ctx)
 GNSS 17 reset device function. More...
 
err_t gnss17_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 GNSS 17 parse GGA function. More...
 

Detailed Description

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

◆ gnss17_cfg_setup()

void gnss17_cfg_setup ( gnss17_cfg_t cfg)

GNSS 17 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ gnss17_generic_read()

err_t gnss17_generic_read ( gnss17_t ctx,
uint8_t *  data_out,
uint16_t  len 
)

GNSS 17 data reading function.

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

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

◆ gnss17_generic_write()

err_t gnss17_generic_write ( gnss17_t ctx,
uint8_t *  data_in,
uint16_t  len 
)

GNSS 17 data writing function.

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

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

◆ gnss17_init()

err_t gnss17_init ( gnss17_t ctx,
gnss17_cfg_t cfg 
)

GNSS 17 initialization function.

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

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

◆ gnss17_parse_gga()

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

GNSS 17 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.

◆ gnss17_reset_device()

void gnss17_reset_device ( gnss17_t ctx)

GNSS 17 reset device function.

This function resets the device by toggling the EN and AON pins.

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

◆ gnss17_set_aon_pin()

void gnss17_set_aon_pin ( gnss17_t ctx,
uint8_t  state 
)

GNSS 17 set AON pin function.

This function sets the AON pin logic state.

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

◆ gnss17_set_en_pin()

void gnss17_set_en_pin ( gnss17_t ctx,
uint8_t  state 
)

GNSS 17 set EN pin function.

This function sets the EN pin logic state.

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

◆ gnss17_set_rtc_pin()

void gnss17_set_rtc_pin ( gnss17_t ctx,
uint8_t  state 
)

GNSS 17 set RTC pin function.

This function sets the RTC pin logic state.

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

◆ gnss17_set_rts_pin()

void gnss17_set_rts_pin ( gnss17_t ctx,
uint8_t  state 
)

GNSS 17 set RTS pin function.

This function sets the RTS pin logic state.

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