ESP32 / MicroPython board¶
Who: You have a MicroPython board (ESP32-S3, WT32-SC01, etc.) and want pydisplay running on hardware.
Prerequisites: USB serial access, mpremote on your PC. No prior pydisplay install.
1. Pick a board config¶
Find your hardware in board configs. Example for WT32-SC01 Plus:
board_configs/busdisplay/i80/wt32sc01-plus
Don't see your board? Use the closest match or contribute a config.
2. Install packages¶
Option A — installer.py (recommended):
Follow installer.py on the device or via mpremote run.
Option B — MIP from your PC:
mpremote mip install "github:PyDevices/pydisplay/board_configs/busdisplay/i80/wt32sc01-plus"
mpremote mip install "github:PyDevices/pydisplay/packages/pydisplay-bundle.json"
Option C — minimum packages only:
3. Run hello¶
From the repo src/ on your PC:
mpremote mount .
At the device REPL:
import lib.path
import hello
If packages are installed into /lib on the device (no mount), skip lib.path:
import hello
4. Try events¶
import lib.path
import eventsys_simpletest
Next¶
- Examples catalog — suggested learning order
- Events concept — broker poll loop
- MicroPython platform notes — bus drivers, frozen firmware
- Troubleshooting
Reference¶
- API reference (core) →
displaysys,eventsys