Adafruit CircuitPython CCS811 Library
=====================================
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ccs811/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ccs811/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_CCS811/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_CCS811/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
CircuitPython driver for the `CCS811 air quality sensor <https://www.adafruit.com/product/3566>`_.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ccs811/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ccs811
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ccs811
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ccs811
Usage Notes
===========
See `the guide <https://learn.adafruit.com/adafruit-ccs811-air-quality-sensor/python-circuitpython>`_
for wiring and installation instructions.
Of course, you must import the library to use it:
.. code:: python
import busio
import adafruit_ccs811
Next, initialize the I2C bus object.
.. code:: python
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
.. code:: python
ccs = adafruit_ccs811.CCS811(i2c)
Reading Sensor
--------------
To read the gas sensor simply read the attributes:
.. code:: python
print("CO2: ", ccs.eco2, " TVOC:", ccs.tvoc)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ccs811/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_CCS811/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ccs811",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, air, quality, voc, eco2, breakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e8/58/5488fdcb8ba541c67ea3355782c77bd7e8193ac86d4c36c602906a7101d6/adafruit_circuitpython_ccs811-1.3.18.tar.gz",
"platform": null,
"description": "\nAdafruit CircuitPython CCS811 Library\n=====================================\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ccs811/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ccs811/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_CCS811/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_CCS811/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nCircuitPython driver for the `CCS811 air quality sensor <https://www.adafruit.com/product/3566>`_.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ccs811/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ccs811\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ccs811\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-ccs811\n\nUsage Notes\n===========\n\nSee `the guide <https://learn.adafruit.com/adafruit-ccs811-air-quality-sensor/python-circuitpython>`_\nfor wiring and installation instructions.\n\nOf course, you must import the library to use it:\n\n.. code:: python\n\n import busio\n import adafruit_ccs811\n\nNext, initialize the I2C bus object.\n\n.. code:: python\n\n from board import *\n i2c = board.I2C() # uses board.SCL and board.SDA\n\nOnce you have created the I2C interface object, you can use it to instantiate\nthe CCS811 object\n\n.. code:: python\n\n ccs = adafruit_ccs811.CCS811(i2c)\n\nReading Sensor\n--------------\n\nTo read the gas sensor simply read the attributes:\n\n.. code:: python\n\n print(\"CO2: \", ccs.eco2, \" TVOC:\", ccs.tvoc)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ccs811/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_CCS811/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for CCS811 air quality sensor.",
"version": "1.3.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CCS811"
},
"split_keywords": [
"adafruit",
" air",
" quality",
" voc",
" eco2",
" breakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f8dddcad048b1e1e3ad7b988e5e81899b486b07b026189be154c091195b80b23",
"md5": "8edd0e7c88996c67dba643665e48d6ae",
"sha256": "512ac8e5d04e91d9106b14816e9e772307c075cd834c2bd31b22104420d4d868"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ccs811-1.3.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8edd0e7c88996c67dba643665e48d6ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7013,
"upload_time": "2025-01-22T16:24:55",
"upload_time_iso_8601": "2025-01-22T16:24:55.672188Z",
"url": "https://files.pythonhosted.org/packages/f8/dd/dcad048b1e1e3ad7b988e5e81899b486b07b026189be154c091195b80b23/adafruit_circuitpython_ccs811-1.3.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e8585488fdcb8ba541c67ea3355782c77bd7e8193ac86d4c36c602906a7101d6",
"md5": "7817d6d5c78629484526d0c4c386fbc8",
"sha256": "cb082ff2a93d8eca9761e0108cf1afe11c359d3ace4d2fcce4055d580ee20201"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ccs811-1.3.18.tar.gz",
"has_sig": false,
"md5_digest": "7817d6d5c78629484526d0c4c386fbc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30674,
"upload_time": "2025-01-22T16:24:57",
"upload_time_iso_8601": "2025-01-22T16:24:57.557884Z",
"url": "https://files.pythonhosted.org/packages/e8/58/5488fdcb8ba541c67ea3355782c77bd7e8193ac86d4c36c602906a7101d6/adafruit_circuitpython_ccs811-1.3.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-22 16:24:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_CCS811",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-ccs811"
}
JSON
