airquality4  2.0.0.0
Functions

Functions

void airquality4_cfg_setup (airquality4_cfg_t *cfg)
 Config Object Initialization function. More...
 
AIRQUALITY4_RETVAL airquality4_init (airquality4_t *ctx, airquality4_cfg_t *cfg)
 Initialization function. More...
 
void airquality4_default_cfg (airquality4_t *ctx)
 Click Default Configuration function. More...
 
void air_quality4_get_id (airquality4_t *ctx, uint8_t *data_buf)
 Get ID function. More...
 
void air_quality4_dev_init (airquality4_t *ctx)
 Initialization function. More...
 
void air_quality4_measure_quality (airquality4_t *ctx, uint8_t *read_air)
 Quality measurment function. More...
 
void air_quality4_get_co2_and_tvoc (airquality4_t *ctx, uint16_t *value)
 Read CO2 and TVOC function. More...
 
void air_quality4_measure_signal (airquality4_t *ctx, uint8_t *read_air)
 Signal measurment function. More...
 
void air_quality4_get_h2_and_ethon (airquality4_t *ctx, uint16_t *value)
 Read H2 and EthOH function. More...
 
void air_quality4_get_baseline (airquality4_t *ctx, uint16_t *read_air)
 Get Baseline function. More...
 
void air_quality4_set_baseline (airquality4_t *ctx)
 Set Baseline function. More...
 
void air_quality4_soft_reset (airquality4_t *ctx)
 Software reset function. More...
 
void air_quality4_get_version (airquality4_t *ctx, uint8_t *version)
 Get version function. More...
 

Detailed Description

Function Documentation

◆ air_quality4_dev_init()

void air_quality4_dev_init ( airquality4_t ctx)

Initialization function.

Parameters
ctxClick object.

@description Function initializes click and starts measurement.

◆ air_quality4_get_baseline()

void air_quality4_get_baseline ( airquality4_t ctx,
uint16_t *  read_air 
)

Get Baseline function.

Parameters
ctxClick object.
read_airData buffer to be written in.

@description Function writes 6 bytes baseline data for the two air quality signals and CRC data for each other to buffer determined by pointer in parametar of function. This data should be stored on an external memory.

◆ air_quality4_get_co2_and_tvoc()

void air_quality4_get_co2_and_tvoc ( airquality4_t ctx,
uint16_t *  value 
)

Read CO2 and TVOC function.

Parameters
ctxClick object.
valueData buffer to be written in.

@description Function writes 2 bytes CO2 data and 2 bytes TVOC data without CRC data to buffer determined by pointer in parametar of functi

◆ air_quality4_get_h2_and_ethon()

void air_quality4_get_h2_and_ethon ( airquality4_t ctx,
uint16_t *  value 
)

Read H2 and EthOH function.

Parameters
ctxClick object.
valueData buffer to be written in.

@description Function writes 2 bytes H2 data and 2 bytes EthOH data without CRC data to buffer determined by pointer in parametar of function.

◆ air_quality4_get_id()

void air_quality4_get_id ( airquality4_t ctx,
uint8_t *  data_buf 
)

Get ID function.

Parameters
ctxClick object.
data_bufData buffer to be written in.

@description Function writes 48-bit ID data to buffer determined by pointer in parametar of function.

◆ air_quality4_get_version()

void air_quality4_get_version ( airquality4_t ctx,
uint8_t *  version 
)

Get version function.

Measure test function.

Parameters
ctxClick object.
versionData buffer to be written in.

@description Function writes chip version data to buffer determined by pointer in parametar of function.

Parameters
ctxClick object.
versionData buffer to be written in.

@description Function writes measurement test data to buffer determined by pointer in parametar of function.

◆ air_quality4_measure_quality()

void air_quality4_measure_quality ( airquality4_t ctx,
uint8_t *  read_air 
)

Quality measurment function.

Parameters
ctxClick object.
read_airData buffer to be written in.

@description Function writes 6 bytes CO2 data (2 bytes) and TVOC data (2 bytes) with CRC data for each other to buffer determined by pointer in parametar of function.

◆ air_quality4_measure_signal()

void air_quality4_measure_signal ( airquality4_t ctx,
uint8_t *  read_air 
)

Signal measurment function.

Parameters
ctxClick object.
read_airData buffer to be written in.

@description Function writes 6 bytes H2 data (2 bytes) and EthOH - Ethanol data (2 bytes) with CRC data for each other to buffer determined by pointer in parametar of function.

◆ air_quality4_set_baseline()

void air_quality4_set_baseline ( airquality4_t ctx)

Set Baseline function.

Parameters
ctxClick object.

@description Function writes 6 bytes baseline data on I2C bus for the two air quality signals and CRC data for each other.

◆ air_quality4_soft_reset()

void air_quality4_soft_reset ( airquality4_t ctx)

Software reset function.

Parameters
ctxClick object.

@description Function calls general reset witch resets all states on the chip and initializes chip again. Function will not reset external memory state.

◆ airquality4_cfg_setup()

void airquality4_cfg_setup ( airquality4_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.

◆ airquality4_default_cfg()

void airquality4_default_cfg ( airquality4_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for AirQuality4 click.

◆ airquality4_init()

AIRQUALITY4_RETVAL airquality4_init ( airquality4_t ctx,
airquality4_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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