CircuitPython library for CCS811 air quality sensor.
Project description
Adafruit CircuitPython CCS811 Library
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.
Usage Notes
See the guide for wiring and installation instructions.
Of course, you must import the library to use it:
import busio
import adafruit_ccs811Next, 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)Contributing
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-toolsOnce installed, make sure you are in the virtual environment:
source .env/bin/activateThen 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-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis 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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-ccs811-1.1.6.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-ccs811-1.1.6.tar.gz
- Upload date:
- Size: 23.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dc552d7377943d602b2df64edaf3c7ee6c5dd73917f40c54e7dd6ce1c851c38b |
|
| MD5 | b62553172e5c02eabc0714db86593119 |
|
| BLAKE2b-256 | fcda1144f88155efef3e6a026a75bafd8f0ea73f9acdb2ab01124f7b838ece61 |
