ambient  2.0.0.0
Functions
Public function

Functions

void ambient_cfg_setup (ambient_cfg_t *cfg)
 Config Object Initialization function. More...
 
AMBIENT_RETVAL ambient_init (ambient_t *ctx, ambient_cfg_t *cfg)
 Initialization function. More...
 
ambient_data_t ambient_generic_read (ambient_t *ctx)
 Generic read function. More...
 
uint16_t ambient_calculate_light_intensity (ambient_t *ctx, uint16_t adc_data, uint16_t vcc_val, uint16_t adc_res)
 Calculate light intensity function. More...
 

Detailed Description

Function Documentation

◆ ambient_calculate_light_intensity()

uint16_t ambient_calculate_light_intensity ( ambient_t ctx,
uint16_t  adc_data,
uint16_t  vcc_val,
uint16_t  adc_res 
)

Calculate light intensity function.

Parameters
ctxClick object.
adc_data16-bit read ADC data.
vcc_val16-bit VCC value.
adc_res16-bit ADC resolution.

calculate light intensity from ADC data, VCC value and ADC resolution of the Melexis MLX75305 IC on Ambient click board.

◆ ambient_cfg_setup()

void ambient_cfg_setup ( ambient_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ ambient_generic_read()

ambient_data_t ambient_generic_read ( ambient_t ctx)

Generic read function.

Parameters
ctxClick object.
Returns
ADC data

This function read ADC data.

◆ ambient_init()

AMBIENT_RETVAL ambient_init ( ambient_t ctx,
ambient_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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