Introduction

CircuitPython framebuf based driver for Pimoroni's Unicorn HAT HD. This driver supports the adafruit_framebuf interface via composition instead of inheritance.

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:

pip3 install circuitpython-unicornhathd

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

sudo pip3 install circuitpython-unicornhathd

To install in a virtual environment in your current project:

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install unicornhathd

Or the following command to update an existing version:

circup update

Usage Example

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.