Go to file
Damien George 1084b0f9c2 py: Store bytecode arg names in bytecode (were in own array).
This saves a lot of RAM for 2 reasons:

1. For functions that don't have default values, var args or var kw
args (which is a large number of functions in the general case), the
mp_obj_fun_bc_t type now fits in 1 GC block (previously needed 2 because
of the extra pointer to point to the arg_names array).  So this saves 16
bytes per function (32 bytes on 64-bit machines).

2. Combining separate memory regions generally saves RAM because the
unused bytes at the end of the GC block are saved for 1 of the blocks
(since that block doesn't exist on its own anymore).  So generally this
saves 8 bytes per function.

Tested by importing lots of modules:

- 64-bit Linux gave about an 8% RAM saving for 86k of used RAM.
- pyboard gave about a 6% RAM saving for 31k of used RAM.
2014-10-25 20:23:13 +01:00
bare-arm py: Add builtin memoryview object (mostly using array code). 2014-10-23 13:34:35 +01:00
docs docs: Make images and youtube video links work for LCD and AMP docs. 2014-09-25 19:42:27 +01:00
drivers drivers: Add NRF24L01 driver (written in pure Python). 2014-10-02 19:36:56 +01:00
examples examples: Update conwaylife to work with new LCD API. 2014-10-19 19:02:34 +01:00
extmod extmod: Add uheapq module. 2014-10-22 23:20:15 +01:00
lib lib: Add basic README. 2014-09-18 00:13:03 +01:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py py: Store bytecode arg names in bytecode (were in own array). 2014-10-25 20:23:13 +01:00
qemu-arm Implement kwargs for builtin open() and _io.FileIO 2014-10-21 22:10:01 +03:00
stmhal stmhal: Change fresh boot.py and main.py to use \r\n newlines. 2014-10-25 01:14:39 +01:00
teensy stmhal: Overhaul UART class to use read/write, and improve it. 2014-10-21 22:15:20 +01:00
tests stream: Add optional 2nd "length" arg to .readinto() - extension to CPython. 2014-10-23 21:43:59 +03:00
tools tools, pydfu: Some fixes to support Python 3. 2014-10-22 20:27:43 +01:00
unix unix: Allow -X heapsize= option take numbers with K & M suffixes. 2014-10-25 17:00:55 +01:00
unix-cpy py: Make compiler return a proper exception on SyntaxError. 2014-10-05 19:01:34 +01:00
windows windows: Enable moduzlib instead of modzlibd. 2014-10-13 14:12:32 +03:00
.gitignore Add GNUmakefile to the .gitignore file. 2014-07-24 00:09:56 -07:00
.travis.yml travis: Install realpath, required for teensy build. 2014-10-06 23:49:17 +03: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 "unix" section with more info/details. 2014-10-11 20:45:32 +03:00

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