gnss8  2.0.0.0
Functions
GNSS 8 Click Driver

API for configuring and manipulating GNSS 8 Click driver. More...

Functions

void gnss8_cfg_setup (gnss8_cfg_t *cfg)
 GNSS 8 configuration object setup function. More...
 
err_t gnss8_init (gnss8_t *ctx, gnss8_cfg_t *cfg)
 GNSS 8 initialization function. More...
 
err_t gnss8_generic_write (gnss8_t *ctx, char *data_buf, uint16_t len)
 Data writing function. More...
 
err_t gnss8_generic_read (gnss8_t *ctx, char *data_buf, uint16_t max_len)
 Data reading function. More...
 
void gnss8_set_ap_req (gnss8_t *ctx, uint8_t state)
 Set AP request pin state. More...
 
uint8_t gnss8_get_req (gnss8_t *ctx)
 Get request pin state. More...
 
uint8_t gnss8_get_int (gnss8_t *ctx)
 Get interrupt pin state. More...
 
uint8_t gnss8_get_rdy (gnss8_t *ctx)
 Get ready pin state. More...
 

Detailed Description

API for configuring and manipulating GNSS 8 Click driver.

Function Documentation

◆ gnss8_cfg_setup()

void gnss8_cfg_setup ( gnss8_cfg_t cfg)

GNSS 8 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See gnss8_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ gnss8_generic_read()

err_t gnss8_generic_read ( gnss8_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
[out]data_buf: Output read data.
[in]max_len: Number of bytes to be read.
Returns
  • >0 - Number of data bytes read,
  • <=0 - Error/Empty Ring buffer.
See #err_t definition for detailed explanation.
Note
None.

◆ gnss8_generic_write()

err_t gnss8_generic_write ( gnss8_t ctx,
char *  data_buf,
uint16_t  len 
)

Data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
[in]data_buf: Data buffer for sending.
[in]len: Number of bytes for sending.
Returns
  • >=0 - Success,
  • <0 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ gnss8_get_int()

uint8_t gnss8_get_int ( gnss8_t ctx)

Get interrupt pin state.

This function reads interrupt pin to logic 1/0.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
Returns
Pin state.

◆ gnss8_get_rdy()

uint8_t gnss8_get_rdy ( gnss8_t ctx)

Get ready pin state.

This function reads ready pin to logic 1/0.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
Returns
Pin state.

◆ gnss8_get_req()

uint8_t gnss8_get_req ( gnss8_t ctx)

Get request pin state.

This function reads request pin to logic 1/0.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
Returns
Pin state.

◆ gnss8_init()

err_t gnss8_init ( gnss8_t ctx,
gnss8_cfg_t cfg 
)

GNSS 8 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters
[out]ctx: Click context object. See gnss8_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See gnss8_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error.
See #err_t definition for detailed explanation.
Note
None.

◆ gnss8_set_ap_req()

void gnss8_set_ap_req ( gnss8_t ctx,
uint8_t  state 
)

Set AP request pin state.

This function sets AP request pin to logic 1/0.

Parameters
[in]ctx: Click context object. See gnss8_t object definition for detailed explanation.
Returns
Nothing.