iqrf2  2.0.0.0
Functions
Public function

Functions

void iqrf2_cfg_setup (iqrf2_cfg_t *cfg)
 Config Object Initialization function. More...
 
IQRF2_RETVAL iqrf2_init (iqrf2_t *ctx, iqrf2_cfg_t *cfg)
 Initialization function. More...
 
void iqrf2_generic_write (iqrf2_t *ctx, char *data_buf, uint16_t len)
 Generic write function. More...
 
int32_t iqrf2_generic_read (iqrf2_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function. More...
 

Detailed Description

Function Documentation

◆ iqrf2_cfg_setup()

void iqrf2_cfg_setup ( iqrf2_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ iqrf2_generic_read()

int32_t iqrf2_generic_read ( iqrf2_t ctx,
char *  data_buf,
uint16_t  max_len 
)

Generic read function.

Parameters
ctxClick object.
data_bufData buffer for read data.
max_lenThe maximum length of data that can be read.
Returns
Number of reads data.

◆ iqrf2_generic_write()

void iqrf2_generic_write ( iqrf2_t ctx,
char *  data_buf,
uint16_t  len 
)

Generic write function.

Parameters
ctxClick object.
data_bufData buffer for sends.
lenNumber of bytes for sends.

◆ iqrf2_init()

IQRF2_RETVAL iqrf2_init ( iqrf2_t ctx,
iqrf2_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.