gnss11
2.1.0.0
|
API for configuring and manipulating GNSS 11 Click driver. More...
Modules | |
GNSS 11 Device Settings | |
Settings for registers of GNSS 11 Click driver. | |
GNSS 11 MikroBUS Map | |
MikroBUS pin mapping of GNSS 11 Click driver. | |
Functions | |
void | gnss11_cfg_setup (gnss11_cfg_t *cfg) |
GNSS 11 configuration object setup function. More... | |
err_t | gnss11_init (gnss11_t *ctx, gnss11_cfg_t *cfg) |
GNSS 11 initialization function. More... | |
void | gnss11_drv_interface_selection (gnss11_cfg_t *cfg, gnss11_drv_t drv_sel) |
GNSS 11 driver interface setup function. More... | |
err_t | gnss11_default_cfg (gnss11_t *ctx) |
GNSS 11 default configuration function. More... | |
err_t | gnss11_generic_write (gnss11_t *ctx, uint8_t *data_in, uint16_t len) |
GNSS 11 data writing function. More... | |
err_t | gnss11_generic_read (gnss11_t *ctx, uint8_t *data_out, uint16_t len) |
GNSS 11 data reading function. More... | |
uint8_t | gnss11_get_ovc_pin (gnss11_t *ctx) |
GNSS 11 get OVC pin function. More... | |
void | gnss11_set_rst_pin (gnss11_t *ctx, uint8_t state) |
GNSS 11 set RST pin function. More... | |
void | gnss11_set_ant_on_pin (gnss11_t *ctx, uint8_t state) |
GNSS 11 set ANT_ON pin function. More... | |
uint8_t | gnss11_get_eint_pin (gnss11_t *ctx) |
GNSS 11 get Ext INT pin function. More... | |
void | gnss11_reset_device (gnss11_t *ctx) |
GNSS 11 reset device function. More... | |
err_t | gnss11_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data) |
GNSS 11 parse GGA function. More... | |
API for configuring and manipulating GNSS 11 Click driver.
void gnss11_cfg_setup | ( | gnss11_cfg_t * | cfg | ) |
GNSS 11 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnss11_cfg_t object definition for detailed explanation. |
err_t gnss11_default_cfg | ( | gnss11_t * | ctx | ) |
GNSS 11 default configuration function.
This function executes a default configuration of GNSS 11 click board.
[in] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void gnss11_drv_interface_selection | ( | gnss11_cfg_t * | cfg, |
gnss11_drv_t | drv_sel | ||
) |
GNSS 11 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 gnss11_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See gnss11_drv_t object definition for detailed explanation. |
err_t gnss11_generic_read | ( | gnss11_t * | ctx, |
uint8_t * | data_out, | ||
uint16_t | len | ||
) |
GNSS 11 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss11_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 gnss11_generic_write | ( | gnss11_t * | ctx, |
uint8_t * | data_in, | ||
uint16_t | len | ||
) |
GNSS 11 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnss11_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 gnss11_get_eint_pin | ( | gnss11_t * | ctx | ) |
GNSS 11 get Ext INT pin function.
This function returns the Ext INT pin logic state.
[in] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
uint8_t gnss11_get_ovc_pin | ( | gnss11_t * | ctx | ) |
GNSS 11 get OVC pin function.
This function returns the over-current (OVC) pin logic state.
[in] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
err_t gnss11_init | ( | gnss11_t * | ctx, |
gnss11_cfg_t * | cfg | ||
) |
GNSS 11 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnss11_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t gnss11_parse_gga | ( | uint8_t * | rsp_buf, |
uint8_t | gga_element, | ||
uint8_t * | element_data | ||
) |
GNSS 11 parse GGA function.
This function parses the GGA data from the read response buffer.
[in] | rsp_buf | : Response buffer. |
[in] | gga_element | : GGA element position [1-14]. |
[out] | element_data | : Element data parsed. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void gnss11_reset_device | ( | gnss11_t * | ctx | ) |
GNSS 11 reset device function.
This function resets the device by toggling the RST and ANT_ON pins.
[in] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
void gnss11_set_ant_on_pin | ( | gnss11_t * | ctx, |
uint8_t | state | ||
) |
GNSS 11 set ANT_ON pin function.
This function sets the ANT_ON pin logic state.
[in] | ctx | : Click context object. See gnss11_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |