airquality11  2.1.0.0
Main Page

Air Quality 11 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Jan 2024.
  • Type : I2C/SPI type

Software Support

We provide a library for the Air Quality 11 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 11 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of the Air Quality 11 Click board by reading and displaying the calculated Air Quality Index according to the UBA and ScioSense, and equivalent TVOC and CO2 concentration.

The demo application is composed of two sections :

Application Init

The initialization of I2C and SPI module and log UART. After driver initialization, the app sets the default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
airquality11_cfg_t airquality11_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
airquality11_cfg_setup( &airquality11_cfg );
AIRQUALITY11_MAP_MIKROBUS( airquality11_cfg, MIKROBUS_1 );
err_t init_flag = airquality11_init( &airquality11, &airquality11_cfg );
if ( ( I2C_MASTER_ERROR == init_flag ) || ( SPI_MASTER_ERROR == init_flag ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( AIRQUALITY11_ERROR == airquality11_default_cfg ( &airquality11 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
log_printf( &logger, "---------------------------\r\n " );
Delay_ms( 100 );
}

Application Task

The demo application displays the Air Quality Index of the UBA information, concentration of the TVOC and CO2 and Air Quality Index according to ScioSense. Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void )
{
uint8_t aqi_uba = 0;
uint16_t aq_data = 0;
if ( AIRQUALITY11_OK == airquality11_get_aqi_uba( &airquality11, &aqi_uba ) )
{
Delay_ms( 100 );
}
if ( AIRQUALITY11_OK == airquality11_get_tvoc( &airquality11, &aq_data ) )
{
log_printf( &logger, " TVOC: %u [ppb]\r\n", aq_data );
Delay_ms( 100 );
}
if ( AIRQUALITY11_OK == airquality11_get_co2( &airquality11, &aq_data ) )
{
log_printf( &logger, " ECO2: %u [ppm]\r\n", aq_data );
Delay_ms( 100 );
}
if ( AIRQUALITY11_OK == airquality11_get_aqi_s( &airquality11, &aq_data ) )
{
log_printf( &logger, " AQIS: %u [idx]\r\n", aq_data );
Delay_ms( 100 );
}
log_printf( &logger, "---------------------------\r\n " );
Delay_ms( 1000 );
}

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.AirQuality11

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.


airquality11_get_tvoc
err_t airquality11_get_tvoc(airquality11_t *ctx, uint16_t *tvoc_ppb)
Air Quality 11 get TVOC function.
airquality11_get_co2
err_t airquality11_get_co2(airquality11_t *ctx, uint16_t *co2_ppm)
Air Quality 11 get CO2 function.
airquality11_get_aqi_uba
err_t airquality11_get_aqi_uba(airquality11_t *ctx, uint8_t *aqi_uba)
Air Quality 11 get AQI-UBA function.
application_task
void application_task(void)
Definition: main.c:84
airquality11_cfg_setup
void airquality11_cfg_setup(airquality11_cfg_t *cfg)
Air Quality 11 configuration object setup function.
airquality11_display_aqi_uba
void airquality11_display_aqi_uba(uint8_t aqi_uba)
Air Quality 11 display AQI-UBA function.
Definition: main.c:129
airquality11_cfg_t
Air Quality 11 Click configuration object.
Definition: airquality11.h:231
airquality11_get_aqi_s
err_t airquality11_get_aqi_s(airquality11_t *ctx, uint16_t *aqi_s)
Air Quality 11 get AQI-S function.
airquality11_default_cfg
err_t airquality11_default_cfg(airquality11_t *ctx)
Air Quality 11 default configuration function.
application_init
void application_init(void)
Definition: main.c:45
airquality11_init
err_t airquality11_init(airquality11_t *ctx, airquality11_cfg_t *cfg)
Air Quality 11 initialization function.
AIRQUALITY11_ERROR
@ AIRQUALITY11_ERROR
Definition: airquality11.h:259
AIRQUALITY11_OK
@ AIRQUALITY11_OK
Definition: airquality11.h:258
AIRQUALITY11_MAP_MIKROBUS
#define AIRQUALITY11_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: airquality11.h:170
airquality11_s
Air Quality 11 Click context object.
Definition: airquality11.h:206