The MicroPython project
 
 
 
 
 
 
Go to file
Damien George 04b9147e15 Add license header to (almost) all files.
Blanket wide to all .c and .h files.  Some files originating from ST are
difficult to deal with (license wise) so it was left out of those.

Also merged modpyb.h, modos.h, modstm.h and modtime.h in stmhal/.
2014-05-03 23:27:38 +01:00
bare-arm bare-arm, qemu-arm: Make "mpconfig.h" be first included, as other headers depend on it. 2014-05-02 18:23:23 +03:00
examples py: Big improvements to inline assembler. 2014-04-13 00:30:32 +01:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
qemu-arm bare-arm, qemu-arm: Make "mpconfig.h" be first included, as other headers depend on it. 2014-05-02 18:23:23 +03:00
stm stm: Update to compile with latest changes to core py. 2014-04-20 00:15:35 +01:00
stmhal Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
teensy build: Simplify build directory layout by putting all headers in genhdr. 2014-04-17 18:03:27 +01:00
tests py, stream: Implement readlines for a stream. 2014-05-03 22:01:32 +01:00
tools tools: pyboard.py now acts as a command-line program to run scripts. 2014-05-03 18:14:34 +01:00
unix Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
unix-cpy Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
windows Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
.gitignore Ignore .exe files 2014-05-03 10:21:07 +02:00
.travis.yml travis: should test building qemu-arm as well. 2014-04-21 21:10:15 +01:00
CODECONVENTIONS.md Add Python code conventions to CODECONVENTIONS. 2014-04-18 12:46:46 +01:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md Fixed Travis-CI Build Status Link in README.md 2014-04-14 21:52:22 -05:00

README.md

[![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

The Micro Python project

MicroPython Logo

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

WARNING: this project is in its early stages and is subject to large changes of the code-base, including project-wide name changes and API changes.

See the repository www.github.com/micropython/pyboard for the Micro Python 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 board with an STM32F405RG (using ST's new 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. Start with this if you want to port Micro Python to another microcontroller.
  • stm/ -- obsolete version of Micro Python for the Micro Python board that uses ST's old peripheral drivers.
  • 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 version

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 well as ARMv7. Porting to other architectures require writing some assembly code for the exception handling.

To build:

$ cd unix
$ make

Then to test it:

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

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

The STM version

The "stmhal" port requires an ARM compiler, arm-none-eabi-gcc, and associated bin-utils. For those using Arch Linux, you need arm-none-eabi-binutils and arm-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 the 3V3 pin to the P1/DFU pin with a wire (on PYBv1.0 they are next to each other on the bottom left of the board, second row from the bottom).

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

$ dfu-util -a 0 -D build/flash.dfu

You will need the dfu-util program, on Arch Linux it's dfu-util-git in the AUR.