Skip to content

adafruit/Adafruit_CircuitPython_RGB_Display

Repository files navigation

Introduction

Discord

Port of display drivers from https://github.com/adafruit/micropython-adafruit-rgb-display to Adafruit CircuitPython for use on Adafruit's SAMD21-based and other CircuitPython boards.

This driver depends on the Adafruit CircuitPython BusDevice module being installed on the board too: https://github.com/adafruit/Adafruit_MicroPython_BusDevice

Note that this driver currently won't work on micropython.org firmware, instead you want the micropython-adafruit-rgb-display driver linked above!

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

TODO

API Reference

.. toctree::
   :maxdepth: 2

   api

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Building locally

To build this library locally you'll need to install the circuitpython-build-tools package.

python3 -m venv .env
source .env/bin/activate
pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

source .env/bin/activate

Then run the build:

circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgb_display --library_location .