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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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 tempremental 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.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-scd30",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,scd30,e-CO2,CO2,air,quality",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/67/a3/267a29bd2e70d244ce5ef3342230dbfb132673d6094b7a68b308d5baafd3/adafruit-circuitpython-scd30-2.2.12.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-scd30/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/scd30/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_SCD30/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SCD30/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\nHelper library for the SCD30 CO2 sensor\n\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://circuitpython.org/libraries>`_.\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-scd30/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-scd30\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-scd30\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-scd30\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n import adafruit_scd30\n\n # SCD-30 has tempremental I2C with clock stretching, datasheet recommends\n # starting at 50KHz\n i2c = busio.I2C(board.SCL, board.SDA,frequency=50000)\n scd = adafruit_scd30.SCD30(i2c)\n\n while True:\n # since the measurement interval is long (2+ seconds) we check for new data before reading\n # the values, to ensure current readings.\n if scd.data_available:\n print(\"Data Available!\")\n print(\"CO2:\", scd.CO2, \"PPM\")\n print(\"Temperature:\", scd.temperature, \"degrees C\")\n print(\"Humidity:\", scd.relative_humidity, \"%%rH\")\n print(\"\")\n print(\"Waiting for new data...\")\n print(\"\")\n\n time.sleep(0.5)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/scd30/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_SCD30/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Helper library for the SCD30 CO2 sensor",
"version": "2.2.12",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SCD30"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"scd30",
"e-co2",
"co2",
"air",
"quality"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9cb37007f696349ce4bf4417450288226085265f0203eca17e71ca496482977",
"md5": "345a7072c124b913e7fc4abd70ea3819",
"sha256": "12576e029016b22f428ba91ad313ee64cc0ab40b0b52158198e4414244ca00eb"
},
"downloads": -1,
"filename": "adafruit_circuitpython_scd30-2.2.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "345a7072c124b913e7fc4abd70ea3819",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7271,
"upload_time": "2023-12-09T17:33:17",
"upload_time_iso_8601": "2023-12-09T17:33:17.228296Z",
"url": "https://files.pythonhosted.org/packages/f9/cb/37007f696349ce4bf4417450288226085265f0203eca17e71ca496482977/adafruit_circuitpython_scd30-2.2.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67a3267a29bd2e70d244ce5ef3342230dbfb132673d6094b7a68b308d5baafd3",
"md5": "303352855427d9a92b58f57e49d92bf7",
"sha256": "ab6bb8605913af40444e1d9e0c82cc2e35b78f6f5be3f88830586c1f6bcb260f"
},
"downloads": -1,
"filename": "adafruit-circuitpython-scd30-2.2.12.tar.gz",
"has_sig": false,
"md5_digest": "303352855427d9a92b58f57e49d92bf7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29329,
"upload_time": "2023-12-09T17:33:18",
"upload_time_iso_8601": "2023-12-09T17:33:18.515576Z",
"url": "https://files.pythonhosted.org/packages/67/a3/267a29bd2e70d244ce5ef3342230dbfb132673d6094b7a68b308d5baafd3/adafruit-circuitpython-scd30-2.2.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:33:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SCD30",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-scd30"
}
JSON
