circuitpython/esp8266
Damien George 6e87aeb841 esp8266: Implement multistage bootstrap sequence.
Upon start-up, _boot module is executed from frozen files to do early
initialization, e.g. create and mount the flash filesystem. Then
"boot.py" is executed if it exists in the filesystem. Finally, "main.py"
is executed if exists to allow start-on-boot user applications.

This allows a user to make a custom boot file or startup application
without recompiling the firmware, while letting to do early initialization
in Python code.

Based on RFC https://github.com/micropython/micropython/issues/1955.
2016-04-10 14:24:41 +03:00
..
scripts esp8266: Add support for frozen modules 2015-05-06 22:04:20 +01:00
tests esp8266/tests: Add neopixel.py test. 2016-03-26 10:55:29 +02:00
eagle.rom.addr.v6.ld esp8266: Add alternative event loop implementation. 2016-03-11 09:13:31 +07:00
esp8266.ld esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
esp_mphal.c esp8266: Support dedicated REPL loop (aka pull-style). 2016-04-01 14:02:36 +03:00
esp_mphal.h esp8266: Implement input part of dupterm handling. 2016-03-31 19:49:55 +03:00
espneopixel.c esp8266: Add esp.neopixel_write function to bit-bang WS2812 data. 2016-03-26 10:55:21 +02:00
espneopixel.h esp8266: Add esp.neopixel_write function to bit-bang WS2812 data. 2016-03-26 10:55:21 +02:00
esppwm.c esp8266/esppwm.c: Fix IRQ handler prototype. 2016-03-26 00:34:28 +02:00
esppwm.h esp8266: Add PWM support. 2016-03-26 00:32:37 +02:00
ets_alt_task.c esp8266/ets_alt_task: Comment out debug output. 2016-04-03 01:04:01 +03:00
ets_alt_task.h esp8266: Add alternative event loop implementation. 2016-03-11 09:13:31 +07:00
etshal.h esp8266: Implement os.urandom function. 2016-03-29 10:29:57 +03:00
fatfs_port.c esp8266: Enable FatFs support. 2016-03-27 17:13:47 +03:00
gccollect.c esp8266: Don't gc-collect BSS. 2016-03-08 10:16:06 +07:00
gccollect.h esp8266: Fix garbage collector by hard-coding stack end address. 2015-05-06 14:01:07 +01:00
gchelper.s esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
lexerstr32.c esp8266: Store frozen modules in FlashROM. 2016-03-17 23:06:47 +08:00
main.c esp8266: Implement multistage bootstrap sequence. 2016-04-10 14:24:41 +03:00
Makefile esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
makeimg.py esp8266: Minimize gap between Inst/DataRAM segments and FlashROM segment. 2016-04-03 15:45:14 +03:00
modesp.c esp8266: Make destination for vendor OS debug output soft-configurable. 2016-04-06 00:12:58 +03:00
modmachine.c esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
modnetwork.c esp8266/modnetwork: require_if(): Report the actual interface required. 2016-04-05 16:09:03 +03:00
modonewire.c esp8266: Add onewire helper functions as C module. 2016-03-24 17:33:42 +02:00
modpyb.c esp8266: Move pyb.unique_id() to machine.unique_id(). 2016-04-05 00:57:49 +03:00
modpyb.h esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
modpybadc.c py: Change first arg of type.make_new from mp_obj_t to mp_obj_type_t*. 2016-01-11 00:49:27 +00:00
modpybi2c.c esp8266: Implement bit-bang I2C read, and add i2c.readfrom method. 2016-03-24 11:46:05 +02:00
modpybpin.c esp8266: Expose pin object as a public structure for use as C pin API. 2016-03-24 11:07:41 +02:00
modpybpwm.c esp8266: Add PWM support. 2016-03-26 00:32:37 +02:00
modpybrtc.c esp8266: Reset "virtual RTC" on power on. 2016-03-04 16:49:01 +02:00
modpybrtc.h esp8266: Add utime and pyb.RTC 2015-05-13 00:12:54 +01:00
modpybspi.c esp8266: Implement software SPI class. 2016-03-25 23:28:13 +02:00
modpybuart.c esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
moduos.c esp8266: Enable uos.dupterm() method. 2016-03-29 11:41:23 +03:00
modutime.c esp8266/modutime: Support float argument to time.sleep(). 2016-03-04 16:52:30 +02:00
mpconfigport.h esp8266: Switch from terse error messages to normal ones. 2016-04-07 00:38:08 +03:00
qstrdefsport.h esp8266: Add initial implementation of machine.UART. 2016-04-06 19:45:52 +03:00
README.md esp8266/README: Add short troubleshooting section. 2016-04-07 00:21:04 +03:00
strtoll.c esp8266: Change bignum from mpz to longlong; move some rodata to iram. 2014-11-28 14:58:25 +00:00
uart_register.h esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
uart.c esp8266: Make destination for vendor OS debug output soft-configurable. 2016-04-06 00:12:58 +03:00
uart.h esp8266: Make destination for vendor OS debug output soft-configurable. 2016-04-06 00:12:58 +03:00
user_config.h esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
utils.c esp8266: Add esp.socket class, with ESP-style socket functionality. 2015-05-04 11:48:40 +01:00
utils.h esp8266: Add esp.socket class, with ESP-style socket functionality. 2015-05-04 11:48:40 +01:00

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.

Troubleshooting

While the port is still in alpha, it's known to be generally stable. If you experience strange bootloops, crashes, lockups, here's a list to check against:

  • You didn't erase flash before programming MicroPython firmware.
  • Firmware can be occasionally flashed incorrectly. Just retry. Recent esptool.py versions have --verify option.
  • Power supply you use doesn't provide enough power for ESP8266 or isn't stable enough.
  • A module/flash may be defective (not unheard of for cheap modules).

Please consult dedicated ESP8266 forums/resources for hardware-related problems.