co2  2.0.0.0
Main Page

CO 2 click

CO 2 click is a very accurate, carbon-monoxide-gas-sensor Click boardâ„¢, equipped with the SPEC amperometric,3SP CO 1000 gas sensor which electrochemically reacts with the carbon monoxide (CO).

click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void co2_cfg_setup ( co2_cfg_t *cfg );

  • Initialization function.

    CO2_RETVAL co2_init ( co2_t *ctx, co2_cfg_t *cfg );

Example key functions :

Examples Description

This application enables usage of very accurate CO sensor.

The demo application is composed of two sections :

Application Init

Initializes I2C interface and performs the device configuration for properly working.

void application_init ( void )
{
log_cfg_t log_cfg;
co2_cfg_t cfg;
uint8_t temp_w;
// Logger initialization.
log_cfg.level = LOG_LEVEL_DEBUG;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
co2_cfg_setup( &cfg );
CO2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
co2_init( &co2, &cfg );
Delay_ms( 500 );
temp_w = CO2_WRITE_MODE;
co2_generic_write( &co2, CO2_LOCK_REG, &temp_w, 1 );
temp_w = CO2_STANDBY_MODE;
co2_generic_write( &co2, CO2_MODECN_REG, &temp_w, 1 );
co2_generic_write( &co2, CO2_TIACN_REG, &temp_w, 1 );
co2_generic_write( &co2, CO2_REFCN_REG, &temp_w, 1 );
log_printf( &logger, "CO 2 is initialized\r\n\r\n" );
Delay_ms( 1000 );
}

Application Task

Gets CO (Carbon Monoxide) data as ppm value every 300 miliseconds. Results will be logged on UART. The CO value range is from 0 to 1000 ppm.

void application_task ( void )
{
float co2_value;
co2_get_co2_ppm( &co2, &co2_value );
log_printf( &logger, "CO : %.2f ppm\r\n", co2_value );
Delay_ms( 300 );
}

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

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.


co2_get_co2_ppm
void co2_get_co2_ppm(co2_t *ctx, float *co2_data)
Get CO Data function.
CO2_50_PERCENTS_INT_ZERO
#define CO2_50_PERCENTS_INT_ZERO
Definition: co2.h:114
co2_init
CO2_RETVAL co2_init(co2_t *ctx, co2_cfg_t *cfg)
Initialization function.
CO2_MODECN_REG
#define CO2_MODECN_REG
Definition: co2.h:78
CO2_TIACN_REG
#define CO2_TIACN_REG
Definition: co2.h:76
application_task
void application_task(void)
Definition: main.c:68
CO2_VREF_EXT
#define CO2_VREF_EXT
Definition: co2.h:112
CO2_0_PERCENTS_BIAS
#define CO2_0_PERCENTS_BIAS
Definition: co2.h:119
CO2_MAP_MIKROBUS
#define CO2_MAP_MIKROBUS(cfg, mikrobus)
Definition: co2.h:53
CO2_BIAS_POL_NEGATIVE
#define CO2_BIAS_POL_NEGATIVE
Definition: co2.h:117
CO2_STANDBY_MODE
#define CO2_STANDBY_MODE
Definition: co2.h:143
co2_wait_i2c_ready
void co2_wait_i2c_ready(co2_t *ctx)
Generic read function.
application_init
void application_init(void)
Definition: main.c:34
CO2_REFCN_REG
#define CO2_REFCN_REG
Definition: co2.h:77
CO2_LOCK_REG
#define CO2_LOCK_REG
Definition: co2.h:75
CO2_3500_OHM_TIA_RES
#define CO2_3500_OHM_TIA_RES
Definition: co2.h:95
CO2_100_OHM_LOAD_RES
#define CO2_100_OHM_LOAD_RES
Definition: co2.h:104
co2_cfg_setup
void co2_cfg_setup(co2_cfg_t *cfg)
Config Object Initialization function.
CO2_WRITE_MODE
#define CO2_WRITE_MODE
Definition: co2.h:85
co2_generic_write
uint8_t co2_generic_write(co2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
co2_cfg_t
Click configuration structure definition.
Definition: co2.h:197