airquality5  2.0.0.0
Functions

Functions

void airquality5_cfg_setup (airquality5_cfg_t *cfg)
 Config Object Initialization function. More...
 
AIRQUALITY5_RETVAL airquality5_init (airquality5_t *ctx, airquality5_cfg_t *cfg)
 Initialization function. More...
 
void airquality5_default_cfg (airquality5_t *ctx)
 Click Default Configuration function. More...
 
void airquality5_generic_write (airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function. More...
 
void airquality5_generic_read (airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
void airq5_write_data (airquality5_t *ctx, uint8_t reg, uint16_t data_b)
 Functions for write data in register. More...
 
uint16_t airq5_read_data (airquality5_t *ctx, uint8_t reg)
 Functions for read data from register. More...
 
void airq5_set_configuration (airquality5_t *ctx, uint16_t config)
 Functions for configuration. More...
 
uint16_t airq5_read_sensor_data (airquality5_t *ctx, uint16_t channel_data)
 Functions for read sensor data. More...
 
uint8_t airq5_get_interrupt (airquality5_t *ctx)
 Functions for reads interrupt pin. More...
 

Detailed Description

Function Documentation

◆ airq5_get_interrupt()

uint8_t airq5_get_interrupt ( airquality5_t ctx)

Functions for reads interrupt pin.

Parameters
ctxClick object.

@description This functions for reads interrupt pin.

◆ airq5_read_data()

uint16_t airq5_read_data ( airquality5_t ctx,
uint8_t  reg 
)

Functions for read data from register.

Parameters
ctxClick object.
regRegister from which will be read.

@description This function when you need to reads data from the register.

◆ airq5_read_sensor_data()

uint16_t airq5_read_sensor_data ( airquality5_t ctx,
uint16_t  channel_data 
)

Functions for read sensor data.

Parameters
ctxClick object.
channel_dataData which be reads.

@description This functions for read sensor data.

◆ airq5_set_configuration()

void airq5_set_configuration ( airquality5_t ctx,
uint16_t  config 
)

Functions for configuration.

Parameters
ctxClick object.
configRegister from which will be read.

@description This functions sets configuration.

◆ airq5_write_data()

void airq5_write_data ( airquality5_t ctx,
uint8_t  reg,
uint16_t  data_b 
)

Functions for write data in register.

Parameters
ctxClick object.
regRegister in which the data will be written.
data_bufOutput data buf.
data_bData which be written in the register.

@description This function when you need to written data into the register.

◆ airquality5_cfg_setup()

void airquality5_cfg_setup ( airquality5_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.

◆ airquality5_default_cfg()

void airquality5_default_cfg ( airquality5_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Airquality5 click.

◆ airquality5_generic_read()

void airquality5_generic_read ( airquality5_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ airquality5_generic_write()

void airquality5_generic_write ( airquality5_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ airquality5_init()

AIRQUALITY5_RETVAL airquality5_init ( airquality5_t ctx,
airquality5_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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