gnss
2.0.0.0
|
API for configuring and manipulating GNSS Click driver. More...
Modules | |
GNSS Device Settings | |
Settings for registers of GNSS Click driver. | |
GNSS MikroBUS Map | |
MikroBUS pin mapping of GNSS Click driver. | |
Functions | |
void | gnss_cfg_setup (gnss_cfg_t *cfg) |
GNSS configuration object setup function. More... | |
err_t | gnss_init (gnss_t *ctx, gnss_cfg_t *cfg) |
GNSS initialization function. More... | |
err_t | gnss_generic_write (gnss_t *ctx, char *data_in, uint16_t len) |
GNSS data writing function. More... | |
err_t | gnss_generic_read (gnss_t *ctx, char *data_out, uint16_t len) |
GNSS data reading function. More... | |
void | gnss_clear_ring_buffers (gnss_t *ctx) |
GNSS clear ring buffers function. More... | |
void | gnss_set_rst_pin (gnss_t *ctx, uint8_t state) |
GNSS set RST pin function. More... | |
void | gnss_set_fon_pin (gnss_t *ctx, uint8_t state) |
GNSS set FON pin function. More... | |
err_t | gnss_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data) |
GNSS parse GPGGA function. More... | |
API for configuring and manipulating GNSS Click driver.
void gnss_cfg_setup | ( | gnss_cfg_t * | cfg | ) |
GNSS configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnss_cfg_t object definition for detailed explanation. |
void gnss_clear_ring_buffers | ( | gnss_t * | ctx | ) |
GNSS clear ring buffers function.
This function clears UART tx and rx ring buffers.
[in] | ctx | : Click context object. See gnss_t object definition for detailed explanation. |
err_t gnss_generic_read | ( | gnss_t * | ctx, |
char * | data_out, | ||
uint16_t | len | ||
) |
GNSS data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss_t object definition for detailed explanation. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer. See #err_t definition for detailed explanation. err_t gnss_generic_write | ( | gnss_t * | ctx, |
char * | data_in, | ||
uint16_t | len | ||
) |
GNSS data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss_t object definition for detailed explanation. |
[in] | data_in | : Data buffer for sending. |
[in] | len | : Number of bytes for sending. |
>=0
- Success, <0
- Error. See #err_t definition for detailed explanation. err_t gnss_init | ( | gnss_t * | ctx, |
gnss_cfg_t * | cfg | ||
) |
GNSS initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnss_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnss_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t gnss_parse_gpgga | ( | char * | rsp_buf, |
uint8_t | gpgga_element, | ||
char * | element_data | ||
) |
GNSS parse GPGGA function.
This function parses the GPGGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gpgga_element | : GPGGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void gnss_set_fon_pin | ( | gnss_t * | ctx, |
uint8_t | state | ||
) |
GNSS set FON pin function.
This function sets the FON pin logic state.
[in] | ctx | : Click context object. See gnss_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |