Skip to main content

CircuitPython library for HT16K33 LED matrices and segment displays.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

This is a library for using the I²C-based LED matrices with the HT16K33 chip. It supports both 16x8 and 8x8 matrices, as well as 7- and 14-segment displays.

  • Notes

    1. This library is intended for Adafruit CircuitPython’s API. For a library compatible with MicroPython machine API see this library.

    2. This library does not work with the Trellis 4x4 LED+Keypad board. For that product use: CircuitPython Trellis Library

Dependencies

This driver depends on:

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-ht16k33

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

sudo pip3 install adafruit-circuitpython-ht16k33

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-ht16k33

Usage Example

# Import all board pins and bus interface.
import board
import busio

# Import the HT16K33 LED matrix module.
from adafruit_ht16k33 import matrix

# Create the I2C interface.
i2c = busio.I2C(board.SCL, board.SDA)

# Create the matrix class.
# This creates a 16x8 matrix:
matrix = matrix.Matrix16x8(i2c)
# Or this creates a 8x8 matrix:
#matrix = matrix.Matrix8x8(i2c)
# Or this creates a 8x8 bicolor matrix:
#matrix = matrix.Matrix8x8x2
# Finally you can optionally specify a custom I2C address of the HT16k33 like:
#matrix = matrix.Matrix16x8(i2c, address=0x70)

# Clear the matrix.
matrix.fill(0)

# Set a pixel in the origin 0,0 position.
matrix[0, 0] = 1
# Set a pixel in the middle 8, 4 position.
matrix[8, 4] = 1
# Set a pixel in the opposite 15, 7 position.
matrix[15, 7] = 1
matrix.show()

# Change the brightness
matrix.brightness = 8

# Set the blink rate
matrix.blink_rate = 2

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-ht16k33-4.5.2.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-ht16k33-4.5.2.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ht16k33-4.5.2.tar.gz
Algorithm Hash digest
SHA256 29383cbb23be9ffc51986b6dd852c8c7a91f3efa77f2193dd35cc3313e09336c
MD5 071bdefdb74e95e35fcca82ccdfa1e1c
BLAKE2b-256 2794b5a28be54db5140f03440fd38fd43e3958a91084afd5dbeab7f24f88ec8b

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ht16k33-4.5.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ht16k33-4.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 129f5ec8410dc36e916e87433c9f17691901d36739ad3980eac17081adaab197
MD5 06ce78cc4760c4b30c815894466d3baf
BLAKE2b-256 9e80f68378a11d9d2b943ee8f1f1f2f74f3646d1f64f9b685c271a93d71a2d06

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page