Introduction

CircuitPython driver for RaspberryPi BuildHAT

Attribution

In order to develop this library I used as a reference the official RaspberryPI Python library and the .NET library. The firmware in the directory buildhat/data comes from the RaspberryPI Build HAT repo

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Bus Device
• AsyncIO

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

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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-raspberrypi-buildhat

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

sudo pip3 install circuitpython-raspberrypi-buildhat

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-raspberrypi-buildhat

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 raspberrypi_buildhat

Or the following command to update an existing version:

circup update

Usage Example

"""
Example that initialize the Build HAT and list all the connected devices
Having debug=True it also print in the output console all steps during hat initialization
"""
import board
from buildhat.hat import Hat

# Pins for Waveshare RP2040-Zero.
# Change the pins if you are using a different board
tx_pin = board.TX
rx_pin = board.RX
reset_pin = board.GP23

buildhat = Hat(tx=tx_pin, rx=rx_pin, reset=reset_pin, debug=True)
for port in range(4):
    device = buildhat.get_device(port)
    if device:
        print(f"Port {port}: {device.name}")

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.