microwave2 2.0.0.0

Functions

void microwave2_cfg_setup (microwave2_cfg_t *cfg)
 Config Object Initialization function.
 
MICROWAVE2_RETVAL microwave2_init (microwave2_t *ctx, microwave2_cfg_t *cfg)
 Initialization function.
 
void microwave2_generic_multi_write (microwave2_t *ctx, char *data_buf, uint8_t len)
 Generic multi write function.
 
int32_t microwave2_generic_read (microwave2_t *ctx, char *data_buf, uint16_t max_len)
 Generic read function.
 
char microwave2_generic_single_read (microwave2_t *ctx)
 Generic single read function.
 
void microwave2_generic_single_write (microwave2_t *ctx, char tx_data)
 Generic single write function.
 
uint8_t microwave2_da_state (microwave2_t *ctx)
 Set pin DA.
 
uint8_t microwave2_dl_state (microwave2_t *ctx)
 Set pin DL.
 

Detailed Description

Function Documentation

◆ microwave2_cfg_setup()

void microwave2_cfg_setup ( microwave2_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.

◆ microwave2_da_state()

uint8_t microwave2_da_state ( microwave2_t * ctx)

Set pin DA.

Parameters
ctxClick object.

@description This pin will be set to 1 if the object is aproaching.

◆ microwave2_dl_state()

uint8_t microwave2_dl_state ( microwave2_t * ctx)

Set pin DL.

Parameters
ctxClick object.

@description This pin will be set to 1 if the object is moving away.

◆ microwave2_generic_multi_write()

void microwave2_generic_multi_write ( microwave2_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.

◆ microwave2_generic_read()

int32_t microwave2_generic_read ( microwave2_t * ctx,
char * data_buf,
uint16_t max_len )

Generic read function.

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

◆ microwave2_generic_single_read()

char microwave2_generic_single_read ( microwave2_t * ctx)

Generic single read function.

Parameters
ctxClick object.
Returns
one byte data

@description This function read one byte data.

◆ microwave2_generic_single_write()

void microwave2_generic_single_write ( microwave2_t * ctx,
char tx_data )

Generic single write function.

Parameters
ctxClick object.
tx_dataInput data

@description This function write one byte data.

◆ microwave2_init()

MICROWAVE2_RETVAL microwave2_init ( microwave2_t * ctx,
microwave2_cfg_t * cfg )

Initialization function.

Parameters
microwave2Click object.
cfgClick configuration structure.

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