Adafruit CircuitPython CCS811 Library¶
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.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-ccs811
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-ccs811
To install in a virtual environment in your current project:
mkdir project-name && cd project-name python3 -m venv .venv source .venv/bin/activate pip3 install adafruit-circuitpython-ccs811
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 = board.I2C() # uses board.SCL and board.SDA
Once you have created the I2C interface object, you can use it to instantiate the CCS811 object
ccs = adafruit_ccs811.CCS811(i2c)
To read the gas sensor simply read the attributes:
print("CO2: ", ccs.eco2, " TVOC:", ccs.tvoc)
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.