Mirror of micropython/micropython@github.com - Python for microcontrollers
Go to file
Damien George c90f59ec3a py: Add support for emitting native x86 machine code. 2014-09-06 23:06:36 +01:00
bare-arm py: Fix bug where GC collected native/viper/asm function data. 2014-08-24 16:28:17 +01:00
drivers stmhal: Add wiznet5k module, to control WIZnet ethernet adaptor. 2014-09-01 22:52:38 +01:00
examples examples: Added pins.py example script to list pin config/af. 2014-08-24 18:34:38 +01:00
extmod extmod: Fix type-punned-ptr error. 2014-09-02 11:38:45 +01:00
lib/libm lib, libm: Add back dummy definition of tanf. 2014-08-29 23:24:00 +01:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py py: Add support for emitting native x86 machine code. 2014-09-06 23:06:36 +01:00
qemu-arm Declare do_str() function before the implementation 2014-09-01 19:51:12 -07:00
stmhal stmhal, modwiznet5k: Add very minimal documentation. 2014-09-01 22:58:22 +01:00
teensy Update teensy README.md file 2014-08-30 12:21:08 -07:00
tests tests: Enable misc tests on pyboard; output 4 sig figs in rge_sm. 2014-09-06 18:38:55 +01:00
tools pip-micropython: Revert to using PIP_MICROPY_DEST environment var. 2014-08-27 02:53:06 +03:00
unix py: Add support for emitting native x86 machine code. 2014-09-06 23:06:36 +01:00
unix-cpy Put call to qstr_init and mp_init_emergency_exc_buf in mp_init. 2014-08-04 10:05:16 +01:00
windows msvc: Exclude modtermios, include extmod and fix compilation error 2014-09-02 09:00:20 +02:00
.gitignore Add GNUmakefile to the .gitignore file. 2014-07-24 00:09:56 -07:00
.travis.yml tests: Add option to run-tests to enable native emitter. 2014-08-29 19:47:10 +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 README: Add USB VID/PID to dfu-util command. 2014-07-31 18:45:34 +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 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 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 0483:df11 -D build-PYBV10/firmware.dfu