adafruit-circuitpython-as7341


Nameadafruit-circuitpython-as7341 JSON
Version 1.2.20 PyPI version JSON
download
home_pageNone
SummaryCircuitPython library for use with the Adafruit AS7341 breakout
upload_time2025-01-08 19:23:35
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython as7341 spectral sensor multi-channel mux calibration
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-circuitpython-register adafruit-circuitpython-busdevice
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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": null,
    "name": "adafruit-circuitpython-as7341",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, as7341, Spectral, sensor, multi-channel, mux, calibration",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/4e/ad/77d3d8ae7c6cfd1889c2d105c0c35ffaea09e603cd985b655bb753b52f36/adafruit_circuitpython_as7341-1.2.20.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.20",
    "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": "d0cb2df1b8ae2e8747d603aa9029b1eb5b1f66e4bf351bd2c616d0cabf8be797",
                "md5": "20bd543e5f1d63d3b9e8ba0180b3f409",
                "sha256": "3fd39c68db8efefbd335dba2b788c1c55ddb9499f10647fed6c67b83c22aab09"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_as7341-1.2.20-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "20bd543e5f1d63d3b9e8ba0180b3f409",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10262,
            "upload_time": "2025-01-08T19:23:33",
            "upload_time_iso_8601": "2025-01-08T19:23:33.224216Z",
            "url": "https://files.pythonhosted.org/packages/d0/cb/2df1b8ae2e8747d603aa9029b1eb5b1f66e4bf351bd2c616d0cabf8be797/adafruit_circuitpython_as7341-1.2.20-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ead77d3d8ae7c6cfd1889c2d105c0c35ffaea09e603cd985b655bb753b52f36",
                "md5": "896b76906d87b01c7d73d0ed5ce15a30",
                "sha256": "fd4305b20b8142897f9f0220e5b0bf49c7e04d1b817894135fe4b175ae9cfdd9"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_as7341-1.2.20.tar.gz",
            "has_sig": false,
            "md5_digest": "896b76906d87b01c7d73d0ed5ce15a30",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 33906,
            "upload_time": "2025-01-08T19:23:35",
            "upload_time_iso_8601": "2025-01-08T19:23:35.469793Z",
            "url": "https://files.pythonhosted.org/packages/4e/ad/77d3d8ae7c6cfd1889c2d105c0c35ffaea09e603cd985b655bb753b52f36/adafruit_circuitpython_as7341-1.2.20.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-08 19:23:35",
    "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": [
        {
            "name": "Adafruit-Blinka",
            "specs": [
                [
                    ">=",
                    "7.0.0"
                ]
            ]
        },
        {
            "name": "adafruit-circuitpython-register",
            "specs": []
        },
        {
            "name": "adafruit-circuitpython-busdevice",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-as7341"
}
        
Elapsed time: 0.39248s