adafruit-circuitpython-scd30 2.2.17
Helper library for the SCD30 CO2 sensor
License: MIT
Keywords: adafruit, blinka, circuitpython, micropython, scd30, e-CO2, CO2, air, quality

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-scd30/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/scd30/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_SCD30/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_SCD30/actions
    :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

Helper library for the SCD30 CO2 sensor


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://circuitpython.org/libraries>`_.

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-scd30/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-scd30

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-scd30

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-scd30

Usage Example
=============

.. code-block:: python3

    import time
    import board
    import adafruit_scd30

    # SCD-30 has temperamental I2C with clock stretching, datasheet recommends
    # starting at 50KHz
    i2c = busio.I2C(board.SCL, board.SDA,frequency=50000)
    scd = adafruit_scd30.SCD30(i2c)

    while True:
        # since the measurement interval is long (2+ seconds) we check for new data before reading
        # the values, to ensure current readings.
        if scd.data_available:
            print("Data Available!")
            print("CO2:", scd.CO2, "PPM")
            print("Temperature:", scd.temperature, "degrees C")
            print("Humidity:", scd.relative_humidity, "%%rH")
            print("")
            print("Waiting for new data...")
            print("")

        time.sleep(0.5)

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/scd30/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_SCD30/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.