Mirror of micropython/micropython@github.com - Python for microcontrollers
Go to file
Paul Sokolovsky d5df6cd44a Replace global "static" -> "STATIC", to allow "analysis builds". Part 1.
Some tools do not support local/static symbols (one example is GNU ld map file).
Exposing all functions will allow to do detailed size comparisons, etc.

Also, added bunch of statics where they were missing, and replaced few identity
functions with global mp_identity().
2014-02-12 18:21:11 +02:00
examples Rename "rawsocket" module to "microsocket". 2014-02-08 21:20:32 +02:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py Replace global "static" -> "STATIC", to allow "analysis builds". Part 1. 2014-02-12 18:21:11 +02:00
stm stm: Add specific UINT_FMT and INT_FMT. 2014-02-11 21:58:08 +00:00
teensy Bah - Removed a couple of warnings for teensy that I didn't notice before. 2014-02-10 21:33:03 -08:00
tests basics/enumerate.py: Don't turn enumerate test into heap test. 2014-02-11 15:34:32 +02:00
tools Change dfu.py to be Python 2/3 compatible 2014-01-03 08:51:02 +02:00
unix Merge pull request #278 from pfalcon/unix-gc 2014-02-11 21:42:09 +00:00
unix-cpy Add mp_import_stat to unix-cpy port. 2014-02-06 09:52:53 +00:00
windows Use qstr id to create sys module. 2014-02-04 19:36:00 +02:00
.gitignore Added memzip filesystem support for teensy 2014-01-11 16:16:20 -08:00
CODECONVENTIONS.md Add CODECONVENTIONS, and modify i2c module to conform. 2013-12-29 12:12:25 +00:00
LICENSE Add LICENSE and README. 2013-12-20 11:47:41 +00:00
README.md Small changes to README. 2014-01-19 18:18:43 +00:00

README.md

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. The software will not start to mature until March 2014 at the earliest.

See the repository www.github.com/micropython/pyboard for the Micro Python board. At the moment, finalising the design of the board is the top priority.

Major components in this repository:

  • py/ -- the core Python implementation, including compiler and runtime.
  • unix/ -- a version of Micro Python that runs on Unix.
  • stm/ -- a version of Micro Python that runs on the Micro Python board with an STM32F405RG.
  • teensy/ -- a version of Micro Python that runs on the Teensy 3.1 (preliminary but functional).

Additional components:

  • unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
  • tests/ -- test framework and test scripts.
  • tools/ -- various tools.
  • 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 (2.7 or 3.3) for the stm port.

The Unix version

The "unix" part requires a standard Unix environment with gcc and GNU make. It works only for 64-bit machines due to a small piece of x86-64 assembler for the exception handling.

To build:

$ cd unix
$ make

Then to test it:

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

Ubuntu and Mint derivatives will require build-essentials and libreadline-dev packages installed.

The STM version

The "stm" part 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 stm
$ make

Then to flash it 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.