ozone2 2.0.0.0
Public function

Functions

void ozone2_cfg_setup (ozone2_cfg_t *cfg)
 Config Object Initialization function.
 
err_t ozone2_init (ozone2_t *ctx, ozone2_cfg_t *cfg)
 Initialization function.
 
err_t ozone2_read_signal_voltage (ozone2_t *ctx, float *data_out)
 Measurement Voltage Read function.
 
err_t ozone2_read_measurement (ozone2_t *ctx, uint16_t *data_out)
 Measurement Read function.
 

Detailed Description

Function Documentation

◆ ozone2_cfg_setup()

void ozone2_cfg_setup ( ozone2_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. Be sure that the ADC selection is properly selected.

◆ ozone2_init()

err_t ozone2_init ( ozone2_t * ctx,
ozone2_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.
Returns
0 - Ok, (-1) - Error.

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

Note
The ADC selection should be set before call this function.

◆ ozone2_read_measurement()

err_t ozone2_read_measurement ( ozone2_t * ctx,
uint16_t * data_out )

Measurement Read function.

Parameters
ctxClick object.
data_outOutput measurement level [ppm].
Returns
0 - Ok, (-1) - Error.

@description This function reads the level of the measurement signal voltage and calculates this value to ppm in the range from 10 to 1000 ppm.

◆ ozone2_read_signal_voltage()

err_t ozone2_read_signal_voltage ( ozone2_t * ctx,
float * data_out )

Measurement Voltage Read function.

Parameters
ctxClick object.
data_outOutput voltage value [V].
Returns
0 - Ok, (-1) - Error.

@description This function reads the level of the output measurement voltage.