gnss15
2.1.0.0
|
API for configuring and manipulating GNSS 15 Click driver. More...
Modules | |
GNSS 15 Device Settings | |
Settings for registers of GNSS 15 Click driver. | |
GNSS 15 MikroBUS Map | |
MikroBUS pin mapping of GNSS 15 Click driver. | |
Functions | |
void | gnss15_cfg_setup (gnss15_cfg_t *cfg) |
GNSS 15 configuration object setup function. More... | |
err_t | gnss15_init (gnss15_t *ctx, gnss15_cfg_t *cfg) |
GNSS 15 initialization function. More... | |
err_t | gnss15_generic_write (gnss15_t *ctx, uint8_t *data_in, uint16_t len) |
GNSS 15 data writing function. More... | |
err_t | gnss15_generic_read (gnss15_t *ctx, uint8_t *data_out, uint16_t len) |
GNSS 15 data reading function. More... | |
void | gnss15_set_rst_pin (gnss15_t *ctx, uint8_t state) |
GNSS 15 set RST pin function. More... | |
void | gnss15_set_wup_pin (gnss15_t *ctx, uint8_t state) |
GNSS 15 set WUP pin function. More... | |
uint8_t | gnss15_get_interrupt (gnss15_t *ctx) |
GNSS 15 get interrupt pin state function. More... | |
void | gnss15_reset_device (gnss15_t *ctx) |
GNSS 15 reset device function. More... | |
err_t | gnss15_parse_gpgga (uint8_t *rsp_buf, uint8_t gpgga_element, uint8_t *element_data) |
GNSS 15 parse GPGGA function. More... | |
API for configuring and manipulating GNSS 15 Click driver.
void gnss15_cfg_setup | ( | gnss15_cfg_t * | cfg | ) |
GNSS 15 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnss15_cfg_t object definition for detailed explanation. |
err_t gnss15_generic_read | ( | gnss15_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
GNSS 15 data reading function.
reads a desired number of data bytes from the module.
[in] | ctx | : Click context object. See gnss15_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 gnss15_generic_write | ( | gnss15_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
GNSS 15 data writing function.
This function writes a desired number of data bytes to the module.
[in] | ctx | : Click context object. See gnss15_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 gnss15_get_interrupt | ( | gnss15_t * | ctx | ) |
GNSS 15 get interrupt pin state function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See gnss15_t object definition for detailed explanation. |
err_t gnss15_init | ( | gnss15_t * | ctx, |
gnss15_cfg_t * | cfg | ||
) |
GNSS 15 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnss15_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnss15_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t gnss15_parse_gpgga | ( | uint8_t * | rsp_buf, |
uint8_t | gpgga_element, | ||
uint8_t * | element_data | ||
) |
GNSS 15 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 gnss15_reset_device | ( | gnss15_t * | ctx | ) |
GNSS 15 reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See gnss15_t object definition for detailed explanation. |
void gnss15_set_rst_pin | ( | gnss15_t * | ctx, |
uint8_t | state | ||
) |
GNSS 15 set RST pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See gnss15_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |