https://github.com/nathany3g/circuitpython_unicorn_hat_hd
CircuitPython framebuf based driver for Pimoroni's Unicorn HAT HD
https://github.com/nathany3g/circuitpython_unicorn_hat_hd
circuitpython circuitpython-library unicornhat unicornhat-hd unicornhathd
Last synced: 11 months ago
JSON representation
CircuitPython framebuf based driver for Pimoroni's Unicorn HAT HD
- Host: GitHub
- URL: https://github.com/nathany3g/circuitpython_unicorn_hat_hd
- Owner: NathanY3G
- License: mit
- Created: 2021-10-29T17:42:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-30T12:44:22.000Z (over 4 years ago)
- Last Synced: 2025-05-06T03:09:16.197Z (11 months ago)
- Topics: circuitpython, circuitpython-library, unicornhat, unicornhat-hd, unicornhathd
- Language: Python
- Homepage:
- Size: 1.27 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Introduction
============
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
.. image:: https://img.shields.io/pypi/v/circuitpython-unicornhathd?color=informational
:target: https://pypi.org/project/circuitpython-unicornhathd
:alt: PyPI
CircuitPython framebuf based driver for Pimoroni's Unicorn HAT HD.
This driver supports the `adafruit_framebuf interface `__ via composition instead of inheritance.
.. image:: ./images/unicornhathd_rainbow.png
:alt: Pimoroni Unicorn HAT HD on breadboard
:scale: 50%
:align: center
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython `_
* `Adafruit framebuf `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle `_
or individual libraries can be installed using
`circup `_.
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 circuitpython-unicornhathd
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-unicornhathd
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-unicornhathd
Installing to a Connected CircuitPython Device with Circup
==========================================================
Make sure that you have ``circup`` installed in your Python environment.
Install it with the following command if necessary:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install unicornhathd
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import digitalio
from unicornhathd import UnicornHATHD
# TODO: Change this pin to match your wiring
chip_select_pin = digitalio.DigitalInOut(board.D0)
chip_select_pin.direction = digitalio.Direction.OUTPUT
chip_select_pin.value = True
display = UnicornHATHD(board.SPI(), chip_select_pin)
# Turn on all of the blue LEDs
display.fill(127)
display.show()
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
`_
before contributing to help this project stay welcoming.
Documentation
=============
For information on building library documentation, please check out
`this guide `_.