rgb-display

Portable library for RGB displays.


Keywords
adafruit, rgb, display, hx8353, ili9341, s6d02A1, ssd1331, ssd1351, st7735hardware, micropython, circuitpython
License
MIT
Install
pip install rgb-display==0.0.5

Documentation

Introduction

Documentation Status Discord Build Status

Generalization of display drivers from https://github.com/adafruit/adafruit-circuitpython-rgb-display to remove platform dependencies.

This driver currently supports displays that use the following display-driver chips: HX8353, HX8357, ILI9341, S6D02A1, ST7789, SSD1331, SSD1351, and ST7735 (including variants ST7735R and ST7735S).

Dependencies

This driver has no particular dependencies. It accepts pins and SPI devices compatible with MicroPython machine.Pin and machine.SPI, including gpiozero.OutputDevice pins. Objects can be adapted to fit, for example with spidev the SPI object can be given spi.send = spi.xfer3, or digitalio pins can have pin.on = lambda s: s.value = 1 to create a pin.on() member.

For improved performance consider installing NumPy.

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 rgb-display

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

sudo pip3 install rgb-display

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 rgb-display

Usage Example

see examples for usage examples.

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.