English | 简体中文 | 繁體中文 | 日本語 | Deutsch | 한국어
The CCS811 is an ultra-low power digital gas sensor solution which integrates a metal oxide (MOX) gas sensor to detect a wide range of Volatile Organic Compounds (VOCs) for indoor air quality monitoring with a microcontroller unit (MCU), which includes an Analog-to-Digital converter (ADC), and an I²C interface. CCS811 is based on ams unique micro-hotplate technology which enables a highly reliable solution for gas sensors, very fast cycle times and a significant reduction in average power consumption. The integrated MCU manages the sensor drive modes and raw sensor data measured while detecting VOCs. The I²C digital interface significantly simplifies the hardware and software design, enabling a faster time to market. CCS811 supports intelligent algorithms to process raw sensor measurements to output a TVOC value or equivalent CO2 (eCO2) levels, where the main cause of VOCs is from humans. CCS811 supports multiple measurement modes that have been optimized for low-power consumption during an active sensor measurement and idle mode extending battery life in portable applications. CCS811 is available in a 10 lead 2.7mm x 4.0mm x 1.1mm, 0.6mm pitch LGA package.
LibDriver CCS811 is a full-featured driver of CCS811 launched by LibDriver.It provides TVOC, eCO2 reading, temperature and humidity correction and other functions. LibDriver is MISRA compliant.
/src includes LibDriver CCS811 source files.
/interface includes LibDriver CCS811 IIC platform independent template.
/test includes LibDriver CCS811 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver CCS811 sample code.
/doc includes LibDriver CCS811 offline document.
/datasheet includes CCS811 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
Reference /interface IIC platform independent template and finish your platform IIC driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#include "driver_ccs811_basic.h"
uint8_t res;
uint8_t id;
uint8_t version;
uint8_t major;
uint8_t minor;
uint8_t trivial;
uint8_t status;
uint32_t i;
uint16_t baseline = 0;
float temperature = 25.0f;
float humidity = 50.0f;
/* init */
res = ccs811_basic_init(CCS811_ADDRESS_GND);
if (res != 0)
{
return 1;
}
/* delay 5000ms */
ccs811_interface_delay_ms(5000);
...
/* loop */
for (i = 0; i < 3; i++)
{
uint16_t eco2_ppm;
uint16_t tvoc_ppb;
/* read data */
res = ccs811_basic_read((uint16_t *)&eco2_ppm, (uint16_t *)&tvoc_ppb);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: %d/%d.\n", (uint32_t)(i + 1), (uint32_t)3);
ccs811_interface_debug_print("ccs811: co2 eq is %d ppm.\n", eco2_ppm);
ccs811_interface_debug_print("ccs811: tvoc is %d ppb.\n", tvoc_ppb);
/* delay 1000ms */
ccs811_interface_delay_ms(1000);
...
}
...
/* loop */
for (i = 0; i < 3; i++)
{
uint8_t ua;
float adc_v;
/* read data */
res = ccs811_basic_get_raw_data(&ua, &adc_v);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: %d/%d.\n", (uint32_t)(i + 1), (uint32_t)3);
ccs811_interface_debug_print("ccs811: ua is %duA.\n", ua);
ccs811_interface_debug_print("ccs811: adc is %.02fV.\n", adc_v);
/* delay 1000ms */
ccs811_interface_delay_ms(1000);
...
}
...
/* set environment data */
res = ccs811_basic_set_environment_data(humidity, temperature);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: set humidity %.02f%%.\n", humidity);
ccs811_interface_debug_print("ccs811: set temperature %.02fC.\n", temperature);
...
/* set baseline */
res = ccs811_basic_set_baseline(baseline);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: set baseline %d.\n", baseline);
...
/* get hardware id */
res = ccs811_basic_get_hardware_id(&id);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: hardware id is 0x%02X.\n", id);
...
/* get hardware version */
res = ccs811_basic_get_hardware_version(&version);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: hardware version is 0x%02X.\n", version);
...
/* get firmware bootloader version */
res = ccs811_basic_get_firmware_bootloader_version(&major, &minor, &trivial);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: firmware bootloader version major is 0x%02X.\n", major);
ccs811_interface_debug_print("ccs811: firmware bootloader version minor is 0x%02X.\n", minor);
ccs811_interface_debug_print("ccs811: firmware bootloader version trivial is 0x%02X.\n", trivial);
...
/* get firmware application version */
res = ccs811_basic_get_firmware_application_version(&major, &minor, &trivial);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: firmware application version major is 0x%02X.\n", major);
ccs811_interface_debug_print("ccs811: firmware application version minor is 0x%02X.\n", minor);
ccs811_interface_debug_print("ccs811: firmware application version trivial is 0x%02X.\n", trivial);
...
/* get status */
res = ccs811_basic_get_status(&status);
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: status is 0x%02X.\n", status);
...
/* soft reset */
res = ccs811_basic_soft_reset();
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: soft reset.\n");
...
/* hard reset */
res = ccs811_basic_hard_reset();
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: hard reset.\n");
...
/* wake up */
res = ccs811_basic_wake_up();
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: wake up.\n");
...
/* power down */
res = ccs811_basic_power_down();
if (res != 0)
{
(void)ccs811_basic_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: power down.\n");
...
/* deinit */
(void)ccs811_basic_deinit();
return 0;#include "driver_ccs811_update.h"
uint8_t res;
char path[33] = "update.bin";
/* init */
res = ccs811_update_init(CCS811_ADDRESS_GND);
if (res != 0)
{
return 1;
}
...
/* output */
ccs811_interface_debug_print("ccs811: start updating.\n");
/* update */
res = ccs811_update_firmware(path);
if (res != 0)
{
(void)ccs811_update_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: end updating.\n");
...
/* deinit */
(void)ccs811_update_deinit();
return 0;#include "driver_ccs811_interrupt.h"
uint8_t res;
uint32_t i;
uint8_t hysteresis = 2;
uint16_t high = 500;
uint16_t low = 200;
uint8_t (*g_gpio_irq)(void) = NULL;
static uint8_t a_callback(void)
{
ccs811_interface_debug_print("ccs811: threshold irq.\n");
return 0;
}
/* init */
gpio_interrupt_init();
g_gpio_irq = a_callback;
res = ccs811_interrupt_init(CCS811_ADDRESS_GND, low, high, hysteresis);
if (res != 0)
{
g_gpio_irq = NULL;
(void)gpio_interrupt_deinit();
return 1;
}
/* delay 5000ms */
ccs811_interface_delay_ms(5000);
...
/* loop */
for (i = 0; i < 3; i++)
{
uint16_t eco2_ppm;
uint16_t tvoc_ppb;
/* read data */
res = ccs811_interrupt_read((uint16_t *)&eco2_ppm, (uint16_t *)&tvoc_ppb);
if (res != 0)
{
g_gpio_irq = NULL;
(void)gpio_interrupt_deinit();
(void)ccs811_interrupt_deinit();
return 1;
}
/* output */
ccs811_interface_debug_print("ccs811: %d/%d.\n", (uint32_t)(i + 1), (uint32_t)3);
ccs811_interface_debug_print("ccs811: co2 eq is %d ppm.\n", eco2_ppm);
ccs811_interface_debug_print("ccs811: tvoc is %d ppb.\n", tvoc_ppb);
/* delay 1000ms */
ccs811_interface_delay_ms(1000);
...
}
...
/* deinit */
g_gpio_irq = NULL;
(void)gpio_interrupt_deinit();
(void)ccs811_interrupt_deinit();
return 0;Online documents: https://www.libdriver.com/docs/ccs811/index.html.
Offline documents: /doc/html/index.html.
Please refer to CONTRIBUTING.md.
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Please send an e-mail to lishifenging@outlook.com.