MicroPython ported to the ESP32
C C++ Python Objective-C Makefile HTML Other
Failed to load latest commit information.
bare-arm py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. Oct 21, 2016
cc3200 extmod/moduselect: Use configurable EVENT_POLL_HOOK instead of WFI. Dec 2, 2016
docs docs/library/pyb.UART: Moved writechar doc to sit with other writes. Dec 14, 2016
drivers drivers/display/ssd1306.py: Update to use FrameBuffer not FrameBuffer1 Dec 1, 2016
esp32 esp32/modsocket: Add support for DGRAM and RAW, and sendto/recvfrom. Jan 18, 2017
esp8266 esp8266: Add "erase" target to Makefile, to erase entire flash. Dec 15, 2016
examples examples/accellog.py: Change 1: to /sd/, and update comment about FS. Nov 18, 2016
extmod extmod/modframebuf: Store underlying buffer object to prevent GC free. Dec 9, 2016
lib lib/utils/interrupt_char: Use core-provided mp_kbd_exception if enabled. Dec 15, 2016
logo logo/1bit-logo A black & white version of the logo Aug 2, 2016
minimal minimal/Makefile: Split rule for firmware.bin generation. Oct 22, 2016
mpy-cross mpy-cross: Get compiling after recent persistent code refactors. Nov 16, 2016
pic16bit py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. Oct 21, 2016
py py: Add MICROPY_KBD_EXCEPTION config option to provide mp_kbd_exception. Dec 15, 2016
qemu-arm qemu-arm: Enable software floating point support, and float tests. Nov 3, 2016
stmhal stmhal: Use core-provided keyboard exception object. Dec 15, 2016
teensy py/lexer: Provide generic mp_lexer_new_from_file based on mp_reader. Nov 16, 2016
tests tests/micropython: Get heapalloc_traceback test running on baremetal. Dec 15, 2016
tools tools/pyboard.py: Refactor so target is not reset between scripts/cmd. Dec 15, 2016
unix unix/Makefile: Update freedos target for change of USELECT config name. Nov 21, 2016
windows windows: Enable READER_POSIX to get access to lexer_new_from_file. Nov 16, 2016
zephyr zephyr: Enable slice subscription. Dec 18, 2016
.gitattributes Add .gitattributes file to force text line endings to LF. Apr 16, 2015
.gitignore gitignore: Add "makefile" to global .gitignore file. Dec 19, 2016
.gitmodules lib/berkeley-db-1.xx: Add Berkeley DB 1.85 as a submodule. Jun 14, 2016
.travis.yml travis: Build STM32 F7 and L4 boards under Travis CI. Dec 5, 2016
ACKNOWLEDGEMENTS ACKNOWLEDGEMENTS: Change backer 905 info, replace city with name. Oct 22, 2016
CODECONVENTIONS.md CODECONVENTIONS.md: Describe git commit messages conventions. May 7, 2016
CONTRIBUTING.md CONTRIBUTING.md: Link to contrib guidelines and code conventions. May 3, 2015
LICENSE Add license header to (almost) all files. May 3, 2014
README.md README.md: Add note about the ESP32 port. Dec 19, 2016


Build Status Coverage Status

The MicroPython project

MicroPython Logo

This is the MicroPython project, which aims to put an implementation of Python 3.x on microcontrollers and small embedded systems. You can find the official website at micropython.org.

A note about this ESP32 repository

This repository is a clone of the main, upstream repository found at https://github.com/micropython/micropython. This repository adds a new branch called esp32 which contains a port of MicroPython to the ESP32 microcontroller, under the MIT license. Please see the README.md file in the esp32/ subdirectory for details of this port.

This esp32 branch is the default branch and all pull requests should be made to this branch, and any issues should discuss only the code developed in the esp32/ subdirectory.

The esp32 branch will not be rebased so it is safe to clone/fork it and base your work on it. New commits from the upstream repository will occasionally be merged in the esp32 branch. Any additional branches in this repository (apart from master) may be rebased or deleted at any time.

If there is enough interest in the port to the ESP32 then this code can eventually be merged into the upstream repository. So please do let your interest be known!

About MicroPython

WARNING: this project is in beta stage and is subject to changes of the code-base, including project-wide name changes and API changes.

MicroPython implements the entire Python 3.4 syntax (including exceptions, "with", "yield from", etc., and additionally "async" keyword from Python 3.5). 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, etc. Select ports have support for _thread module (multithreading). 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 MicroPython board (PyBoard), 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 MicroPython that runs on Unix.
  • stmhal/ -- a version of MicroPython that runs on the PyBoard and similar STM32 boards (using ST's Cube HAL drivers).
  • minimal/ -- a minimal MicroPython port. Start with this if you want to port MicroPython to another microcontroller.
  • tests/ -- test framework and test scripts.
  • docs/ -- user documentation in Sphinx reStructuredText format.

Additional components:

  • bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used mostly to control code size.
  • teensy/ -- a version of MicroPython that runs on the Teensy 3.1 (preliminary but functional).
  • pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
  • cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
  • esp8266/ -- an experimental port for ESP8266 WiFi modules.
  • tools/ -- various tools, including the pyboard.py module.
  • examples/ -- a few example Python scripts.

The subdirectories above may include READMEs with additional info.

"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 (see section below for required dependencies):

$ cd unix
$ make axtls
$ make

Then to give it a try:

$ ./micropython
>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])

Use CTRL-D (i.e. EOF) to exit the shell. Learn about command-line options (in particular, how to increase heap size which may be needed for larger applications):

$ ./micropython --help

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.

External dependencies

Building Unix version requires some dependencies installed. For Debian/Ubuntu/Mint derivative Linux distros, install build-essential (includes toolchain and make), libffi-dev, and pkg-config packages.

Other dependencies can be built together with MicroPython. Oftentimes, you need to do this to enable extra features or capabilities. To build these additional dependencies, first fetch git submodules for them:

$ git submodule update --init

Use this same command to get the latest versions of dependencies, as they are updated from time to time. After that, in unix/ dir, execute:

$ make deplibs

This will build all available dependencies (regardless whether they are used or not). If you intend to build MicroPython with additional options (like cross-compiling), the same set of options should be passed to make deplibs. To actually enabled use of dependencies, edit unix/mpconfigport.mk file, which has inline descriptions of the options. For example, to build SSL module (required for upip tool described above), set MICROPY_PY_USSL to 1.

In unix/mpconfigport.mk, you can also disable some dependencies enabled by default, like FFI support, which requires libffi development files to be installed.

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. 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

This will use the included tools/pydfu.py script. If flashing the firmware does not work it may be because you don't have the correct permissions, and need to use sudo make deploy. See the README.md file in the stmhal/ directory for further details.