You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
stijn 12fab63928
lib: Replace tabs with spaces in readline.c
7 years ago
bare-arm Makefiles: Remove duplicate object files when linking. 7 years ago
cc3200 cc3200: Update README to change pyb to machine. 7 years ago
docs docs/wipy: Fix several typos. 7 years ago
drivers drivers/sdcard: Allow up to 5 retries to initialise SD card. 7 years ago
esp8266 Makefiles: Remove duplicate object files when linking. 7 years ago
examples changed file paths to new names 8 years ago
extmod extmod/moductypes: Implement buffer protocol. 7 years ago
lib lib: Replace tabs with spaces in readline.c 7 years ago
logo logo: Change line endings in FONT-LICENSE.txt from CRLF to LF. 8 years ago
minimal Makefiles: Remove duplicate object files when linking. 7 years ago
pic16bit Makefiles: Remove duplicate object files when linking. 7 years ago
py Makefiles: Remove duplicate object files when linking. 7 years ago
qemu-arm Makefiles: Remove duplicate object files when linking. 7 years ago
stmhal stmhal: Fix USB_VCP.recv so that it returns actual amount of bytes read. 7 years ago
teensy Makefiles: Remove duplicate object files when linking. 7 years ago
tests tests/jni: Test for basic object operations. 7 years ago
tools tools/pyboard: Add -c argument to run a program passed as a string. 7 years ago
unix unix/modjni: Actually check argument type when doing method resolution. 7 years ago
windows windows: Erase pre-calc'd number of chars instead of clearing whole line. 7 years ago
.gitattributes Add .gitattributes file to force text line endings to LF. 8 years ago
.gitignore msvc: Allow overriding of build options with custom file 8 years ago
.gitmodules lib/lwip: Add LwIP stack as a submodule in the library directory 7 years ago
.travis.yml travis: Build "deplibs" in unix port. 7 years ago
ACKNOWLEDGEMENTS Rename "Micro Python" to "MicroPython" in REPL, help, readme's and misc. 7 years ago
CODECONVENTIONS.md Rename "Micro Python" to "MicroPython" in REPL, help, readme's and misc. 7 years ago
CONTRIBUTING.md CONTRIBUTING.md: Link to contrib guidelines and code conventions. 8 years ago
LICENSE Add license header to (almost) all files. 9 years ago
README.md README: Document how to enable/build external dependencies. 7 years ago

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

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.). 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 MicroPython that runs on Unix.
  • stmhal/ -- a version of MicroPython that runs on the MicroPython board with an STM32F405RG (using ST's Cube HAL drivers).
  • minimal/ -- a minimal MicroPython port. Start with this if you want to port MicroPython to another microcontroller.

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.
  • 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])

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