Repository files navigation

[![Build Status][travis-img]][travis-repo][travis-img]:https://travis-ci.org/micropython/micropython.png?branch=master[travis-repo]:https://travis-ci.org/micropython/micropython

This is the Micro Python project, which aims to put an implementationof Python 3.x on a microcontroller.

WARNING: this project is in early beta stage and is subject to largechanges of the code-base, including project-wide name changes and APIchanges.

Micro Python implements the entire Python 3.4 syntax (including exceptions,"with", "yield from", etc.). The following core datatypes are provided:str (no Unicode support yet), bytes, bytearray, tuple, list, dict, set,array.array, collections.namedtuple, classes and instances. Builtinmodules include sys, time, and struct. Note that only subset ofPython 3.4 functionality implemented for the data types and modules.

See the repositorywww.github.com/micropython/pyboard for the MicroPython board, the officially supported reference electronic circuit board.

Major components in this repository:

• py/ -- the core Python implementation, including compiler and runtime.
• unix/ -- a version of Micro Python that runs on Unix.
• stmhal/ -- a version of Micro Python that runs on the Micro Python boardwith an STM32F405RG (using ST's Cube HAL drivers).
• teensy/ -- a version of Micro Python that runs on the Teensy 3.1(preliminary but functional).

Additional components:

• bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Startwith this if you want to port Micro Python to another microcontroller.
• unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
• tests/ -- test framework and test scripts.
• tools/ -- various tools, including the pyboard.py module.
• examples/ -- a few example Python scripts.

"make" is used to build the components, or "gmake" on BSD-based systems.You will also need bash and Python (at least 2.7 or 3.3).

The "unix" port requires a standard Unix environment with gcc and GNU make.x86 and x64 architectures are supported (i.e. x86 32- and 64-bit), as wellas ARM and MIPS. Making full-featured port to another architecture requireswriting some assembly code for the exception handling and garbage collection.Alternatively, fallback implementation based on setjmp/longjmp can be used.

To build:

$ cd unix$ make

Then to give it a try:

$ ./micropython>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])

Run complete testsuite:

$ make test

Debian/Ubuntu/Mint derivative Linux distros will require build-essentials andlibreadline-dev packages installed. To build FFI (Foreign Function Interface)module, libffi-dev and pkg-config packages are required. If you have problemswith some dependencies, they can be disabled in unix/mpconfigport.mk .

The "stmhal" port requires an ARM compiler, arm-none-eabi-gcc, and associatedbin-utils. For those using Arch Linux, you need arm-none-eabi-binutils andarm-none-eabi-gcc packages from the AUR. Otherwise, try here:https://launchpad.net/gcc-arm-embedded

To build:

$ cd stmhal$ make

You then need to get your board into DFU mode. On the pyboard, connect the3V3 pin to the P1/DFU pin with a wire (on PYBv1.0 they are next to each otheron the bottom left of the board, second row from the bottom).

Then to flash the code via USB DFU to your device:

$ make deploy

You will need the dfu-util program, on Arch Linux it's dfu-util-git in theAUR. If the above does not work it may be because you don't have thecorrect permissions. Try then:

$ sudo dfu-util -a 0 -d 0483:df11 -D build-PYBV10/firmware.dfu

Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,preferably in a virtualenv:

 pip install sphinx pip install sphinx_rtd_theme

Inmicropython/docs, build the docs:

make html

You'll find the index page atmicropython/docs/build/html/index.html.