gnsszoe
2.0.0.0
|
API for configuring and manipulating GNSS ZOE Click driver. More...
Modules | |
GNSS ZOE Registers Settings | |
Settings for registers of GNSS ZOE Click driver. | |
GNSS ZOE MikroBUS Map | |
MikroBUS pin mapping of GNSS ZOE Click driver. | |
Functions | |
void | gnsszoe_cfg_setup (gnsszoe_cfg_t *cfg) |
GNSS ZOE configuration object setup function. More... | |
void | gnsszoe_drv_interface_selection (gnsszoe_cfg_t *cfg, gnsszoe_drv_t drv_sel) |
GNSS ZOE driver interface setup function. More... | |
err_t | gnsszoe_init (gnsszoe_t *ctx, gnsszoe_cfg_t *cfg) |
GNSS ZOE initialization function. More... | |
err_t | gnsszoe_generic_write (gnsszoe_t *ctx, uint8_t *data_in, uint8_t len) |
GNSS ZOE data writing function. More... | |
err_t | gnsszoe_generic_read (gnsszoe_t *ctx, uint8_t *data_out, uint8_t len) |
GNSS ZOE data reading function. More... | |
void | gnsszoe_set_rst_pin (gnsszoe_t *ctx, uint8_t state) |
GNSS ZOE set RST pin function. More... | |
uint8_t | gnsszoe_get_exi_pin (gnsszoe_t *ctx) |
GNSS ZOE get EXI pin function. More... | |
void | gnsszoe_reset_device (gnsszoe_t *ctx) |
GNSS ZOE reset device function. More... | |
err_t | gnsszoe_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data) |
GNSS ZOE parse GNGGA function. More... | |
API for configuring and manipulating GNSS ZOE Click driver.
void gnsszoe_cfg_setup | ( | gnsszoe_cfg_t * | cfg | ) |
GNSS ZOE configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnsszoe_cfg_t object definition for detailed explanation. |
void gnsszoe_drv_interface_selection | ( | gnsszoe_cfg_t * | cfg, |
gnsszoe_drv_t | drv_sel | ||
) |
GNSS ZOE driver interface setup function.
This function sets a serial driver interface which will be used further in the click driver.
[out] | cfg | : Click configuration structure. See gnsszoe_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See gnsszoe_drv_t object definition for detailed explanation. |
err_t gnsszoe_generic_read | ( | gnsszoe_t * | ctx, |
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
GNSS ZOE data reading function.
This function reads a desired number of data bytes from the module.
[in] | ctx | : Click context object. See gnsszoe_t object definition for detailed explanation. |
[out] | data_out | : Output read data. |
[in] | len | : Number of bytes to be read. |
>=0
- Success, or number of data bytes read in the case of UART, -1
- Error. See #err_t definition for detailed explanation. err_t gnsszoe_generic_write | ( | gnsszoe_t * | ctx, |
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
GNSS ZOE data writing function.
This function writes a desired number of data bytes to the module.
[in] | ctx | : Click context object. See gnsszoe_t object definition for detailed explanation. |
[in] | data_in | : Data to be written. |
[in] | len | : Number of bytes to be written. |
>=0
- Success, or number of data bytes written in the case of UART, -1
- Error. See #err_t definition for detailed explanation. uint8_t gnsszoe_get_exi_pin | ( | gnsszoe_t * | ctx | ) |
GNSS ZOE get EXI pin function.
This function returns the EXI pin logic state.
[in] | ctx | : Click context object. See gnsszoe_t object definition for detailed explanation. |
err_t gnsszoe_init | ( | gnsszoe_t * | ctx, |
gnsszoe_cfg_t * | cfg | ||
) |
GNSS ZOE initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnsszoe_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnsszoe_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t gnsszoe_parse_gngga | ( | char * | rsp_buf, |
uint8_t | gngga_element, | ||
char * | element_data | ||
) |
GNSS ZOE 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 gnsszoe_reset_device | ( | gnsszoe_t * | ctx | ) |
GNSS ZOE reset device function.
This function resets the device by toggling the RST pin.
[in] | ctx | : Click context object. See gnsszoe_t object definition for detailed explanation. |