Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ags02ma/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ags02ma/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_AGS02MA/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AGS02MA/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
AGS02MA TVOC / Gas 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/5593>`_
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-ags02ma/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ags02ma
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ags02ma
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-ags02ma
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_ags02ma
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the ``examples/`` folder to example usage of this library.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ags02ma/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_AGS02MA/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ags02ma",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ags02ma, tvoc, gas, resistance, sensor",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/cd/324fe4246ad57b15aca2a7ce055854dcda8ac3abe25080bd0677e2bb5e82/adafruit_circuitpython_ags02ma-1.0.9.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ags02ma/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ags02ma/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_AGS02MA/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_AGS02MA/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\nAGS02MA TVOC / Gas 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`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5593>`_\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-ags02ma/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ags02ma\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ags02ma\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 .env\n source .env/bin/activate\n pip3 install adafruit-circuitpython-ags02ma\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_ags02ma\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\nSee the ``examples/`` folder to example usage of this library.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ags02ma/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`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_AGS02MA/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython / Python library for AGS02MA gas sensor",
"version": "1.0.9",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AGS02MA"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ags02ma",
" tvoc",
" gas",
" resistance",
" sensor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9445e361dc841bdb4e632b2753c0b59b832631f6436496e88daa23a352f587c9",
"md5": "cac6d91fd704790758c97fb0fb93f6aa",
"sha256": "e646f508400f711273887c96acc45c2c3a12e68fc1b1a670273a27c0d7bd4b0f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ags02ma-1.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cac6d91fd704790758c97fb0fb93f6aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5892,
"upload_time": "2024-10-07T21:36:43",
"upload_time_iso_8601": "2024-10-07T21:36:43.185117Z",
"url": "https://files.pythonhosted.org/packages/94/45/e361dc841bdb4e632b2753c0b59b832631f6436496e88daa23a352f587c9/adafruit_circuitpython_ags02ma-1.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7cd324fe4246ad57b15aca2a7ce055854dcda8ac3abe25080bd0677e2bb5e82",
"md5": "282e83dd9f6e4da57b64d0435d14e116",
"sha256": "41a5541cf83182c52e0bc85fe89e0cdbca9cff6bb52eef09542873af95a86798"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ags02ma-1.0.9.tar.gz",
"has_sig": false,
"md5_digest": "282e83dd9f6e4da57b64d0435d14e116",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27254,
"upload_time": "2024-10-07T21:36:44",
"upload_time_iso_8601": "2024-10-07T21:36:44.195865Z",
"url": "https://files.pythonhosted.org/packages/e7/cd/324fe4246ad57b15aca2a7ce055854dcda8ac3abe25080bd0677e2bb5e82/adafruit_circuitpython_ags02ma-1.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 21:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_AGS02MA",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ags02ma"
}
JSON
