|
gnssrtk5 2.2.1
|
API for configuring and manipulating GNSS RTK 5 Click driver. More...
Topics | |
| GNSS RTK 5 Device Settings | |
| Settings for registers of GNSS RTK 5 Click driver. | |
| GNSS RTK 5 MikroBUS Map | |
| MikroBUS pin mapping of GNSS RTK 5 Click driver. | |
Functions | |
| void | gnssrtk5_cfg_setup (gnssrtk5_cfg_t *cfg) |
| GNSS RTK 5 configuration object setup function. | |
| err_t | gnssrtk5_init (gnssrtk5_t *ctx, gnssrtk5_cfg_t *cfg) |
| GNSS RTK 5 initialization function. | |
| err_t | gnssrtk5_generic_write (gnssrtk5_t *ctx, uint8_t *data_in, uint16_t len) |
| GNSS RTK 5 data writing function. | |
| err_t | gnssrtk5_generic_read (gnssrtk5_t *ctx, uint8_t *data_out, uint16_t len) |
| GNSS RTK 5 data reading function. | |
| void | gnssrtk5_set_rst_pin (gnssrtk5_t *ctx, uint8_t state) |
| GNSS RTK 5 set RST pin function. | |
| void | gnssrtk5_reset_device (gnssrtk5_t *ctx) |
| GNSS RTK 5 reset device function. | |
| void | gnssrtk5_set_evt_pin (gnssrtk5_t *ctx, uint8_t state) |
| GNSS RTK 5 set EVT pin function. | |
| uint8_t | gnssrtk5_get_pvt_pin (gnssrtk5_t *ctx) |
| GNSS RTK 5 get PVT pin function. | |
| uint8_t | gnssrtk5_get_err_pin (gnssrtk5_t *ctx) |
| GNSS RTK 5 get ERR pin function. | |
| err_t | gnssrtk5_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data) |
| GNSS RTK 5 parse GGA function. | |
| void | gnssrtk5_cmd_run (gnssrtk5_t *ctx, uint8_t *cmd) |
| GNSS RTK 5 cmd run function. | |
API for configuring and manipulating GNSS RTK 5 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void gnssrtk5_cfg_setup | ( | gnssrtk5_cfg_t * | cfg | ) |
GNSS RTK 5 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See gnssrtk5_cfg_t object definition for detailed explanation. |
| void gnssrtk5_cmd_run | ( | gnssrtk5_t * | ctx, |
| uint8_t * | cmd ) |
GNSS RTK 5 cmd run function.
This function sends a specified command to the Click module.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| [in] | cmd | : Command string, see GNSSRTK5_CMD_x definitions. |
| err_t gnssrtk5_generic_read | ( | gnssrtk5_t * | ctx, |
| uint8_t * | data_out, | ||
| uint16_t | len ) |
GNSS RTK 5 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See gnssrtk5_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 gnssrtk5_generic_write | ( | gnssrtk5_t * | ctx, |
| uint8_t * | data_in, | ||
| uint16_t | len ) |
GNSS RTK 5 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See gnssrtk5_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 gnssrtk5_get_err_pin | ( | gnssrtk5_t * | ctx | ) |
GNSS RTK 5 get ERR pin function.
This function returns the abnormal indicator (ERR) pin logic state.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| uint8_t gnssrtk5_get_pvt_pin | ( | gnssrtk5_t * | ctx | ) |
GNSS RTK 5 get PVT pin function.
This function returns the positioning indicator (PVT) pin logic state.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| err_t gnssrtk5_init | ( | gnssrtk5_t * | ctx, |
| gnssrtk5_cfg_t * | cfg ) |
GNSS RTK 5 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See gnssrtk5_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t gnssrtk5_parse_gga | ( | uint8_t * | rsp_buf, |
| uint8_t | gga_element, | ||
| uint8_t * | element_data ) |
GNSS RTK 5 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 gnssrtk5_reset_device | ( | gnssrtk5_t * | ctx | ) |
GNSS RTK 5 reset device function.
This function resets the device by toggling the RST pin.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| void gnssrtk5_set_evt_pin | ( | gnssrtk5_t * | ctx, |
| uint8_t | state ) |
GNSS RTK 5 set EVT pin function.
This function sets the EVT pin logic state.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void gnssrtk5_set_rst_pin | ( | gnssrtk5_t * | ctx, |
| uint8_t | state ) |
GNSS RTK 5 set RST pin function.
This function sets the RST pin logic state.
| [in] | ctx | : Click context object. See gnssrtk5_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |