Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-veml6070/badge/?version=latest
:target: https://docs.circuitpython.org/projects/veml6070/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_VEML6070/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_VEML6070/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 driver for the `VEML6070 UV Index Sensor Breakout <https://www.adafruit.com/product/2899>`_
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-veml6070/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-veml6070
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-veml6070
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-veml6070
Usage Example
=============
.. code-block:: python3
import time
import board
from adafruit_veml6070 import VEML6070
with board.I2C() as i2c:
uv = VEML6070(i2c)
# Alternative constructors with parameters
#uv = VEML6070(i2c, 'VEML6070_1_T')
#uv = VEML6070(i2c, 'VEML6070_HALF_T', True)
# take 10 readings
for j in range(10):
uv_raw = uv.uv_raw
risk_level = uv.get_index(uv_raw)
print('Reading: {0} | Risk Level: {1}'.format(uv_raw, risk_level))
time.sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/veml6070/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_VEML6070/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-veml6070",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,veml6070,uv,index,sensor,breakout,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/21/9c/e4a6ce0d13c7ce9ed4e1b103de13b9187c6b0f4f20292e489fd932081885/adafruit-circuitpython-veml6070-3.1.19.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-veml6070/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/veml6070/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_VEML6070/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_VEML6070/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 driver for the `VEML6070 UV Index Sensor Breakout <https://www.adafruit.com/product/2899>`_\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-veml6070/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-veml6070\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-veml6070\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-veml6070\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import time\n import board\n from adafruit_veml6070 import VEML6070\n\n with board.I2C() as i2c:\n uv = VEML6070(i2c)\n # Alternative constructors with parameters\n #uv = VEML6070(i2c, 'VEML6070_1_T')\n #uv = VEML6070(i2c, 'VEML6070_HALF_T', True)\n\n # take 10 readings\n for j in range(10):\n uv_raw = uv.uv_raw\n risk_level = uv.get_index(uv_raw)\n print('Reading: {0} | Risk Level: {1}'.format(uv_raw, risk_level))\n time.sleep(1)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/veml6070/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_VEML6070/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for VEML6070 UV Index Sensor Breakout.",
"version": "3.1.19",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_VEML6070"
},
"split_keywords": [
"adafruit",
"veml6070",
"uv",
"index",
"sensor",
"breakout",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27b137904a9da0b534b6f6ae09bdf089b7445fcdad2b6231829796ba77ebc54e",
"md5": "fa392e2906f4b2f46f06a2e447b4f81c",
"sha256": "9b803f7ebef61dad22035753dfabf96f18e8129c5f7ebb3090977ead8576561e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_veml6070-3.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fa392e2906f4b2f46f06a2e447b4f81c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7121,
"upload_time": "2023-12-09T17:36:44",
"upload_time_iso_8601": "2023-12-09T17:36:44.018686Z",
"url": "https://files.pythonhosted.org/packages/27/b1/37904a9da0b534b6f6ae09bdf089b7445fcdad2b6231829796ba77ebc54e/adafruit_circuitpython_veml6070-3.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "219ce4a6ce0d13c7ce9ed4e1b103de13b9187c6b0f4f20292e489fd932081885",
"md5": "c99556f6ce2cb41ef83b7098c486b51c",
"sha256": "8e092d4720f398a60473b56d594a42f0c32d27afa1942151ec98acc5b35a42c1"
},
"downloads": -1,
"filename": "adafruit-circuitpython-veml6070-3.1.19.tar.gz",
"has_sig": false,
"md5_digest": "c99556f6ce2cb41ef83b7098c486b51c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28004,
"upload_time": "2023-12-09T17:36:47",
"upload_time_iso_8601": "2023-12-09T17:36:47.933364Z",
"url": "https://files.pythonhosted.org/packages/21/9c/e4a6ce0d13c7ce9ed4e1b103de13b9187c6b0f4f20292e489fd932081885/adafruit-circuitpython-veml6070-3.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:36:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_VEML6070",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-veml6070"
}
JSON
