Adafruit CircuitPython CCS811 Library

Documentation Status Discord Build Status

CircuitPython driver for the CCS811 air quality sensor.


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Notes

See the guide for wiring and installation instructions.

Of course, you must import the library to use it:

import busio
import adafruit_ccs811

Next, initialize the I2C bus object.

from board import *
i2c_bus = busio.I2C(SCL, SDA)

Once you have created the I2C interface object, you can use it to instantiate the CCS811 object

ccs =  adafruit_ccs811.CCS811(i2c_bus)

Reading Sensor

To read the gas sensor simply read the attributes:

print("CO2: ", ccs.eco2, " TVOC:", ccs.tvoc)


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you’ll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ccs811 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

Indices and tables