|
gnssrtk4 2.2.0
|
API for configuring and manipulating GNSS RTK 4 Click driver. More...
Topics | |
| GNSS RTK 4 Device Settings | |
| Settings for registers of GNSS RTK 4 Click driver. | |
| GNSS RTK 4 MikroBUS Map | |
| MikroBUS pin mapping of GNSS RTK 4 Click driver. | |
Functions | |
| void | gnssrtk4_cfg_setup (gnssrtk4_cfg_t *cfg) |
| GNSS RTK 4 configuration object setup function. | |
| err_t | gnssrtk4_init (gnssrtk4_t *ctx, gnssrtk4_cfg_t *cfg) |
| GNSS RTK 4 initialization function. | |
| err_t | gnssrtk4_generic_write (gnssrtk4_t *ctx, uint8_t *data_in, uint16_t len) |
| GNSS RTK 4 data writing function. | |
| err_t | gnssrtk4_generic_read (gnssrtk4_t *ctx, uint8_t *data_out, uint16_t len) |
| GNSS RTK 4 data reading function. | |
| void | gnssrtk4_set_rst_pin (gnssrtk4_t *ctx, uint8_t state) |
| GNSS RTK 4 set RST pin function. | |
| void | gnssrtk4_set_evt_pin (gnssrtk4_t *ctx, uint8_t state) |
| GNSS RTK 4 set EVT pin function. | |
| uint8_t | gnssrtk4_get_sta_pin (gnssrtk4_t *ctx) |
| GNSS RTK 4 get STA pin function. | |
| uint8_t | gnssrtk4_get_pps_pin (gnssrtk4_t *ctx) |
| GNSS RTK 4 get PPS pin function. | |
| void | gnssrtk4_reset_device (gnssrtk4_t *ctx) |
| GNSS RTK 4 reset device function. | |
| err_t | gnssrtk4_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data) |
| GNSS RTK 4 parse GGA function. | |
API for configuring and manipulating GNSS RTK 4 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
| void gnssrtk4_cfg_setup | ( | gnssrtk4_cfg_t * | cfg | ) |
GNSS RTK 4 configuration object setup function.
This function initializes Click configuration structure to initial values.
| [out] | cfg | : Click configuration structure. See gnssrtk4_cfg_t object definition for detailed explanation. |
| err_t gnssrtk4_generic_read | ( | gnssrtk4_t * | ctx, |
| uint8_t * | data_out, | ||
| uint16_t | len ) |
GNSS RTK 4 data reading function.
This function reads a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See gnssrtk4_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 gnssrtk4_generic_write | ( | gnssrtk4_t * | ctx, |
| uint8_t * | data_in, | ||
| uint16_t | len ) |
GNSS RTK 4 data writing function.
This function writes a desired number of data bytes by using UART serial interface.
| [in] | ctx | : Click context object. See gnssrtk4_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 gnssrtk4_get_pps_pin | ( | gnssrtk4_t * | ctx | ) |
GNSS RTK 4 get PPS pin function.
This function returns the pulse per second (PPS) pin logic state.
| [in] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| uint8_t gnssrtk4_get_sta_pin | ( | gnssrtk4_t * | ctx | ) |
GNSS RTK 4 get STA pin function.
This function returns the RTK Status (STA) pin logic state.
| [in] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| err_t gnssrtk4_init | ( | gnssrtk4_t * | ctx, |
| gnssrtk4_cfg_t * | cfg ) |
GNSS RTK 4 initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
| [out] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| [in] | cfg | : Click configuration structure. See gnssrtk4_cfg_t object definition for detailed explanation. |
0 - Success, -1 - Error. See #err_t definition for detailed explanation. | err_t gnssrtk4_parse_gga | ( | uint8_t * | rsp_buf, |
| uint8_t | gga_element, | ||
| uint8_t * | element_data ) |
GNSS RTK 4 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 gnssrtk4_reset_device | ( | gnssrtk4_t * | ctx | ) |
GNSS RTK 4 reset device function.
This function resets the device by toggling the RST pin.
| [in] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| void gnssrtk4_set_evt_pin | ( | gnssrtk4_t * | ctx, |
| uint8_t | state ) |
GNSS RTK 4 set EVT pin function.
This function sets the EVT pin logic state.
| [in] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |
| void gnssrtk4_set_rst_pin | ( | gnssrtk4_t * | ctx, |
| uint8_t | state ) |
GNSS RTK 4 set RST pin function.
This function sets the RST pin logic state.
| [in] | ctx | : Click context object. See gnssrtk4_t object definition for detailed explanation. |
| [in] | state | : Pin logic state. |