Introduction

CircuitPython driver for the IS31FL3731 charlieplex IC.

This driver supports the following hardware:

• Adafruit 16x9 Charlieplexed PWM LED Matrix Driver - IS31FL3731
• Adafruit 15x7 CharliePlex LED Matrix Display FeatherWings
• Adafruit 16x8 CharliePlex LED Matrix Bonnets
• Pimoroni 17x7 Scroll pHAT HD
• Pimoroni 28x3 (r,g,b) Led Shim
• Pimoroni Keybow 2040 with 4x4 matrix of RGB LEDs
• Pimoroni 5x5 RGB Matrix Breakout

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-is31fl3731

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-is31fl3731

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-is31fl3731

Usage Example

Matrix:

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:

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.