Intermediate
30 min

Ensure the air you breathe is of the highest quality using SGP30 and ATmega328P

See the unseen, breathe the pure

Air quality 4 Click with Arduino UNO Rev3

Published Feb 14, 2024

Click board™

Air quality 4 Click

Dev. board

Arduino UNO Rev3

Compiler

NECTO Studio

MCU

ATmega328P

From homes to workplaces, our air quality monitor solution seamlessly integrates into any environment, providing real-time insights for a safer, cleaner lifestyle

A

A

Hardware Overview

How does it work?

Air Quality 4 Click is based on the SGP30 from Sensirion, a multi-pixel gas sensor for indoor applications. This sensor is a system of several metal-oxide sensing elements on a chip (pixels), used to measure and process readings of various gasses in the air and output them in the form of two complementary air quality readings - Total Volatile Organic Compounds (TVOC) [ppb] and CO2 equivalent signal [ppm]. The traditional metal-oxide (MOX) sensors suffer from sensitivity and responsiveness degradation after siloxane exposure. Siloxanes are compounds commonly found in the air, negatively affecting the MOX sensors. To overcome this problem, the SGP30 sensors use the advanced MOXSens® Technology, which provides unmatched robustness against siloxane contamination. This results in unprecedented long-term stability and accuracy. The SGP30 uses a dynamic baseline compensation algorithm and calibration parameters to record TVOC and CO2eq properties accurately. These baseline values of the compensation algorithm

can be stored externally and read back into the device with the appropriate I2C commands and can be used in the event of power down or restart. For the first 15 seconds after the I2C initialization command, the sensor is in an initialization phase of collecting sensor measurements and baseline compensation data. When the measurement command is attempted, it will return fixed values of 400 ppm CO2eq and 0 ppb TVOC. The device also allows air humidity corrections over the results for both the compensated and raw values. However, an absolute humidity sensor should be used for obtaining the humidity reading. Readings from SHT click or similar humidity-measuring devices can be used for this purpose. The appropriate I2C command will store the value in the on-chip memory and perform the corrections accordingly. Additional components on Air Quality 4 clicks are used to provide necessary voltage levels for the SGP30 sensor IC. This sensor has a common voltage level of 1.8V, so to provide proper communication with 3.3V and 5V capable MCUs, a

small LDO voltage regulator has to be used, along with the level shifter, which provides the required logic voltage levels. The SPX3819M5, a small 500mA LDO voltage regulator, provides a power supply of 1.8V for the SGP30. The PCA9306 dual bidirectional I2C bus and SMBus voltage level shifter are used for the level shifting. This level shifter IC allows shifting (converting) the I2C signal levels to the voltage level selected by the VCC SEL onboard SMD jumper. This allows 3.3V and 5V capable MCUs to be interfaced with the Air quality 4 Click. More detailed information about all the available I2C commands can be found in the SGP30 datasheet. However, all the functions and commands necessary to perform air quality readings and functions used to calculate H2 and Ethanol concentration levels are contained within the Air Quality 4 click libraries provided with this click board™. Their usage is demonstrated in the included example application, which can be used as a reference for a custom application design.

Air quality 4 Click top side image
Air quality 4 Click bottom side image

Features overview

Development board

Arduino UNO is a versatile microcontroller board built around the ATmega328P chip. It offers extensive connectivity options for various projects, featuring 14 digital input/output pins, six of which are PWM-capable, along with six analog inputs. Its core components include a 16MHz ceramic resonator, a USB connection, a power jack, an

ICSP header, and a reset button, providing everything necessary to power and program the board. The Uno is ready to go, whether connected to a computer via USB or powered by an AC-to-DC adapter or battery. As the first USB Arduino board, it serves as the benchmark for the Arduino platform, with "Uno" symbolizing its status as the

first in a series. This name choice, meaning "one" in Italian, commemorates the launch of Arduino Software (IDE) 1.0. Initially introduced alongside version 1.0 of the Arduino Software (IDE), the Uno has since become the foundational model for subsequent Arduino releases, embodying the platform's evolution.

Arduino UNO Rev3 double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

AVR

MCU Memory (KB)

32

Silicon Vendor

Microchip

Pin count

28

RAM (Bytes)

2048

You complete me!

Accessories

Click Shield for Arduino UNO has two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the Arduino UNO board without effort. The Arduino Uno, a microcontroller board based on the ATmega328P, provides an affordable and flexible way for users to try out new concepts and build prototypes with the ATmega328P microcontroller from various combinations of performance, power consumption, and features. The Arduino Uno has 14 digital input/output pins (of which six can be used as PWM outputs), six analog inputs, a 16 MHz ceramic resonator (CSTCE16M0V53-R0), a USB connection, a power jack, an ICSP header, and reset button. Most of the ATmega328P microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the Arduino UNO board with our Click Shield for Arduino UNO, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.

Click Shield for Arduino UNO accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PC5
SCL
I2C Data
PC4
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

Air quality 4 Click Schematic schematic

Step by step

Project assembly

Click Shield for Arduino UNO front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Arduino UNO Rev3 as your development board.

Click Shield for Arduino UNO front image hardware assembly
Arduino UNO Rev3 front image hardware assembly
Barometer 13 Click front image hardware assembly
Prog-cut hardware assembly
Arduino UNO Rev3 MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
Arduino UNO MCU Step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for Air Quality 4 Click driver.

Key functions:

  • air_quality4_soft_reset - This function calls general reset witch resets all states on the chip

  • air_quality4_get_co2_and_tvoc - This function writes 2 bytes CO2 data and 2 bytes TVOC data without CRC data

  • air_quality4_get_h2_and_ehtoh - This function writes 2 bytes H2 data and 2 bytes EthOH data without CRC data

Open Source

Code example

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

/*!
 * \file 
 * \brief AirQuality4 Click example
 * 
 * # Description
 * This application measures the amount of substances in air and air quality and logs the results.
 *
 * The demo application is composed of two sections :
 * 
 * ## Application Init 
 * nitializes click driver and gets ID data.
 * 
 * ## Application Task  
 * Performs measurements of air concentracion for H2, EthOH, CO2 and TVOC data.
 * Results of measurement shows on USBUART.
 * 
 * \author MikroE Team
 *
 */
// ------------------------------------------------------------------- INCLUDES

#include "board.h"
#include "log.h"
#include "airquality4.h"

// ------------------------------------------------------------------ VARIABLES

static airquality4_t airquality4;
static log_t logger;
static uint8_t buffer_data[ 6 ];
static uint16_t data_buffer[ 2 ];

// ------------------------------------------------------ APPLICATION FUNCTIONS

void application_init ( void )
{
    log_cfg_t log_cfg;
    airquality4_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    airquality4_cfg_setup( &cfg );
    AIRQUALITY4_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    airquality4_init( &airquality4, &cfg );
    airquality4_default_cfg( &airquality4 );
}

void application_task ( void )
{
    air_quality4_get_h2_and_ethon( &airquality4, data_buffer);

    log_printf( &logger, "H2 value is: %u\n", data_buffer[ 0 ] );
    log_printf( &logger, "EthOH value is:  %u\n", data_buffer[ 1 ] );

    air_quality4_set_baseline( &airquality4 );
    air_quality4_get_co2_and_tvoc( &airquality4, &data_buffer[ 0 ] );
    
    log_printf( &logger, "CO2 value is: %u\n", data_buffer[ 0 ] );
    log_printf( &logger, "TVOC value is: %u\n\n", data_buffer[ 1 ] );

    Delay_ms( 1000 );
}

void main ( void )
{
    application_init( );

    for ( ; ; )
    {
        application_task( );
    }
}


// ------------------------------------------------------------------------ END

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.