Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-as7341/badge/?version=latest
:target: https://docs.circuitpython.org/projects/as7341/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_AS7341/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_AS7341/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 use with the Adafruit AS7341 breakout.
**NOTE**: Due to the size of this library, it may not work on M0 (ex: Trinket M0) and other
low memory boards.
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>`_.
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-as7341/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-as7341
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-as7341
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-as7341
Usage Example
=============
.. code-block:: python3
from time import sleep
import board
from adafruit_as7341 import AS7341
i2c = board.I2C() # uses board.SCL and board.SDA
sensor = AS7341(i2c)
def bar_graph(read_value):
scaled = int(read_value / 1000)
return "[%5d] " % read_value + (scaled * "*")
while True:
print("F1 - 415nm/Violet %s" % bar_graph(sensor.channel_415nm))
print("F2 - 445nm//Indigo %s" % bar_graph(sensor.channel_445nm))
print("F3 - 480nm//Blue %s" % bar_graph(sensor.channel_480nm))
print("F4 - 515nm//Cyan %s" % bar_graph(sensor.channel_515nm))
print("F5 - 555nm/Green %s" % bar_graph(sensor.channel_555nm))
print("F6 - 590nm/Yellow %s" % bar_graph(sensor.channel_590nm))
print("F7 - 630nm/Orange %s" % bar_graph(sensor.channel_630nm))
print("F8 - 680nm/Red %s" % bar_graph(sensor.channel_680nm))
print("Clear %s" % bar_graph(sensor.channel_clear))
print("Near-IR (NIR) %s" % bar_graph(sensor.channel_nir))
print("\n------------------------------------------------")
sleep(1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/as7341/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_AS7341/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-as7341",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,as7341,Spectral,sensor,multi-channel,mux,calibration",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/2b/59/1f087eb2a0c6e23781b5de4f2a492d291f8fdd446b478509fd0161dd048d/adafruit-circuitpython-as7341-1.2.18.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-as7341/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/as7341/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_AS7341/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_AS7341/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 use with the Adafruit AS7341 breakout.\n**NOTE**: Due to the size of this library, it may not work on M0 (ex: Trinket M0) and other\nlow memory boards.\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>`_.\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-as7341/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-as7341\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-as7341\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-as7341\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n from time import sleep\n import board\n from adafruit_as7341 import AS7341\n\n i2c = board.I2C() # uses board.SCL and board.SDA\n sensor = AS7341(i2c)\n\n\n def bar_graph(read_value):\n scaled = int(read_value / 1000)\n return \"[%5d] \" % read_value + (scaled * \"*\")\n\n\n while True:\n\n print(\"F1 - 415nm/Violet %s\" % bar_graph(sensor.channel_415nm))\n print(\"F2 - 445nm//Indigo %s\" % bar_graph(sensor.channel_445nm))\n print(\"F3 - 480nm//Blue %s\" % bar_graph(sensor.channel_480nm))\n print(\"F4 - 515nm//Cyan %s\" % bar_graph(sensor.channel_515nm))\n print(\"F5 - 555nm/Green %s\" % bar_graph(sensor.channel_555nm))\n print(\"F6 - 590nm/Yellow %s\" % bar_graph(sensor.channel_590nm))\n print(\"F7 - 630nm/Orange %s\" % bar_graph(sensor.channel_630nm))\n print(\"F8 - 680nm/Red %s\" % bar_graph(sensor.channel_680nm))\n print(\"Clear %s\" % bar_graph(sensor.channel_clear))\n print(\"Near-IR (NIR) %s\" % bar_graph(sensor.channel_nir))\n print(\"\\n------------------------------------------------\")\n sleep(1)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/as7341/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_AS7341/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for use with the Adafruit AS7341 breakout",
"version": "1.2.18",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_AS7341"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"as7341",
"spectral",
"sensor",
"multi-channel",
"mux",
"calibration"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d8a97b64019e8c3fedaba90d349b035be6a3615d68ab791c64e6558e40ac6f82",
"md5": "40635cc606387a702c8642d0217c8eb4",
"sha256": "a49ad776cb274d17997eaa675f9f90fbf43d9b21fa82621037a4b9d5b700fd1c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_as7341-1.2.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40635cc606387a702c8642d0217c8eb4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10261,
"upload_time": "2023-12-23T17:07:27",
"upload_time_iso_8601": "2023-12-23T17:07:27.181967Z",
"url": "https://files.pythonhosted.org/packages/d8/a9/7b64019e8c3fedaba90d349b035be6a3615d68ab791c64e6558e40ac6f82/adafruit_circuitpython_as7341-1.2.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b591f087eb2a0c6e23781b5de4f2a492d291f8fdd446b478509fd0161dd048d",
"md5": "98f0904402a8cd872d7f8b92683f27d5",
"sha256": "b61ac9510a41a149254aa81da8377a7c2a8a362792663021e68b0c05b55bbe0c"
},
"downloads": -1,
"filename": "adafruit-circuitpython-as7341-1.2.18.tar.gz",
"has_sig": false,
"md5_digest": "98f0904402a8cd872d7f8b92683f27d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33351,
"upload_time": "2023-12-23T17:07:28",
"upload_time_iso_8601": "2023-12-23T17:07:28.951487Z",
"url": "https://files.pythonhosted.org/packages/2b/59/1f087eb2a0c6e23781b5de4f2a492d291f8fdd446b478509fd0161dd048d/adafruit-circuitpython-as7341-1.2.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-23 17:07:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_AS7341",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-as7341"
}
JSON
