Skip to main content

Adafruit CircuitPython CCS811 Library

Documentation Status Discord Build Status Code Style: Ruff

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.

Metadata

Release files for adafruit-circuitpython-ccs811 1.3.24

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-ccs811 1.3.24
File Size Uploaded
adafruit_circuitpython_ccs811-1.3.24.tar.gz 25.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-ccs811 1.3.24
File Interpreter ABI Platform
adafruit_circuitpython_ccs811-1.3.24-py3-none-any.whl Python 3 none any Details

Total release size: 32.2 kB

Release files / adafruit_circuitpython_ccs811-1.3.24.tar.gz

Download URL adafruit_circuitpython_ccs811-1.3.24.tar.gz
Size 25.2 kB
Tags Source
SHA-256 checksum
How to use checksums
458cbb0ff9815f7b944bf692ddc7e73a94b04baac62924f1f86074755d7d68d6
BLAKE2b-256 checksum
How to use checksums
b63b1b5afeb706bb077e51a8cff1141e98274120da437eb553552f6595cf2d87
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_ccs811-1.3.24-py3-none-any.whl

Download URL adafruit_circuitpython_ccs811-1.3.24-py3-none-any.whl
Size 7.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
03ccd3125dd246c6db87d92f81984c3c8d754d12853e5b5a26eb9c18dd221615
BLAKE2b-256 checksum
How to use checksums
0679f912a540fbcecf89a6b4e5059dae7fdfdac165e37a9447ee9f97fcb04268
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.3.24 This release

2 release files

1.3.23

2 release files

1.3.22

2 release files

1.3.21

2 release files

1.3.20

2 release files

1.3.19

2 release files

1.3.18

2 release files

1.3.17

2 release files

1.3.16

2 release files

1.3.14

2 release files

1.3.13

2 release files

1.3.12

2 release files

1.3.11

2 release files

1.3.9

1 release file

1.3.8

1 release file

1.3.7

1 release file

1.3.6

1 release file

1.3.5

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.7

1 release file

1.1.6

1 release file

1.1.5

1 release file

1.1.4

1 release file

1.1.3

1 release file

1.1.2

1 release file

1.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page