Mirror of micropython/micropython@github.com - Python for microcontrollers
Go to file
Paul Sokolovsky 44a949d58c qemu-arm: Disable "io" module. 2014-05-19 22:33:35 +03:00
bare-arm bare-arm: Change output file from flash.elf to firmware.elf. 2014-05-10 13:45:47 +01:00
examples py: Rename byte_code to bytecode everywhere. 2014-05-10 10:36:38 +01:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py py: Implement proper separation between io.FileIO and io.TextIOWrapper. 2014-05-19 21:56:07 +03:00
qemu-arm qemu-arm: Disable "io" module. 2014-05-19 22:33:35 +03:00
stm stm: Reorder mpconfig.h header inclusion to get stm building. 2014-05-10 10:38:38 +01:00
stmhal py: Implement proper separation between io.FileIO and io.TextIOWrapper. 2014-05-19 21:56:07 +03:00
teensy build: Simplify build directory layout by putting all headers in genhdr. 2014-04-17 18:03:27 +01:00
tests tests: Update subclass-native2.py for __new__/__init__ refactor. 2014-05-19 21:56:07 +03:00
tools tools: Move gendoc.py to tools, and make it a little more generic. 2014-05-10 19:12:47 +01:00
unix py: Implement proper separation between io.FileIO and io.TextIOWrapper. 2014-05-19 21:56:07 +03:00
unix-cpy Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
windows windows: Enable frozen set and sys.exit 2014-05-11 19:26:36 +02:00
.gitignore Ignore .exe files 2014-05-03 10:21:07 +02:00
.travis.yml travis: Add cross-compilation of mingw port 2014-05-11 19:33:13 +02: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 README: Add articles, and update doc for deploying firmware. 2014-05-09 12:00:23 +01: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 early beta stage and is subject to large changes of the code-base, including project-wide name changes and API changes.

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. Builtin modules include sys, time, and struct. Note that only subset of Python 3.4 functionality implemented for the data types and modules.

See the repository www.github.com/micropython/pyboard for the Micro Python 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 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:

$ make deploy

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

$ sudo dfu-util -a 0 -D build-PYBV10/firmware.dfu