Skip to content

Config files

Templates for GUI libraries and ported examples live in src/add_ons/. Board-specific setup uses board_configs/ or src/lib/board_config.py.

File Location Required for
board_config.py board_configs/ or src/lib/ Always — display, touch, brokers, setup
path.py src/lib/ Development layout — adds lib/, add_ons/, examples/ to path
color_setup.py src/add_ons/ Nano-GUI — display instance for ssd
gui/ src/add_ons/gui/ Nano-GUIupstream; copy locally (install)
hardware_setup.py src/add_ons/ MicroPython-Touch
tft_config.py src/add_ons/ @russhughes st7789py_mpy examples

Install add-on templates with add_ons package or copy files from a full clone.

board_config.py

Install per-board packages from board configs or copy from the closest match.

The default desktop config is src/lib/board_config.py.

path.py

Import before examples when using the src/ development tree:

import lib.path

Not needed if all packages are installed into /lib on the device.

LVGL

Wire pydisplay through upstream LVGL micropython using your board_config.py display and touch brokers. See GUI: LVGL and the minimum Wokwi project.