iqrf 2.0.0.0
Public function

Functions

void iqrf_cfg_setup (iqrf_cfg_t *cfg)
 Config Object Initialization function.
 
IQRF_RETVAL iqrf_init (iqrf_t *ctx, iqrf_cfg_t *cfg)
 Initialization function.
 
void iqrf_default_cfg (iqrf_t *ctx)
 Click Default Configuration function.
 
void iqrf_generic_multi_write (iqrf_t *ctx, char *data_buf, uint8_t len)
 Generic multi write function.
 
void iqrf_generic_multi_read (iqrf_t *ctx, char *data_buf, uint8_t len)
 Generic multi read function.
 
char iqrf_generic_single_read (iqrf_t *ctx)
 Generic single read function.
 
void iqrf_generic_single_write (iqrf_t *ctx, char tx_data)
 Generic single write function.
 
uint8_t iqrf_get_interrupt (iqrf_t *ctx)
 Interrupt function.
 
void iqrf_hw_reset (iqrf_t *ctx)
 Hardware reset function.
 

Detailed Description

Function Documentation

◆ iqrf_cfg_setup()

void iqrf_cfg_setup ( iqrf_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.

◆ iqrf_default_cfg()

void iqrf_default_cfg ( iqrf_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for iqRF click.

Note

Click default configuration:

   Hardware reset.

◆ iqrf_generic_multi_read()

void iqrf_generic_multi_read ( iqrf_t * ctx,
char * data_buf,
uint8_t len )

Generic multi read function.

Parameters
ctxClick object.
data_bufOutput data buffer.
lenNumber of the bytes in data buffer.

@description This function reads data.

◆ iqrf_generic_multi_write()

void iqrf_generic_multi_write ( iqrf_t * ctx,
char * data_buf,
uint8_t len )

Generic multi write function.

Parameters
ctxClick object.
data_bufInput data buffer
lenNumber of the bytes in the data buffer

@description This function writes data.

◆ iqrf_generic_single_read()

char iqrf_generic_single_read ( iqrf_t * ctx)

Generic single read function.

Parameters
ctxClick object.
Returns
one byte data

@description This function read one byte data.

◆ iqrf_generic_single_write()

void iqrf_generic_single_write ( iqrf_t * ctx,
char tx_data )

Generic single write function.

Parameters
ctxClick object.
tx_dataInput data

@description This function write one byte data.

◆ iqrf_get_interrupt()

uint8_t iqrf_get_interrupt ( iqrf_t * ctx)

Interrupt function.

Parameters
ctxClick object.

@return INT pin state

   0 - No active interrupt.
   1 - Active interrupt.

@description This function checks if interrupt is active.

◆ iqrf_hw_reset()

void iqrf_hw_reset ( iqrf_t * ctx)

Hardware reset function.

Parameters
ctxClick object.

@description This function performs hardware reset.

◆ iqrf_init()

IQRF_RETVAL iqrf_init ( iqrf_t * ctx,
iqrf_cfg_t * cfg )

Initialization function.

Parameters
iqrfClick object.
cfgClick configuration structure.

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