Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-guvx-i2c/badge/?version=latest
:target: https://docs.circuitpython.org/projects/guvx_i2c/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_GUVX_I2C/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_GUVX_I2C/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
Python drivers for the GUVA-C32SM and GUVB-C31SM I2C UV sensors
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>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Works with the GUVx family of I2C UV light sensors
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5609>`_
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-guvx-i2c/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-guvx-i2c
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-guvx-i2c
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-guvx-i2c
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 guvx_i2c
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
See the `examples/` folder for usage examples.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/guvx_i2c/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_GUVX_I2C/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-guvx-i2c",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,guvx_i2c,UVA,UVB,Python,driver,I2C,GUVA,GUVB",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/e0/9c/bfbf429f52bf6c65d2fcb867395a40853ed3f93924188ea4e4c2c4e58abc/adafruit-circuitpython-guvx-i2c-1.0.5.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-guvx-i2c/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/guvx_i2c/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_GUVX_I2C/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_GUVX_I2C/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\nPython drivers for the GUVA-C32SM and GUVB-C31SM I2C UV 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* `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>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nWorks with the GUVx family of I2C UV light sensors\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5609>`_\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-guvx-i2c/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-guvx-i2c\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-guvx-i2c\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-guvx-i2c\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 guvx_i2c\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 for usage examples.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/guvx_i2c/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_GUVX_I2C/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python drivers for the GUVA-C32SM and GUVB-C31SM I2C UV sensors",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_GUVX_I2C"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"guvx_i2c",
"uva",
"uvb",
"python",
"driver",
"i2c",
"guva",
"guvb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53d7b4ad14b201f483da328242df5ae54a84b64db7cd55a7930dc3e538869271",
"md5": "8202ab96cafb4d9e8b80a4b7b6c7e91b",
"sha256": "7c33207842d199c275e63c9e2a76bafa8bf2e92ad6d8891ac5fe1f2386af5f74"
},
"downloads": -1,
"filename": "adafruit_circuitpython_guvx_i2c-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8202ab96cafb4d9e8b80a4b7b6c7e91b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6127,
"upload_time": "2023-09-25T15:41:11",
"upload_time_iso_8601": "2023-09-25T15:41:11.805234Z",
"url": "https://files.pythonhosted.org/packages/53/d7/b4ad14b201f483da328242df5ae54a84b64db7cd55a7930dc3e538869271/adafruit_circuitpython_guvx_i2c-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e09cbfbf429f52bf6c65d2fcb867395a40853ed3f93924188ea4e4c2c4e58abc",
"md5": "4c6ad9c6a08271676973df9d1c7bd70e",
"sha256": "7293e1b52391f6487628d2995ddfc516c0ad1898ad6489baca393f66b66a670e"
},
"downloads": -1,
"filename": "adafruit-circuitpython-guvx-i2c-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "4c6ad9c6a08271676973df9d1c7bd70e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27908,
"upload_time": "2023-09-25T15:41:12",
"upload_time_iso_8601": "2023-09-25T15:41:12.838461Z",
"url": "https://files.pythonhosted.org/packages/e0/9c/bfbf429f52bf6c65d2fcb867395a40853ed3f93924188ea4e4c2c4e58abc/adafruit-circuitpython-guvx-i2c-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:41:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_GUVX_I2C",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-guvx-i2c"
}
JSON
