Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-is31fl3731/badge/?version=latest
:target: https://docs.circuitpython.org/projects/is31fl3731/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_IS31FL3731/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
CircuitPython driver for the IS31FL3731 charlieplex IC.
This driver supports the following hardware:
* `Adafruit 16x9 Charlieplexed PWM LED Matrix Driver - IS31FL3731 <https://www.adafruit.com/product/2946>`_
* `Adafruit 15x7 CharliePlex LED Matrix Display FeatherWings <https://www.adafruit.com/product/2965>`_
* `Adafruit 16x8 CharliePlex LED Matrix Bonnets <https://www.adafruit.com/product/4127>`_
* `Pimoroni 17x7 Scroll pHAT HD <https://www.adafruit.com/product/3473>`_
* `Pimoroni 28x3 (r,g,b) Led Shim <https://www.adafruit.com/product/3831>`_
* `Pimoroni Keybow 2040 with 4x4 matrix of RGB LEDs <https://shop.pimoroni.com/products/keybow-2040>`_
* `Pimoroni 5x5 RGB Matrix Breakout <https://shop.pimoroni.com/products/5x5-rgb-matrix-breakout>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
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-is31fl3731/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-is31fl3731
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-is31fl3731
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-is31fl3731
Usage Example
=============
Matrix:
.. code:: python
from adafruit_is31fl3731.matrix import Matrix
import board
import busio
with busio.I2C(board.SCL, board.SDA) as i2c:
display = Matrix(i2c)
display.fill(127)
Charlie Wing:
.. code:: python
from adafruit_is31fl3731.charlie_wing import CharlieWing
import board
import busio
with busio.I2C(board.SCL, board.SDA) as i2c:
display = CharlieWing(i2c)
display.fill(127)
# Turn off pixel 4,4, change its brightness and turn it back on
display.pixel(4, 4, 0) # Turn off.
display.pixel(4, 4, 50) # Low brightness (50)
display.pixel(4, 4, 192) # Higher brightness (192)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/is31fl3731/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_is31fl3731/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-is31fl3731",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, is31fl3731, led, matrix, charlieplex, featherwingbreakout, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/01/c47fab6fe6ef400d45eafb3246c5cc324bae726873fe32da6c016f7bd994/adafruit_circuitpython_is31fl3731-3.4.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-is31fl3731/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/is31fl3731/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_IS31FL3731/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nCircuitPython driver for the IS31FL3731 charlieplex IC.\n\nThis driver supports the following hardware:\n\n* `Adafruit 16x9 Charlieplexed PWM LED Matrix Driver - IS31FL3731 <https://www.adafruit.com/product/2946>`_\n* `Adafruit 15x7 CharliePlex LED Matrix Display FeatherWings <https://www.adafruit.com/product/2965>`_\n* `Adafruit 16x8 CharliePlex LED Matrix Bonnets <https://www.adafruit.com/product/4127>`_\n* `Pimoroni 17x7 Scroll pHAT HD <https://www.adafruit.com/product/3473>`_\n* `Pimoroni 28x3 (r,g,b) Led Shim <https://www.adafruit.com/product/3831>`_\n* `Pimoroni Keybow 2040 with 4x4 matrix of RGB LEDs <https://shop.pimoroni.com/products/keybow-2040>`_\n* `Pimoroni 5x5 RGB Matrix Breakout <https://shop.pimoroni.com/products/5x5-rgb-matrix-breakout>`_\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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-is31fl3731/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-is31fl3731\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-is31fl3731\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-is31fl3731\n\nUsage Example\n=============\n\nMatrix:\n\n.. code:: python\n\n from adafruit_is31fl3731.matrix import Matrix\n import board\n import busio\n with busio.I2C(board.SCL, board.SDA) as i2c:\n display = Matrix(i2c)\n display.fill(127)\n\n\nCharlie Wing:\n\n.. code:: python\n\n from adafruit_is31fl3731.charlie_wing import CharlieWing\n import board\n import busio\n with busio.I2C(board.SCL, board.SDA) as i2c:\n display = CharlieWing(i2c)\n display.fill(127)\n\n # Turn off pixel 4,4, change its brightness and turn it back on\n display.pixel(4, 4, 0) # Turn off.\n display.pixel(4, 4, 50) # Low brightness (50)\n display.pixel(4, 4, 192) # Higher brightness (192)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/is31fl3731/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_is31fl3731/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for IS31FL3731 charlieplex LED matrices.",
"version": "3.4.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_IS31FL3731"
},
"split_keywords": [
"adafruit",
" is31fl3731",
" led",
" matrix",
" charlieplex",
" featherwingbreakout",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c643344cc716d6f05efe65ca384d1312371b1f215b08059a0855667b65fc29ae",
"md5": "cd01cb81b386988e127b08fb92b5fa22",
"sha256": "fd889033c7e4c15a3e61cd5de661f30217982d67912afc3277007dcf1aa3b44b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_is31fl3731-3.4.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd01cb81b386988e127b08fb92b5fa22",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16176,
"upload_time": "2024-10-07T22:03:25",
"upload_time_iso_8601": "2024-10-07T22:03:25.241817Z",
"url": "https://files.pythonhosted.org/packages/c6/43/344cc716d6f05efe65ca384d1312371b1f215b08059a0855667b65fc29ae/adafruit_circuitpython_is31fl3731-3.4.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d801c47fab6fe6ef400d45eafb3246c5cc324bae726873fe32da6c016f7bd994",
"md5": "22982313a243a2b8c8abbc53156da4e6",
"sha256": "2ca96bea836aad9ebc05499a898101bdb312384d5b099ff4720ed9cdf30f59d6"
},
"downloads": -1,
"filename": "adafruit_circuitpython_is31fl3731-3.4.3.tar.gz",
"has_sig": false,
"md5_digest": "22982313a243a2b8c8abbc53156da4e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 33241,
"upload_time": "2024-10-07T22:03:26",
"upload_time_iso_8601": "2024-10-07T22:03:26.267625Z",
"url": "https://files.pythonhosted.org/packages/d8/01/c47fab6fe6ef400d45eafb3246c5cc324bae726873fe32da6c016f7bd994/adafruit_circuitpython_is31fl3731-3.4.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:03:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_IS31FL3731",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-is31fl3731"
}
JSON
