Mirror of micropython/micropython@github.com - Python for microcontrollers
Go to file
Damien George b7d59060e2 tools: Make gen-changelog.sh print more lines from the tag annotation. 2015-08-11 13:50:40 +01:00
bare-arm bare-arm: Disable enumerate and reversed builtins to make port more bare. 2015-08-02 20:55:37 +01:00
cc3200 cc3200: Make ADC API compatible with the pyboard. 2015-08-10 23:42:05 +02:00
docs docs: Bump version to 1.4.5. 2015-08-11 13:42:30 +01:00
drivers drivers/onewire: Fix ds18x20.read_temp so it works when no rom given. 2015-07-30 23:10:39 +01:00
esp8266 esp8266: Use m_new/m_renew/m_del funcs instead of private gc_xxx. 2015-07-20 12:14:21 +01:00
examples changed file paths to new names 2014-10-25 23:59:33 +01:00
extmod modmachine: Implement physical memory access using /dev/mem (Linux, etc). 2015-07-08 11:37:23 +03:00
lib lib/mp-readline: Add emacs-style control characters for cursor movement. 2015-07-26 15:22:13 +01:00
logo logo: Change line endings in FONT-LICENSE.txt from CRLF to LF. 2015-04-16 22:12:19 +01:00
minimal minimal: Use 1 byte for qstr hash, to make port more minimal. 2015-08-02 20:54:58 +01:00
pic16bit pic16bit: Add readinto and readlines to qstrs. 2015-05-20 23:12:43 +01:00
py py/makeversionhdr.py: Fallback to using docs version if no git repo. 2015-08-11 12:27:38 +01:00
qemu-arm qemu-arm: Enable array slice assignment to get memoryview1 test to pass. 2015-07-20 15:53:22 +01:00
stmhal stmhal: Use CMSIS_MCU definition from mpconfigboard.mk 2015-08-07 08:54:14 +01:00
teensy stmhal: Factor GPIO clock enable logic into mp_hal_gpio_clock_enable. 2015-08-03 00:14:48 +01:00
tests tests: Remove over-specification of startup banner 2015-08-08 12:37:36 +01:00
tools tools: Make gen-changelog.sh print more lines from the tag annotation. 2015-08-11 13:50:40 +01:00
unix unix/mpconfigport.h: set MICROPY_PY_SYS_PLATFORM to "darwin" if compiled on OSX 2015-08-05 21:18:33 +03:00
unix-cpy py: Overhaul and simplify printf/pfenv mechanism. 2015-04-16 14:30:16 +00:00
windows windows/README: Add notes on running under Wine. 2015-06-04 19:29:51 +03:00
.gitattributes Add .gitattributes file to force text line endings to LF. 2015-04-16 22:23:56 +01:00
.gitignore msvc: Allow overriding of build options with custom file 2015-04-30 10:14:59 +02:00
.travis.yml unix: Make extra-coverage function callable from Python scripts. 2015-05-08 09:18:38 +01:00
ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS: Add 1 backer name to the file. 2015-05-28 08:20:36 +01:00
CODECONVENTIONS.md CODECONVENTIONS: Add a short section about how to allocate heap memory. 2015-07-20 12:18:16 +01:00
CONTRIBUTING.md CONTRIBUTING.md: Link to contrib guidelines and code conventions. 2015-05-03 22:04:52 +01:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md README: Add quick information about builtin upip package manager. 2015-06-22 20:06:12 +03:00

README.md

[![Build Status][travis-img]][travis-repo] [![Coverage Status][coveralls-img]][coveralls-repo] [![Issue Stats][istats-pr-img]][istats-pr-repo] [![Issue Stats][istats-issue-img]][istats-issue-repo] [travis-img]: https://travis-ci.org/micropython/micropython.png?branch=master [travis-repo]: https://travis-ci.org/micropython/micropython [coveralls-img]: https://coveralls.io/repos/micropython/micropython/badge.png?branch=master [coveralls-repo]: https://coveralls.io/r/micropython/micropython?branch=master [istats-pr-img]: http://issuestats.com/github/micropython/micropython/badge/pr [istats-pr-repo]: http://issuestats.com/github/micropython/micropython [istats-issue-img]: http://issuestats.com/github/micropython/micropython/badge/issue [istats-issue-repo]: http://issuestats.com/github/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 microcontrollers and small embedded systems.

WARNING: this project is in beta stage and is subject to 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 (including basic Unicode support), bytes, bytearray, tuple, list, dict, set, frozenset, 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, runtime, and core library.
  • 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).
  • minimal/ -- a minimal Micro Python port. Start with this if you want to port Micro Python to another microcontroller.

Additional components:

  • bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Used mostly to control code size.
  • teensy/ -- a version of Micro Python that runs on the Teensy 3.1 (preliminary but functional).
  • pic16bit/ -- a version of Micro Python for 16-bit PIC microcontrollers.
  • cc3200/ -- a version of Micro Python that runs on the CC3200 from TI.
  • esp8266/ -- an experimental port for ESP8266 WiFi modules.
  • 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.
  • docs/ -- official documentation in RST format.

"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

Unix version comes with a builtin package manager called upip, e.g.:

$ ./micropython -m upip install micropython-pystone
$ ./micropython -m pystone

Browse available modules on PyPI. Standard library modules come from micropython-lib project.

(*) Debian/Ubuntu/Mint derivative Linux distros will require build-essentials, libffi-dev and pkg-config packages installed. 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 MICROPY_PORT=<port_name> BUILDDIR=<port_name>/build html

Where <port_name> can be unix, pyboard, wipy or esp8266.

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