Go to file
David Steinberg 0b3014ce3a py: Add support for floats in mp_binary_{get,set}_val()
- This then provides support for floats in the struct package
2015-01-27 22:49:01 +02:00
bare-arm py: Add config option MICROPY_COMP_MODULE_CONST for module consts. 2015-01-10 14:07:24 +00:00
docs docs: Bump version to 1.3.9. 2015-01-25 00:10:07 +00:00
drivers drivers/cc3000: Fix call to extint_register. 2015-01-07 23:54:19 +00:00
esp8266 esp8266: Handle exceptions in callback. 2015-01-25 17:41:06 +02:00
examples changed file paths to new names 2014-10-25 23:59:33 +01:00
extmod moduzlib: Update to uzlib v1.2. 2015-01-26 22:01:45 +02:00
lib lib/mp-readline: Use simple VT100 commands to speed up line redraw. 2015-01-25 18:26:07 +00:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
minimal py: Implement very simple frozen modules support. 2015-01-20 11:52:12 +02:00
py py: Add support for floats in mp_binary_{get,set}_val() 2015-01-27 22:49:01 +02:00
qemu-arm qemu-arm: Enable GC and native code-gen; enable more tests. 2015-01-12 12:07:42 +00:00
stmhal stmhal: Disable MICROPY_OPT_CACHE_MAP_LOOKUP_IN_BYTECODE. 2015-01-24 23:45:37 +00:00
teensy teensy: Update for readline module moved to lib/. 2015-01-12 04:27:36 +02:00
tests py: Add support for floats in mp_binary_{get,set}_val() 2015-01-27 22:49:01 +02:00
tools qemu-arm: Disable try_finally1.py test (it fails randomly on Travis). 2015-01-25 18:48:03 +00:00
unix modffi: 's' (string) return type: handle NULL properly (return None). 2015-01-25 01:36:14 +02:00
unix-cpy unix-cpy: Prefix includes with py/; remove need for -I../py. 2015-01-01 20:41:52 +00:00
windows windows: Enable MICROPY_STACK_CHECK. 2015-01-12 15:34:53 +00:00
.gitignore Add GNUmakefile to the .gitignore file. 2014-07-24 00:09:56 -07:00
.travis.yml travis, minimal: Install gcc-multilib for -m32; use /bin/echo for test. 2015-01-14 00:26:39 +00:00
CODECONVENTIONS.md Updated CODECONVENTIONS to clarify use of integer types. 2014-09-25 15:49:26 +01:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md README: Update link to logo. 2014-11-17 00:41:54 +00: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 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.
  • 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 ARM and MIPS. Making full-featured port to another architecture requires writing 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 and libreadline-dev packages installed. To build FFI (Foreign Function Interface) module, libffi-dev and pkg-config packages are 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 0483:df11 -D build-PYBV10/firmware.dfu

Building the documentation locally

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

 pip install sphinx
 pip install sphinx_rtd_theme

In micropython/docs, build the docs:

make html

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