https://github.com/adafruit/adafruit_circuitpython_ht16k33

Adafruit CircuitPython driver for the HT16K33, a LED matrix driver IC.
https://github.com/adafruit/adafruit_circuitpython_ht16k33

circuitpython hacktoberfest

Last synced: 1 day ago
JSON representation

Adafruit CircuitPython driver for the HT16K33, a LED matrix driver IC.

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_ht16k33
• Owner: adafruit
• License: mit
• Created: 2017-01-09T19:38:19.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T21:58:42.000Z (3 months ago)
• Last Synced: 2024-12-16T17:51:14.482Z (6 days ago)
• Topics: circuitpython, hacktoberfest
• Language: Python
• Size: 295 KB
• Stars: 42
• Watchers: 25
• Forks: 30
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

=============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ht16k33/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/ht16k33/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_HT16K33/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_HT16K33/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

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

    #. This library is intended for Adafruit CircuitPython's API.  For a library compatible with MicroPython machine API see this `library `_.

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

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Bus Device `_

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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ht16k33

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-ht16k33

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

Usage Example

=============

.. code-block :: python

    # 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.