airquality5  2.0.0.0
Main Page

Air quality 5 click

Air quality 5 click is a triple MOS sensor on a single Click boardâ„¢, which can detect gas pollution for a number of different gases. The onboard sensor is specially designed to detect the pollution from automobile exhausts, as well as the gas pollution from the industrial or agricultural industry.

click Product page


Click library

  • Author : MikroE Team
  • Date : dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Airquality5 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Airquality5 Click driver.

Standard key functions :

Example key functions :

  • Functions for write data in register.

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

  • Functions for read data from register.

    uint16_t airq5_read_data ( airquality5_t *ctx, uint8_t reg );

  • Functions for configuration.

    void airq5_set_configuration ( airquality5_t *ctx, uint16_t config );

Examples Description

This application can detect gas pollution for a number of different gases.

The demo application is composed of two sections :

Application Init

Initializes device and configuration chip.

void application_init ( void )
{
log_cfg_t log_cfg;
airquality5.data_config = 0x8583;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
AIRQUALITY5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
airquality5_init( &airquality5, &cfg );
}

Application Task

Reads the values of CO, NH3 and NO2 sensor and logs data on USBUART every 500ms.

void application_task ( void )
{
uint16_t NO2_sensor_data;
uint16_t NH3_sensor_data;
uint16_t CO_sensor_data;
CO_sensor_data = airq5_read_sensor_data( &airquality5, AIRQ5_DATA_CHANNEL_CO );
NO2_sensor_data = airq5_read_sensor_data( &airquality5, AIRQ5_DATA_CHANNEL_NO2 );
log_printf( &logger, " NO2 data: %d\r\n", NO2_sensor_data );
NH3_sensor_data = airq5_read_sensor_data( &airquality5, AIRQ5_DATA_CHANNEL_NH3 );
log_printf( &logger, " NH3 data: %d\r\n", NH3_sensor_data );
CO_sensor_data = airq5_read_sensor_data( &airquality5, AIRQ5_DATA_CHANNEL_CO );
log_printf( &logger," CO data: %d\r\n", CO_sensor_data );
log_printf( &logger, " -------- ");
Delay_ms( 200 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Airquality5

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


application_task
void application_task(void)
Definition: main.c:58
airquality5_init
AIRQUALITY5_RETVAL airquality5_init(airquality5_t *ctx, airquality5_cfg_t *cfg)
Initialization function.
AIRQ5_DATA_CHANNEL_NO2
#define AIRQ5_DATA_CHANNEL_NO2
Definition: airquality5.h:72
application_init
void application_init(void)
Definition: main.c:32
airquality5_cfg_setup
void airquality5_cfg_setup(airquality5_cfg_t *cfg)
Config Object Initialization function.
airq5_read_sensor_data
uint16_t airq5_read_sensor_data(airquality5_t *ctx, uint16_t channel_data)
Functions for read sensor data.
airquality5_cfg_t
Click configuration structure definition.
Definition: airquality5.h:195
AIRQUALITY5_MAP_MIKROBUS
#define AIRQUALITY5_MAP_MIKROBUS(cfg, mikrobus)
Definition: airquality5.h:52
AIRQ5_DATA_CHANNEL_CO
#define AIRQ5_DATA_CHANNEL_CO
Definition: airquality5.h:74
AIRQ5_DATA_CHANNEL_NH3
#define AIRQ5_DATA_CHANNEL_NH3
Definition: airquality5.h:73