rtkrover
2.1.0.0
|
API for configuring and manipulating RTK Rover Click driver. More...
Modules | |
RTK Rover Device Settings | |
Settings for registers of RTK Rover Click driver. | |
RTK Rover MikroBUS Map | |
MikroBUS pin mapping of RTK Rover Click driver. | |
Functions | |
void | rtkrover_cfg_setup (rtkrover_cfg_t *cfg) |
RTK Rover configuration object setup function. More... | |
err_t | rtkrover_init (rtkrover_t *ctx, rtkrover_cfg_t *cfg) |
RTK Rover initialization function. More... | |
err_t | rtkrover_generic_write (rtkrover_t *ctx, char *data_in, uint16_t len) |
RTK Rover data writing function. More... | |
err_t | rtkrover_generic_read (rtkrover_t *ctx, char *data_out, uint16_t len) |
RTK Rover data reading function. More... | |
void | rtkrover_clear_ring_buffers (rtkrover_t *ctx) |
RTK Rover clear ring buffers function. More... | |
void | rtkrover_set_rst_pin (rtkrover_t *ctx, uint8_t state) |
RTK Rover set RST pin function. More... | |
void | rtkrover_set_wup_pin (rtkrover_t *ctx, uint8_t state) |
RTK Rover set WUP pin function. More... | |
void | rtkrover_set_boot_pin (rtkrover_t *ctx, uint8_t state) |
RTK Rover set BOOT pin function. More... | |
void | rtkrover_set_shd_pin (rtkrover_t *ctx, uint8_t state) |
RTK Rover set SHD pin function. More... | |
uint8_t | rtkrover_get_int_pin (rtkrover_t *ctx) |
RTK Rover get INT pin function. More... | |
err_t | rtkrover_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data) |
RTK Rover parse GNGGA function. More... | |
API for configuring and manipulating RTK Rover Click driver.
void rtkrover_cfg_setup | ( | rtkrover_cfg_t * | cfg | ) |
RTK Rover configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See rtkrover_cfg_t object definition for detailed explanation. |
void rtkrover_clear_ring_buffers | ( | rtkrover_t * | ctx | ) |
RTK Rover clear ring buffers function.
This function clears UART tx and rx ring buffers.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
err_t rtkrover_generic_read | ( | rtkrover_t * | ctx, |
char * | data_out, | ||
uint16_t | len | ||
) |
RTK Rover data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See rtkrover_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 rtkrover_generic_write | ( | rtkrover_t * | ctx, |
char * | data_in, | ||
uint16_t | len | ||
) |
RTK Rover data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See rtkrover_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 rtkrover_get_int_pin | ( | rtkrover_t * | ctx | ) |
RTK Rover get INT pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
err_t rtkrover_init | ( | rtkrover_t * | ctx, |
rtkrover_cfg_t * | cfg | ||
) |
RTK Rover initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See rtkrover_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t rtkrover_parse_gngga | ( | char * | rsp_buf, |
uint8_t | gngga_element, | ||
char * | element_data | ||
) |
RTK Rover 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 rtkrover_set_boot_pin | ( | rtkrover_t * | ctx, |
uint8_t | state | ||
) |
RTK Rover set BOOT pin function.
This function sets the BOOT pin logic state.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void rtkrover_set_rst_pin | ( | rtkrover_t * | ctx, |
uint8_t | state | ||
) |
RTK Rover set RST pin function.
This function sets the RST pin logic state.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void rtkrover_set_shd_pin | ( | rtkrover_t * | ctx, |
uint8_t | state | ||
) |
RTK Rover set SHD pin function.
This function sets the SHD pin logic state.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |
void rtkrover_set_wup_pin | ( | rtkrover_t * | ctx, |
uint8_t | state | ||
) |
RTK Rover set WUP pin function.
This function sets the WUP pin logic state.
[in] | ctx | : Click context object. See rtkrover_t object definition for detailed explanation. |
[in] | state | : Pin logic state. |