Skip to main content

CircuitPython library for CCS811 air quality sensor.

Project description

Adafruit CircuitPython CCS811 Library

Documentation Status Discord Build Status Code Style: Black

CircuitPython driver for the CCS811 air quality sensor.

Dependencies

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

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 = 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)

Reading Sensor

To read the gas sensor simply read the attributes:

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

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-ccs811-1.3.15.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-ccs811-1.3.15.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ccs811-1.3.15.tar.gz
Algorithm Hash digest
SHA256 634d628606bab5a53999b842f681c92b4b8fabb2e8e08bf02497540ffcae2d3a
MD5 53e9d91b9279314cf2edf3b49de3817e
BLAKE2b-256 a92047cc280996cb2ab877074aeeea2fabdf1bea810b31a5d5ca6cc82fdb847b

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ccs811-1.3.15-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ccs811-1.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 f5cd8d5f7e0943680f53438bdbbb27280e41afd77e0bc154da7321fa03fad468
MD5 13fc0ce3f73b2684232269169987de3f
BLAKE2b-256 14149bd62871639b8eac5c5921e903588e8a7818c35ddac189a5289d7ca4ce62

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page