gnssmax
2.0.0.0
|
API for configuring and manipulating GNSS MAX Click driver. More...
Modules | |
GNSS MAX Device Settings | |
Settings for registers of GNSS MAX Click driver. | |
GNSS MAX MikroBUS Map | |
MikroBUS pin mapping of GNSS MAX Click driver. | |
Functions | |
void | gnssmax_cfg_setup (gnssmax_cfg_t *cfg) |
GNSS MAX configuration object setup function. More... | |
err_t | gnssmax_init (gnssmax_t *ctx, gnssmax_cfg_t *cfg) |
GNSS MAX initialization function. More... | |
err_t | gnssmax_default_cfg (gnssmax_t *ctx) |
GNSS MAX default configuration function. More... | |
err_t | gnssmax_generic_write (gnssmax_t *ctx, char *data_buf, uint16_t len) |
GNSS MAX data writing function. More... | |
err_t | gnssmax_generic_read (gnssmax_t *ctx, char *data_buf, uint16_t max_len) |
GNSS MAX data reading function. More... | |
void | gnssmax_reset (gnssmax_t *ctx) |
GNSS MAX reset function. More... | |
void | gnssmax_set_external_interrupt (gnssmax_t *ctx, uint8_t state) |
GNSS MAX sets state of external interrupt. More... | |
uint8_t | gnssmax_get_pps (gnssmax_t *ctx) |
GNSS MAX reads timestamp pin state. More... | |
API for configuring and manipulating GNSS MAX Click driver.
void gnssmax_cfg_setup | ( | gnssmax_cfg_t * | cfg | ) |
GNSS MAX configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See gnssmax_cfg_t object definition for detailed explanation. |
err_t gnssmax_default_cfg | ( | gnssmax_t * | ctx | ) |
GNSS MAX default configuration function.
This function executes a default configuration of GNSS MAX click board.
[in] | ctx | : Click context object. See gnssmax_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t gnssmax_generic_read | ( | gnssmax_t * | ctx, |
char * | data_buf, | ||
uint16_t | max_len | ||
) |
GNSS MAX data reading function.
This function reads a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnssmax_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 gnssmax_generic_write | ( | gnssmax_t * | ctx, |
char * | data_buf, | ||
uint16_t | len | ||
) |
GNSS MAX data writing function.
This function writes a desired number of data bytes by using UART serial interface.
[in] | ctx | : Click context object. See gnssmax_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 gnssmax_get_pps | ( | gnssmax_t * | ctx | ) |
GNSS MAX reads timestamp pin state.
This function reads logic state of timestamp pin.
[out] | ctx | : Click context object. See gnssmax_t object definition for detailed explanation. |
err_t gnssmax_init | ( | gnssmax_t * | ctx, |
gnssmax_cfg_t * | cfg | ||
) |
GNSS MAX initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See gnssmax_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See gnssmax_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void gnssmax_reset | ( | gnssmax_t * | ctx | ) |
GNSS MAX reset function.
This function toggles reset pin to reset module.
[in] | ctx | : Click context object. See gnssmax_t object definition for detailed explanation. |
void gnssmax_set_external_interrupt | ( | gnssmax_t * | ctx, |
uint8_t | state | ||
) |
GNSS MAX sets state of external interrupt.
This function sets logic state of ext_int pin.
[in] | ctx | : Click context object. See gnssmax_t object definition for detailed explanation. |
[in] | state | : State of pin to set. |