Lerking/micropython

Fork 0

mirror of https://github.com/micropython/micropython.git synced 2026-02-13 14:40:18 +01:00

Table of Contents

Index to other wiki pages

Getting started and essentials
Development in MicroPython
MicroPython Internals
Hardware APIs and peripherals
Contributing to MicroPython
Development of MicroPython
Debugging, reliability, and security
Libraries, ports, and deployment
Community and meta
Supported Boards

STM32 boards and hardware (historical)
Other Boards and hardware (historical)

Board resources
Outdated / legacy pages
Timers and timebases (STM32 specific)

Index to other wiki pages

Getting started and essentials

Getting Started — build and setup overview.
Learn MicroPython — language basics for MicroPython.
FAQ — common questions and quick answers.
Examples — starter code snippets and demos.
Tips and Tricks — practical advice and shortcuts.
Differences — CPython vs MicroPython differences.

Development in MicroPython

Developing on a Microcontroller — workflow tips for on-device development.

Soft Reset — reset behavior and recovery.
VS Code — VSCode editor setup tips.
Threads — threading notes and status.
Standard Library Coverage — module support matrix.
Collections Module — status of collections types.
Viper Performance — speed up with Viper.
Floating Point Support — float precision and tradeoffs.

MicroPython Internals

Memory Manager — GC and allocation internals.

Hardware APIs and peripherals

Hardware API — design goals and principles.
Driver API Design Guidelines — driver API guidance.

Contributing to MicroPython

Adding Board Profiles — how to add a new board profile.
New Port Development Guide — porting
Bundling and Deploying Code — firmware bundling notes.MicroPython.
Git Development Workflow — rebase and workflow notes.
Contributor Guidelines — contributing and code of conduct.

Development of MicroPython

Building MicroPython Binaries — Building MicroPython for different boards.
Build Troubleshooting — common build issues.

ESP32 Docker Build — containerized build workflow.
Getting Started (STM) — STM toolchain setup.
Getting Started (Ubuntu 16.04) — legacy Linux build notes.
MicroPython on macOS — build instructions for macOS.
Board Profile for RomFS — profile config notes.
LTO — link-time optimization guidance.
MicroPython Configuration Macros — MICROPY_* macro reference.
MicroPython MP Macros — MP_* macro reference.
Mboot Configuration Macros — MBOOT_* macro reference.
MIMXRT Configuration Macros — MIMXRT_* macro reference.
Pyboard Firmware Update — flashing official firmware.

Debugging, reliability, and security

ESP32 Debugging — debugging the ESP32 port.
Pyboard Debugging (ST-Link v2) — programming and debugging guide.
Symbolic Debugging for STM32 — symbolic debug workflow.
Instrumenting with GPIOs — GPIO-based instrumentation.
Watchdogs and Crash Recovery — reliability techniques.
Securing a MicroPython System — security guidance.
PPP on ESP32 — USB-UART PPP setup.

Libraries, ports, and deployment

Community and meta

Supported Boards

Please refer to the MicroPython download pages for the latest supported boards and firmware.

The below pages are retained for historical reference.

Boards Summary — overview of supported boards.

STM32 boards and hardware (historical)

Board: NUCLEO-F401RE — board profile notes.
Board: Nucleo-F767ZI — board profile notes.
Board: STM32F401 Discovery — board profile notes.
Board: STM32F407 Discovery — board profile notes.
Board: STM32F429 — board profile notes.
Board: STM32F746 Discovery — board profile notes.
Board: BLACK-F407VE — board profile notes.
Board: BLACK-F407ZE — board profile notes.
Board: BLACK-F407ZG — board profile notes.
Board: Olimex STM32-405STK — board profile notes.
Board: Olimex STM32-E407 — board profile notes.
Board: STM32F407VET6 Mini — board profile notes.
Board: HY-STM32F4xxCore144 — board profile notes.

Other Boards and hardware (historical)

Board: FreeSOC — board profile notes.
Board: Arduino Due — board profile notes.
Board: Crazyflie 2 — board profile notes.
Board: Espruino Pico — board profile notes.
Board: FEZ Cerb40 II — board profile notes.
Board: FEZ Cerb40 — board profile notes.
Board: FEZ Lemur — board profile notes.
Board: G30HDR — board profile notes.
Board: HydraBus V1.0 — board profile notes.
Board: Netduino Plus 2 — board profile notes.
Board: OpenMV — board profile notes.
Board: Teensy 3.1/3.5/3.6 — board profile notes.
Board: Tiva TM4C123G Launchpad — board profile notes.

Board resources

Outdated / legacy pages

Servos — controlling hobby servos.
LCD Driver — notes on an LCD driver API.
STM32F405 Pinouts — pinout references.
Building st-flash — flashing tool setup.
MicroPython vs eLua — comparative notes.
Cross Branch — cross branch overview.
Performance — performance notes and benchmarks.
Projects Using MicroPython — community project list.

Timers and timebases (STM32 specific)

Timer Implementation — internal timer design notes.
Timer Capture Mode — capture and compare setup.
Timer One Shot — one-shot configuration.
STM32 PWM Timers — PWM timer usage.
STM32F405 Timer Triggering — trigger examples.
Timebase and Clock Sources — clock source notes.