Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-scd4x/badge/?version=latest
:target: https://docs.circuitpython.org/projects/scd4x/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_SCD4X/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SCD4X/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
Driver for Sensirion SCD4X CO2 sensor
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5187>`_
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-scd4x/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-scd4x
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-scd4x
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-scd4x
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install adafruit_scd4x
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import adafruit_scd4x
i2c = board.I2C()
scd4x = adafruit_scd4x.SCD4X(i2c)
print("Serial number:", [hex(i) for i in scd4x.serial_number])
scd4x.start_periodic_measurement()
print("Waiting for first measurement....")
while True:
if scd4x.data_ready:
print("CO2: %d ppm" % scd4x.CO2)
print("Temperature: %0.1f *C" % scd4x.temperature)
print("Humidity: %0.1f %%" % scd4x.relative_humidity)
print()
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/scd4x/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_SCD4X/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-scd4x",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, scd4x, CO2, humidity, temperature, sensor, SCD40, SCD41",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/ec/dd/8e98132c542aa235e8991c0f93889fabae1408e17ec01616edbbbadcc048/adafruit_circuitpython_scd4x-1.4.4.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-scd4x/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/scd4x/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SCD4X/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SCD4X/actions\n :alt: Build Status\n\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\nDriver for Sensirion SCD4X 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\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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5187>`_\n\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-scd4x/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-scd4x\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-scd4x\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-scd4x\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_scd4x\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n import adafruit_scd4x\n\n i2c = board.I2C()\n scd4x = adafruit_scd4x.SCD4X(i2c)\n print(\"Serial number:\", [hex(i) for i in scd4x.serial_number])\n\n scd4x.start_periodic_measurement()\n print(\"Waiting for first measurement....\")\n\n while True:\n if scd4x.data_ready:\n print(\"CO2: %d ppm\" % scd4x.CO2)\n print(\"Temperature: %0.1f *C\" % scd4x.temperature)\n print(\"Humidity: %0.1f %%\" % scd4x.relative_humidity)\n print()\n time.sleep(1)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/scd4x/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_SCD4X/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Driver for Sensirion SCD4X CO2 sensor",
"version": "1.4.4",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SCD4X.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" scd4x",
" co2",
" humidity",
" temperature",
" sensor",
" scd40",
" scd41"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3e24eadd36025f2ebdbd5ece629e9cb0047f59f8b4f878413798854897984ec",
"md5": "16f865f6c68c7f641147b16f414025d0",
"sha256": "2af505e23d2588e1c91f9ea18b92206ed32c9058276b80037b87415a8ecb9f4f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_scd4x-1.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16f865f6c68c7f641147b16f414025d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7819,
"upload_time": "2024-10-02T17:11:23",
"upload_time_iso_8601": "2024-10-02T17:11:23.606900Z",
"url": "https://files.pythonhosted.org/packages/e3/e2/4eadd36025f2ebdbd5ece629e9cb0047f59f8b4f878413798854897984ec/adafruit_circuitpython_scd4x-1.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ecdd8e98132c542aa235e8991c0f93889fabae1408e17ec01616edbbbadcc048",
"md5": "35423d4ec68adff967eaa605f317ce61",
"sha256": "114fee24aa9d185f4234004c92b497da67c8df29dd4450dd510a33c1a46e1de6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_scd4x-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "35423d4ec68adff967eaa605f317ce61",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30211,
"upload_time": "2024-10-02T17:11:24",
"upload_time_iso_8601": "2024-10-02T17:11:24.970426Z",
"url": "https://files.pythonhosted.org/packages/ec/dd/8e98132c542aa235e8991c0f93889fabae1408e17ec01616edbbbadcc048/adafruit_circuitpython_scd4x-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 17:11:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SCD4X",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-scd4x"
}
JSON
