micropython/mpy-cross
stijn 84fa3312cf all: Format code to add space after C++-style comment start.
Note: the uncrustify configuration is explicitly set to 'add' instead of
'force' in order not to alter the comments which use extra spaces after //
as a means of indenting text for clarity.
2020-04-23 11:24:25 +10:00
..
.gitignore mpy-cross: Add new component, a cross compiler for MicroPython bytecode. 2016-02-25 10:12:21 +00:00
Makefile mpy-cross: Do not automatically build mpy-cross, rather do it manually. 2019-06-03 14:44:44 +10:00
README.md mpy-cross/README.md: Add notes about -march and -O. 2019-12-09 14:23:04 +11:00
gccollect.c all: Format code to add space after C++-style comment start. 2020-04-23 11:24:25 +10:00
main.c mpy-cross/main: Print uncaught nlr jump to stderr. 2020-04-16 16:22:25 +10:00
mpconfigport.h all: Format code to add space after C++-style comment start. 2020-04-23 11:24:25 +10:00
mphalport.h mpy-cross: Make build independent of extmod directory. 2018-07-10 14:11:28 +10:00
mpy-cross.vcxproj mpy-cross,windows: Add msvc build of mpy-cross. 2019-09-18 22:16:36 +10:00
qstrdefsport.h mpy-cross: Add new component, a cross compiler for MicroPython bytecode. 2016-02-25 10:12:21 +00: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