Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pm25/badge/?version=latest
:target: https://docs.circuitpython.org/projects/pm25/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_PM25/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_PM25/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 library for PM2.5 Air Quality Sensors
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>`_.
Installing from PyPI
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
as a standard element. Stay tuned for PyPI availability!
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pm25/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-pm25
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-pm25
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-pm25
Usage Example
=============
For example usage, see examples/pm25_simpletest.py
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pm25/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_PM25/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-pm25",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, pm25, AQI, PM2.5, Air, Quality",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/7c/55/f9d59f6440d558e2fa5f6534748dd6f1f3a633699371dd1debdff0dcd64a/adafruit_circuitpython_pm25-2.1.17.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pm25/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/pm25/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_PM25/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_PM25/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 library for PM2.5 Air Quality Sensors\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>`_.\n\nInstalling from PyPI\n=====================\n.. note:: This library is not available on PyPI yet. Install documentation is included\n as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-pm25/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-pm25\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-pm25\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-pm25\n\nUsage Example\n=============\n\nFor example usage, see examples/pm25_simpletest.py\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pm25/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_PM25/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for PM2.5 Air Quality Sensors",
"version": "2.1.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_PM25"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" pm25",
" aqi",
" pm2.5",
" air",
" quality"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "223fe3dbe4f1e0cf47d2424733c73ecab63fd8b162af02f1d03bf38762f920a7",
"md5": "9d911320580c1f7e54a570c293e41565",
"sha256": "de2b173c5766d74043aa20deca24e79387c97908d9300f6f254fde8337acc9be"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pm25-2.1.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9d911320580c1f7e54a570c293e41565",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7647,
"upload_time": "2024-10-02T17:21:11",
"upload_time_iso_8601": "2024-10-02T17:21:11.182482Z",
"url": "https://files.pythonhosted.org/packages/22/3f/e3dbe4f1e0cf47d2424733c73ecab63fd8b162af02f1d03bf38762f920a7/adafruit_circuitpython_pm25-2.1.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7c55f9d59f6440d558e2fa5f6534748dd6f1f3a633699371dd1debdff0dcd64a",
"md5": "3c23dd8bcdcde04c497221ba58ac522e",
"sha256": "ae2eb01bc6bf912b803feb1eeff82b96f753b54f5a13dced37b9244a8f659268"
},
"downloads": -1,
"filename": "adafruit_circuitpython_pm25-2.1.17.tar.gz",
"has_sig": false,
"md5_digest": "3c23dd8bcdcde04c497221ba58ac522e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28359,
"upload_time": "2024-10-02T17:21:12",
"upload_time_iso_8601": "2024-10-02T17:21:12.087337Z",
"url": "https://files.pythonhosted.org/packages/7c/55/f9d59f6440d558e2fa5f6534748dd6f1f3a633699371dd1debdff0dcd64a/adafruit_circuitpython_pm25-2.1.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 17:21:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_PM25",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-pm25"
}
JSON
