gnss14
2.1.0.0
|
API for configuring and manipulating GNSS 14 Click driver. More...
Modules | |
GNSS 14 Device Settings | |
Settings for registers of GNSS 14 Click driver. | |
GNSS 14 MikroBUS Map | |
MikroBUS pin mapping of GNSS 14 Click driver. | |
Functions | |
void | gnss14_cfg_setup (gnss14_cfg_t *cfg) |
GNSS 14 configuration object setup function. More... | |
err_t | gnss14_init (gnss14_t *ctx, gnss14_cfg_t *cfg) |
GNSS 14 initialization function. More... | |
err_t | gnss14_generic_write (gnss14_t *ctx, uint8_t *data_in, uint16_t len) |
GNSS 14 data writing function. More... | |
err_t | gnss14_generic_read (gnss14_t *ctx, uint8_t *data_out, uint16_t len) |
GNSS 14 data reading function. More... | |
void | gnss14_set_io6_pin (gnss14_t *ctx, uint8_t state) |
GNSS 14 set IO6 pin function. More... | |
void | gnss14_set_rst_pin (gnss14_t *ctx, uint8_t state) |
GNSS 14 set RST pin function. More... | |
uint8_t | gnss14_get_eit_pin (gnss14_t *ctx) |
GNSS 14 get external interrupt pin state function. More... | |
uint8_t | gnss14_get_tp_pin (gnss14_t *ctx) |
GNSS 14 get time pulse signal pin state function. More... | |
void | gnss14_reset_device (gnss14_t *ctx) |
GNSS 14 reset device function. More... | |
err_t | gnss14_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data) |
GNSS 14 parse GNGGA function. More... | |
API for configuring and manipulating GNSS 14 Click driver.
void gnss14_cfg_setup | ( | gnss14_cfg_t * | cfg | ) |
GNSS 14 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnss14_cfg_t object definition for detailed explanation. |
err_t gnss14_generic_read | ( | gnss14_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
GNSS 14 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss14_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 gnss14_generic_write | ( | gnss14_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
GNSS 14 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss14_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. uint8_t gnss14_get_eit_pin | ( | gnss14_t * | ctx | ) |
GNSS 14 get external interrupt pin state function.
This function returns the EIT pin logic state.
[in] | ctx | : Click context object. See gnss14_t object definition for detailed explanation. |
uint8_t gnss14_get_tp_pin | ( | gnss14_t * | ctx | ) |
GNSS 14 get time pulse signal pin state function.
This function returns the TP pin logic state.
[in] | ctx | : Click context object. See gnss14_t object definition for detailed explanation. |
err_t gnss14_init | ( | gnss14_t * | ctx, |
gnss14_cfg_t * | cfg | ||
) |
GNSS 14 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnss14_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnss14_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t gnss14_parse_gngga | ( | char * | rsp_buf, |
uint8_t | gngga_element, | ||
char * | element_data | ||
) |
GNSS 14 parse GNGGA function.
This function parses the GNGGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gngga_element | : GNGGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void gnss14_reset_device | ( | gnss14_t * | ctx | ) |
GNSS 14 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See gnss14_t object definition for detailed explanation. |
void gnss14_set_io6_pin | ( | gnss14_t * | ctx, |
uint8_t | state | ||
) |
GNSS 14 set IO6 pin function.
This function ets the IO6 (AN) pin logic state.
[in] | ctx | : Click context object. See gnss14_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |