airquality9  2.0.0.0
Main Page

Air Quality 9 click

Air quality 9 Click is a compact add-on board containing a best-in-class air-quality sensing solution. This board features the ENS160, a digital multi-gas sensor solution based on metal oxide (MOX) technology with four MOx sensor elements from ScioSense. Each sensor element has independent hotplate control to detect a wide range of gases. The ENS160 series features TrueVOC™ air quality detection and supports intelligent algorithms, which calculate CO2 equivalents, TVOC, air quality index (AQI), and perform humidity and temperature compensation. This Click board™ is interface-configurable and characterized by outstanding long-term stability and lifetime.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Mar 2022.
  • Type : I2C/SPI type

Software Support

We provide a library for the Air Quality 9 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Air Quality 9 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of Air Quality 9 click board by reading and displaying outputs such as eCO2, TVOC and AQI in compliance with worldwide IAQ standards.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
airquality9_cfg_t airquality9_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
airquality9_cfg_setup( &airquality9_cfg );
AIRQUALITY9_MAP_MIKROBUS( airquality9_cfg, MIKROBUS_1 );
err_t init_flag = airquality9_init( &airquality9, &airquality9_cfg );
if ( ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( AIRQUALITY9_ERROR == airquality9_default_cfg ( &airquality9 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Waits for the new data interrupt which triggers once per second,

and then reads the validity status, TVOC, eCO2, and AQI-UBA values. All values are being displayed on the USB UART where you can track their changes.

void application_task ( void )
{
if ( airquality9_get_int_pin ( &airquality9 ) )
{
uint8_t status, aqi_uba;
uint16_t tvoc, eco2;
if ( AIRQUALITY9_OK == airquality9_read_status ( &airquality9, &status ) )
{
}
if ( AIRQUALITY9_OK == airquality9_read_tvoc ( &airquality9, &tvoc ) )
{
log_printf ( &logger, " TVOC: %u ppb\r\n", tvoc );
}
if ( AIRQUALITY9_OK == airquality9_read_eco2 ( &airquality9, &eco2 ) )
{
log_printf ( &logger, " ECO2: %u ppm\r\n", eco2 );
}
if ( AIRQUALITY9_OK == airquality9_read_aqi_uba ( &airquality9, &aqi_uba ) )
{
}
}
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.AirQuality9

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. UART terminal is available in all MikroElektronika compilers.


AIRQUALITY9_MAP_MIKROBUS
#define AIRQUALITY9_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: airquality9.h:186
airquality9_cfg_setup
void airquality9_cfg_setup(airquality9_cfg_t *cfg)
Air Quality 9 configuration object setup function.
AIRQUALITY9_ERROR
@ AIRQUALITY9_ERROR
Definition: airquality9.h:271
airquality9_display_aqi_uba
void airquality9_display_aqi_uba(uint8_t aqi_uba)
Air Quality 9 display aqi uba function.
Definition: main.c:149
airquality9_default_cfg
err_t airquality9_default_cfg(airquality9_t *ctx)
Air Quality 9 default configuration function.
airquality9_get_int_pin
uint8_t airquality9_get_int_pin(airquality9_t *ctx)
Air Quality 9 get int pin function.
AIRQUALITY9_OK
@ AIRQUALITY9_OK
Definition: airquality9.h:270
airquality9_read_eco2
err_t airquality9_read_eco2(airquality9_t *ctx, uint16_t *eco2)
Air Quality 9 read eco2 function.
application_task
void application_task(void)
Definition: main.c:85
airquality9_read_status
err_t airquality9_read_status(airquality9_t *ctx, uint8_t *status)
Air Quality 9 read status function.
airquality9_read_tvoc
err_t airquality9_read_tvoc(airquality9_t *ctx, uint16_t *tvoc)
Air Quality 9 read tvoc function.
airquality9_display_status_validity
void airquality9_display_status_validity(uint8_t status)
Air Quality 9 display status validity function.
Definition: main.c:122
application_init
void application_init(void)
Definition: main.c:48
airquality9_init
err_t airquality9_init(airquality9_t *ctx, airquality9_cfg_t *cfg)
Air Quality 9 initialization function.
airquality9_cfg_t
Air Quality 9 Click configuration object.
Definition: airquality9.h:243
airquality9_read_aqi_uba
err_t airquality9_read_aqi_uba(airquality9_t *ctx, uint8_t *aqi_uba)
Air Quality 9 read aqi uba function.
airquality9_s
Air Quality 9 Click context object.
Definition: airquality9.h:221