Public function

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

Detailed Description

Function Documentation

airq5_get_interrupt()

uint8_t airq5_get_interrupt

(

airquality5_t *

ctx

)

Functions for reads interrupt pin.

Parameters

ctx	Click 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

ctx	Click object.
reg	Register 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

ctx	Click object.
channel_data	Data 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

ctx	Click object.
config	Register 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

ctx	Click object.
reg	Register in which the data will be written.
data_buf	Output data buf.
data_b	Data 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

cfg	Click 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

ctx	Click 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

ctx	Click object.
reg	Register address.
data_buf	Output data buf
len	Number 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

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number 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

ctx	Click object.
cfg	Click configuration structure.

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