microwave  2.0.0.0
Functions
Public Function

Functions

void microwave_cfg_setup (microwave_cfg_t *cfg)
 Configuration Object Setup function. More...
 
microwave_err_t microwave_init (microwave_t *ctx, microwave_cfg_t *cfg)
 Click Initialization function. More...
 
microwave_data_t microwave_generic_read (microwave_t *ctx)
 Generic ADC Read function. More...
 

Detailed Description

Function Documentation

◆ microwave_cfg_setup()

void microwave_cfg_setup ( microwave_cfg_t cfg)

Configuration Object Setup function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to initial state.

Note
All used pins will be set to unconnected state and AD conversion configuration will be set to default value using channel 3 on the MIKROBUS 1. ADC will be set to 12-bit resolution using external VREF by default.

◆ microwave_generic_read()

microwave_data_t microwave_generic_read ( microwave_t ctx)

Generic ADC Read function.

Parameters
ctxClick object.
Returns
Result of the AD conversion.

This function allows the ADC data reading from the selected channel.

◆ microwave_init()

microwave_err_t microwave_init ( microwave_t ctx,
microwave_cfg_t cfg 
)

Click Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.
Returns
0x0 - Ok, 0xFF - ADC init error.

This function initializes the AD conversion.