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.11.tar.gz (31.5 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-ccs811-1.3.11.tar.gz
Algorithm Hash digest
SHA256 65d0183ba2990b26a65b84a18691135a4c93f409b94319fd7341b3eb3201c77b
MD5 21f6af1f5798fa13c4b05995ed368050
BLAKE2b-256 ef8aaa3ae9e785175e9829bbbeb293f7e06d7d871aec752f11014ad855f027b2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ccs811-1.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 8e603cebc3b1f89b1b8d67b7d3d837e850714ff5826f1160502907732cdfe862
MD5 0063c5ffa510e37474d43646eb3f5897
BLAKE2b-256 05f26138c1b8e18a378aa0fc3ae6ca20f9ec6087215784fe694e6a5910e51863

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