Linaro Git Browser
Code Review Sign In
review.linaro.org / lite / micropython / 96eca22322e45aa8b6e7e611eabe4e5c6fb93c90 / . / esp8266
tree: 70e2c0724fb17a8b57a7f0e79ae1d87dd1e7d72d [path history] [tgz]
  1. scripts/
  2. tests/
  3. eagle.rom.addr.v6.ld
  4. esp8266.ld
  5. esp_mphal.c
  6. esp_mphal.h
  7. espneopixel.c
  8. espneopixel.h
  9. esppwm.c
  10. esppwm.h
  11. ets_alt_task.c
  12. ets_alt_task.h
  13. etshal.h
  14. fatfs_port.c
  15. gccollect.c
  16. gccollect.h
  17. gchelper.s
  18. lexerstr32.c
  19. main.c
  20. Makefile
  21. makeimg.py
  22. modesp.c
  23. modmachine.c
  24. modnetwork.c
  25. modonewire.c
  26. modpyb.c
  27. modpyb.h
  28. modpybadc.c
  29. modpybi2c.c
  30. modpybpin.c
  31. modpybpwm.c
  32. modpybrtc.c
  33. modpybrtc.h
  34. modpybspi.c
  35. moduos.c
  36. modutime.c
  37. mpconfigport.h
  38. qstrdefsport.h
  39. README.md
  40. strtoll.c
  41. uart.c
  42. uart.h
  43. uart_register.h
  44. user_config.h
  45. utils.c
  46. utils.h
esp8266/README.md

MicroPython port to ESP8266

This is a highly experimental port of MicroPython for the WiFi modules based on Espressif ESP8266 chip.

WARNING: The port is highly experimental and any APIs are subject to change.

Currently implemented features include:

  • REPL (Python prompt) over UART0.
  • Garbage collector, exceptions.
  • Unicode support.
  • Builtin modules: gc, array, collections, io, struct, sys, esp, network, many more.
  • Arbitrary-precision long integers and 30-bit precision floats.
  • Basic WiFi support.
  • Sockets using modlwip.
  • GPIO and bit-banging I2C, SPI support.
  • 1-Wire and WS2812 (aka Neopixel) protocols support.

On the TODO list:

  • Full wifi support.
  • Internal filesystem using the flash.
  • ...

Work-in-progress documentation is available at http://docs.micropython.org/en/latest/esp8266/ .

Build instructions

The tool chain required for the build is the OpenSource ESP SDK, which can be found at https://github.com/pfalcon/esp-open-sdk. Clone this repository and run make in its directory to build and install the SDK locally. Make sure to add toolchain bin directory to your PATH. Read esp-open-sdk's README for additional important information on toolchain setup.

Add the external dependencies to the MicroPython repository checkout:

$ git submodule update --init

See the README in the repository root for more information about external dependencies.

Then, to build MicroPython for the ESP8266, just run:

$ cd esp8266
$ make

This will produce binary images in the build/ subdirectory. If you install MicroPython to your module for the first time, or after installing any other firmware, you should erase flash completely:

esptool.py --port /dev//ttyXXX erase_flash

Erase flash also as a troubleshooting measure, if a module doesn't behave as expected.

To flash MicroPython image to your ESP8266, use:

$ make deploy

This will use the esptool.py script to download the images. You must have your ESP module in the bootloader mode, and connected to a serial port on your PC. The default serial port is /dev/ttyACM0. To specify another, use, eg:

$ make PORT=/dev/ttyUSB0 deploy

The image produced is firmware-combined.bin, to be flashed at 0x00000.