Skip to content

MicroPython

Platform notes for embedded MCUs and MicroPython on Unix. Quick start: ESP32 board guide.

Embedded (MCU)

Requirements

  1. A board_config.py for your hardware — see board configs.
  2. Core packages (displaysys, eventsys, …) via installer.py or GitHub MIP.
  3. import lib.path before examples (unless installed into /lib).

Quick start with mpremote

See ESP32 board guide for the full install and hello workflow.

Brief version from the repo src/ directory:

mpremote mip install "github:PyDevices/pydisplay/board_configs/busdisplay/i80/wt32sc01-plus"
mpremote mount .

At the device REPL:

import lib.path
import hello

WSL on Windows

Use WSL USB Manager to pass USB serial devices into WSL for mpremote.

Bus drivers

SPI displays use spibus.py; parallel I80 displays use i80bus.py. These install from GitHub only (viper). Board config packages pull them in automatically when needed.

For fastest buses, community C drivers (e.g. lvgl_micropython) can be wired through BusDisplay.

Unix (desktop MicroPython)

Same workflow as CPython desktop, but run micropython -i path.py instead of python3.

Use board_configs/sdldisplay/ or the default src/lib/board_config.py for SDL2-based desktop display.

Frozen firmware

The repo-root manifest.py lists packages for frozen MicroPython builds. See tools/README.md for maintainer details.