Skip to content
CircuitPython DisplayIO Driver for ST7789 Color TFT Controller
Branch: master
Clone or download
ladyada Merge pull request #5 from makermelissa/master
Updated examples to be more comprehensive
Latest commit c3a7deb Aug 8, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Initial Commit Mar 21, 2019
examples Updated examples to be more comprehensive Aug 8, 2019
.gitignore Added example for new 320x240 display Jul 22, 2019
.pylintrc Initial Commit Mar 21, 2019
.readthedocs.yml Initial Commit Mar 21, 2019
.travis.yml Initial Commit Mar 21, 2019 Initial Commit Mar 21, 2019
LICENSE Initial Commit Mar 21, 2019
README.rst Simplified example Apr 27, 2019 fixed order of init commands Mar 27, 2019
requirements.txt Initial Commit Mar 21, 2019



Documentation Status Discord Build Status

displayio driver for ST7789 TFT-LCD displays.


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

import board
import displayio
from adafruit_st7789 import ST7789

spi = board.SPI()
while not spi.try_lock():
spi.configure(baudrate=24000000) # Configure SPI for 24MHz
tft_cs = board.D5
tft_dc = board.D6

display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9)

display = ST7789(display_bus, width=240, height=240, rowstart=80)

# Make the display context
splash = displayio.Group(max_size=10)

color_bitmap = displayio.Bitmap(240, 240, 1)
color_palette = displayio.Palette(1)
color_palette[0] = 0xFF0000

bg_sprite = displayio.TileGrid(color_bitmap,
                               x=0, y=0)

while True:


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

Building locally

Zip release files

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-st7789 --library_location .

Sphinx documentation

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs
sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.

You can’t perform that action at this time.