Repository files navigation

micropython-esp32-ulp is an assembler toolchain for the ESP32 ULP (Ultra Low-Power)Co-Processor, written in MicroPython.

It can translate small assembly language programs to a loadable/executableULP-FSM (not RISC-V) machine code binary, directly on a ESP32 microcontroller.

This is intended as an alternative approach to assembling such programs usingthebinutils-gdb toolchain(esp32-elf-as) from Espressif on a development machine.

It can also be useful in cases where esp32-elf-as is not available.

The following features are supported:

• the entireESP32 ULP instruction set
• the entireESP32-S2 ULP instruction set(this also covers the ESP32-S3)[1][2]
• constants defined with.set
• constants defined with#define
• expressions in assembly code and constant definitions
• RTC convenience macros (e.g.WRITE_RTC_REG)
• many ESP32 ULP code examples found on the web will work unmodified
• a simple disassembler is also provided

To get going run the following directly on the ESP32:

# IMPORTANT: Ensure the ESP32 is connected to a network with internet connectivity.# Step 1: Install micropython-esp32-ulp (for MicroPython v1.20 or newer)importmipmip.install('github:micropython/micropython-esp32-ulp')# Step 1: Install micropython-esp32-ulp (for MicroPython older than v1.20)importupipupip.install('micropython-esp32-ulp')# Step 2: Run an example# First, upload examples/counter.py to the ESP32.importcounter

Theexamples/counter.py example shows how to assemble code,load and run the resulting binary and exchange data between the ULP and the main CPU.

Seedocs/index.rst.

The minimum supported version of MicroPython is v1.12. (For ESP32-S2 and S3devices, a version greater than v1.20 is required as versions before thatdid not enable theesp32.ULP class).

An ESP32 device is required to run the ULP machine code binary produced bymicropython-esp32-ulp.

This project is released under theMIT License.