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 <https://github.com/adafruit/micropython-adafruit-ht16k33>`_.
#. This library does not work with the Trellis 4x4 LED+Keypad board. For that product use: `CircuitPython Trellis Library <https://github.com/adafruit/Adafruit_CircuitPython_Trellis/releases/latest>`_
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
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-ht16k33/>`_. 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 <https://docs.circuitpython.org/projects/ht16k33/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_HT16K33/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ht16k33",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, ht16k33, led, matrix, segment, displays, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/98/ce/f50ae90a39fd06e4ad59ab69ccee9c1d43144bc4cdab4d36dd877ad24cd1/adafruit-circuitpython-ht16k33-4.6.9.tar.gz",
"platform": null,
"description": "\ufeffIntroduction\n=============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ht16k33/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ht16k33/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_HT16K33/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_HT16K33/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\nThis is a library for using the I\u00b2C-based LED matrices with the HT16K33 chip.\nIt supports both 16x8 and 8x8 matrices, as well as 7- and 14-segment displays.\n\n* **Notes**\n\n #. This library is intended for Adafruit CircuitPython's API. For a library compatible with MicroPython machine API see this `library <https://github.com/adafruit/micropython-adafruit-ht16k33>`_.\n\n #. This library does not work with the Trellis 4x4 LED+Keypad board. For that product use: `CircuitPython Trellis Library <https://github.com/adafruit/Adafruit_CircuitPython_Trellis/releases/latest>`_\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\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-ht16k33/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ht16k33\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ht16k33\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-ht16k33\n\nUsage Example\n=============\n\n.. code-block :: python\n\n # Import all board pins and bus interface.\n import board\n import busio\n\n # Import the HT16K33 LED matrix module.\n from adafruit_ht16k33 import matrix\n\n # Create the I2C interface.\n i2c = busio.I2C(board.SCL, board.SDA)\n\n # Create the matrix class.\n # This creates a 16x8 matrix:\n matrix = matrix.Matrix16x8(i2c)\n # Or this creates a 8x8 matrix:\n #matrix = matrix.Matrix8x8(i2c)\n # Or this creates a 8x8 bicolor matrix:\n #matrix = matrix.Matrix8x8x2\n # Finally you can optionally specify a custom I2C address of the HT16k33 like:\n #matrix = matrix.Matrix16x8(i2c, address=0x70)\n\n # Clear the matrix.\n matrix.fill(0)\n\n # Set a pixel in the origin 0,0 position.\n matrix[0, 0] = 1\n # Set a pixel in the middle 8, 4 position.\n matrix[8, 4] = 1\n # Set a pixel in the opposite 15, 7 position.\n matrix[15, 7] = 1\n matrix.show()\n\n # Change the brightness\n matrix.brightness = 8\n\n # Set the blink rate\n matrix.blink_rate = 2\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ht16k33/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_HT16K33/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for HT16K33 LED matrices and segment displays.",
"version": "4.6.9",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_HT16K33"
},
"split_keywords": [
"adafruit",
" ht16k33",
" led",
" matrix",
" segment",
" displays",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27baba565ef9c3b5872b0b1eb714a2c6f74bb84c90fdd04119e65ff5227a7395",
"md5": "7f95212649649c7d3d997c0a537a5083",
"sha256": "2634f2d2b4823e023d778e9914f5bfe0189040c56f5da70d4c5ad10ac13f791e"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ht16k33-4.6.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f95212649649c7d3d997c0a537a5083",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 16372,
"upload_time": "2024-03-19T22:09:45",
"upload_time_iso_8601": "2024-03-19T22:09:45.439680Z",
"url": "https://files.pythonhosted.org/packages/27/ba/ba565ef9c3b5872b0b1eb714a2c6f74bb84c90fdd04119e65ff5227a7395/adafruit_circuitpython_ht16k33-4.6.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98cef50ae90a39fd06e4ad59ab69ccee9c1d43144bc4cdab4d36dd877ad24cd1",
"md5": "e6c5bbb12ab5952969f43c6a774673af",
"sha256": "38531f11a2b9cba63b68abd9af11ec8d479c19bf5e380ad4f977c2bb20a410c5"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ht16k33-4.6.9.tar.gz",
"has_sig": false,
"md5_digest": "e6c5bbb12ab5952969f43c6a774673af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38948,
"upload_time": "2024-03-19T22:09:48",
"upload_time_iso_8601": "2024-03-19T22:09:48.016813Z",
"url": "https://files.pythonhosted.org/packages/98/ce/f50ae90a39fd06e4ad59ab69ccee9c1d43144bc4cdab4d36dd877ad24cd1/adafruit-circuitpython-ht16k33-4.6.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-19 22:09:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_HT16K33",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ht16k33"
}
JSON
