circuitpython/mpy-cross
Jeff Epler ef3ec93c8b Change the first byte of CircuitPython 'mpy' files to "C"
.. and also distinguish CircuitPython better in `mpy-cross --version`
2021-05-05 18:06:06 -05:00
..
.gitignore Add license to some obvious files. 2020-07-06 19:16:25 +01:00
Makefile Merge MicroPython v1.11 into CircuitPython 2021-04-26 15:47:41 -07:00
Makefile.fuzz Add license to some obvious files. 2020-07-06 19:16:25 +01:00
Makefile.static Add license to some obvious files. 2020-07-06 19:16:25 +01:00
Makefile.static-aarch64 Build an aarch64 version of mpy-cross 2021-05-05 14:43:53 -05:00
Makefile.static-mingw Add license to some obvious files. 2020-07-06 19:16:25 +01:00
Makefile.static-raspbian remove trailing whitespace 2020-08-16 21:33:36 -05:00
README.md Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
fmode.c run code formatting script 2021-03-15 19:27:36 +05:30
fmode.h Add license to some obvious files. 2020-07-06 19:16:25 +01:00
gccollect.c Merge MicroPython v1.11 into CircuitPython 2021-04-26 15:47:41 -07:00
main.c Change the first byte of CircuitPython 'mpy' files to "C" 2021-05-05 18:06:06 -05:00
mpconfigport.h Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
mphalport.h Merge MicroPython 1.10 into CircuitPython 2021-04-21 15:59:17 -07:00
mpy-cross.mk Merge MicroPython 1.10 into CircuitPython 2021-04-21 15:59:17 -07:00
mpy-cross.vcxproj Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
qstrdefsport.h Add license to some obvious files. 2020-07-06 19:16:25 +01:00

README.md

MicroPython cross compiler

This directory contains the MicroPython cross compiler, which runs under any Unix-like system and compiles .py scripts into .mpy files.

Build it as usual:

$ make

The compiler is called mpy-cross. Invoke it as:

$ ./mpy-cross foo.py

This will create a file foo.mpy which can then be copied to a place accessible by the target MicroPython runtime (eg onto a pyboard's filesystem), and then imported like any other Python module using import foo.

Different target runtimes may require a different format of the compiled bytecode, and such options can be passed to the cross compiler. For example, the unix port of MicroPython requires the following:

$ ./mpy-cross -mcache-lookup-bc foo.py

If the Python code contains @native or @viper annotations, then you must specify -march to match the target architecture.

Run ./mpy-cross -h to get a full list of options.

The optimisation level is 0 by default. Optimisation levels are detailed in https://docs.micropython.org/en/latest/library/micropython.html#micropython.opt_level