gnssrtk
2.0.0.0
|
API for configuring and manipulating GNSS RTK Click driver. More...
Modules | |
GNSS RTK MikroBUS Map | |
MikroBUS pin mapping of GNSS RTK Click driver. | |
Element | |
Gnssrtk_error_t | |
Command | |
Gnssrtk_set | |
Functions | |
void | gnssrtk_cfg_setup (gnssrtk_cfg_t *cfg) |
GNSS RTK configuration object setup function. More... | |
err_t | gnssrtk_init (gnssrtk_t *ctx, gnssrtk_cfg_t *cfg) |
GNSS RTK initialization function. More... | |
void | gnssrtk_default_cfg (gnssrtk_t *ctx) |
GNSS RTK default configuration function. More... | |
void | gnssrtk_module_cold_start (gnssrtk_t *ctx) |
Module cold start function. More... | |
void | gnssrtk_set_rst_pin (gnssrtk_t *ctx, uint8_t state) |
Set rst pin function. More... | |
uint8_t | gnssrtk_get_rdy_pin (gnssrtk_t *ctx) |
Check rdy pin function. More... | |
uint8_t | gnssrtk_get_rtk_pin (gnssrtk_t *ctx) |
Check rtk pin function. More... | |
uint8_t | gnssrtk_get_tmp_pin (gnssrtk_t *ctx) |
Check tmp pin function. More... | |
err_t | gnssrtk_generic_write (gnssrtk_t *ctx, char *data_buf, uint16_t len) |
GNSS RTK data writing function. More... | |
err_t | gnssrtk_generic_read (gnssrtk_t *ctx, char *data_buf, uint16_t max_len) |
GNSS RTK data reading function. More... | |
gnssrtk_error_t | gnssrtk_generic_parser (char *rsp, uint8_t command, uint8_t element, char *parser_buf) |
Generic parser function. More... | |
API for configuring and manipulating GNSS RTK Click driver.
void gnssrtk_cfg_setup | ( | gnssrtk_cfg_t * | cfg | ) |
GNSS RTK configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnssrtk_cfg_t object definition for detailed explanation. |
void gnssrtk_default_cfg | ( | gnssrtk_t * | ctx | ) |
GNSS RTK default configuration function.
This function executes a default configuration of GNSS RTK click board.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
gnssrtk_error_t gnssrtk_generic_parser | ( | char * | rsp, |
uint8_t | command, | ||
uint8_t | element, | ||
char * | parser_buf | ||
) |
Generic parser function.
[in] | rsp | Response buffer intended for parsing. |
[in] | command | NMEA ( GPS/GNSS ) command. |
[in] | element | Element position in command. |
[out] | parser_buf | Parser buffer for data storage. |
See gnssrtk_error_t definition for detailed explanation.
err_t gnssrtk_generic_read | ( | gnssrtk_t * | ctx, |
char * | data_buf, | ||
uint16_t | max_len | ||
) |
GNSS RTK data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
[out] | data_buf | : Output read data. |
[in] | max_len | : Number of bytes to be read. |
>0
- Number of data bytes read, <=0
- Error/Empty Ring buffer.err_t gnssrtk_generic_write | ( | gnssrtk_t * | ctx, |
char * | data_buf, | ||
uint16_t | len | ||
) |
GNSS RTK data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
[in] | data_buf | : Data buffer for sending. |
[in] | len | : Number of bytes for sending. |
>=0
- Success, <0
- Error.uint8_t gnssrtk_get_rdy_pin | ( | gnssrtk_t * | ctx | ) |
Check rdy pin function.
This function checks if the buffer is full and ready for transmition of data from the module. Return depends on the configuration of the polarity. By default, this feature is disabled.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
0
- Bytes are not ready for transmition, 1
- Bytes are ready to be transmitted.uint8_t gnssrtk_get_rtk_pin | ( | gnssrtk_t * | ctx | ) |
Check rtk pin function.
This function checks the RTK_STAT of the module.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
0
- RTK fixed, 1
- No carrier phase solution is available.uint8_t gnssrtk_get_tmp_pin | ( | gnssrtk_t * | ctx | ) |
Check tmp pin function.
This function checks the timepulse pin of the module which triggers periodically.
[in] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
0
- Timepulse status is inactive or low during period, 1
- Timepulse status is triggered for a period of time.err_t gnssrtk_init | ( | gnssrtk_t * | ctx, |
gnssrtk_cfg_t * | cfg | ||
) |
GNSS RTK initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnssrtk_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnssrtk_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void gnssrtk_module_cold_start | ( | gnssrtk_t * | ctx | ) |
Module cold start function.
Resets the module receiver.
[in] | ctx | : Click context object. |
void gnssrtk_set_rst_pin | ( | gnssrtk_t * | ctx, |
uint8_t | state | ||
) |
Set rst pin function.
This function sets the state of RST pin.
ctx | Click object. | |
[in] | state | :
|