Latest commit e343bea Jan 6, 2017 @dpgeorge dpgeorge esp8266/modules/flashbdev: Change RESERVED_SECS to 0.
This effectively reverts the change that introduced this new constant.
The reason is so that users do not need to rebuild the filesystem on
their modules when upgrading the firmware.

Users can change RESERVED_SECS by hand if they need the feature, and in
future firmware it may default to a non-zero value.
Permalink
..
Failed to load latest commit information.
modules esp8266/modules/flashbdev: Change RESERVED_SECS to 0. Jan 6, 2017
scripts esp8266/scripts/inisetup: Dump FS starting sector/size on error. Jan 2, 2017
Makefile esp8266/Makefile: Put firmware-ota.bin in build/, for consistency. Jan 4, 2017
README.md esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect). Nov 8, 2016
axtls_helpers.c esp8266/axtls_helpers: Remove abort_(), now in lib/embed/. Jul 29, 2016
eagle.rom.addr.v6.ld esp8266/eagle.rom.addr.v6.ld: Add Enable_QMode symbol from SDK 2.0.0. Jul 31, 2016
esp8266.ld py: Factor out persistent-code reader into separate files. Nov 16, 2016
esp8266_512k.ld py: Factor out persistent-code reader into separate files. Nov 16, 2016
esp8266_ota.ld esp8266: Add "ota" target to produce firmware binary for use with yao… Dec 14, 2016
esp_init_data.c esp8266/etshal.h: Add prototypes for SPIRead/SPIWrite/SPIEraseSector. Nov 1, 2016
esp_mphal.c lib/interrupt_char: Factor out typical Ctrl+C handling from esp8266 p… Sep 29, 2016
esp_mphal.h extmod/machine_spi: Provide reusable software SPI class. Dec 8, 2016
espapa102.c esp8266: Make APA102 driver inclusion configurable. Jul 31, 2016
espapa102.h esp8266: Add APA102 serial individually controllable LEDs support. May 19, 2016
espneopixel.c esp8266/espneopixel.c: Solve glitching LED issues with cpu at 80MHz. Nov 7, 2016
espneopixel.h esp8266: Add esp.neopixel_write function to bit-bang WS2812 data. Mar 26, 2016
esponewire.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
esponewire.h esp8266: Separate 1-wire timing funcs from Python module to save iRAM. Apr 14, 2016
esppwm.c esp8266/esppwm.c: Fix IRQ handler prototype. Mar 25, 2016
esppwm.h esp8266: Add PWM support. Mar 25, 2016
ets_alt_task.c esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. Sep 20, 2016
ets_alt_task.h esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. Sep 20, 2016
etshal.h esp8266/etshal.h: Adjust size of MD5_CTX structure. Nov 1, 2016
fatfs_port.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
gccollect.c esp8266: When doing GC be sure to trace the memory holding native code. Dec 20, 2016
gccollect.h esp8266: When doing GC be sure to trace the memory holding native code. Dec 20, 2016
gchelper.s esp8266: New port of Micro Python to ESP8266 wifi module. Nov 27, 2014
help.c esp8266/help: Add "sta_if.active(True)" command. May 10, 2016
hspi.c esp8266/hspi: Enable duplex operation of hardware SPI Aug 25, 2016
hspi.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support Aug 19, 2016
hspi_register.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support Aug 19, 2016
intr.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
lexerstr32.c py/lexer: Make lexer use an mp_reader as its source. Nov 16, 2016
machine_adc.c all: Consistently update signatures of .make_new and .call methods. Jan 4, 2017
machine_hspi.c esp8266: Refactor to use extmod implementation of software SPI class. Dec 8, 2016
machine_pin.c all: Consistently update signatures of .make_new and .call methods. Jan 4, 2017
machine_pwm.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
machine_rtc.c all: Consistently update signatures of .make_new and .call methods. Jan 4, 2017
machine_uart.c all: Remove readall() method, which is equivalent to read() w/o args. Nov 13, 2016
machine_wdt.c all: Consistently update signatures of .make_new and .call methods. Jan 4, 2017
main.c esp8266: Use core-provided keyboard exception object. Dec 15, 2016
makeimg.py esp8266/makeimg.py: Append md5 hash to the generated binary. Aug 3, 2016
modesp.c esp8266/modesp: Fix a typo, print -> printf. Jan 3, 2017
modmachine.c all: Consistently update signatures of .make_new and .call methods. Jan 4, 2017
modmachine.h esp8266: Refactor to use extmod implementation of software SPI class. Dec 8, 2016
modnetwork.c esp8266/modnetwork.c: Expose configuration for station DHCP hostname. Nov 8, 2016
modonewire.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
modpyb.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
moduos.c esp8266: Use mp_raise_OSError helper function. Oct 7, 2016
modutime.c esp8266: Rename "machine" module implementation to use contemporary n… Nov 5, 2016
mpconfigport.h stmhal, esp8266: Enable utimeq module. Dec 23, 2016
mpconfigport_512k.h esp8266: Enable inline Xtensa assembler. Dec 9, 2016
qstrdefsport.h esp8266/main: Set sys.path to ["", "/", "/lib"]. May 3, 2016
strtoll.c esp8266: Change bignum from mpz to longlong; move some rodata to iram. Nov 28, 2014
uart.c lib/interrupt_char: Factor out typical Ctrl+C handling from esp8266 p… Sep 29, 2016
uart.h esp8266/modpybuart: Fix UART parity setting. Jul 27, 2016
uart_register.h esp8266: New port of Micro Python to ESP8266 wifi module. Nov 27, 2014
user_config.h esp8266: New port of Micro Python to ESP8266 wifi module. Nov 27, 2014
xtirq.h esp8266/xtirq: Add xtirq.h for controlling xtensa irqs. May 26, 2016

README.md

MicroPython port to ESP8266

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

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

Supported 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.
  • WiFi support.
  • Sockets using modlwip.
  • GPIO and bit-banging I2C, SPI support.
  • 1-Wire and WS2812 (aka Neopixel) protocols support.
  • Internal filesystem using the flash.
  • WebREPL over WiFi from a browser (clients at https://github.com/micropython/webrepl).
  • Modules for HTTP, MQTT, many other formats and protocols via https://github.com/micropython/micropython-lib .

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.

The MicroPython cross-compiler must be built to pre-compile some of the built-in scripts to bytecode. This can be done using:

$ make -C mpy-cross

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

$ cd esp8266
$ make axtls
$ 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, flash mode is qio and flash size is detect (auto-detect based on Flash ID). To specify other values, use, eg (note that flash size is in megabits):

$ make PORT=/dev/ttyUSB0 FLASH_MODE=qio FLASH_SIZE=32m deploy

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

First start

Serial prompt

You can access the REPL (Python prompt) over UART (the same as used for programming).

  • Baudrate: 115200

WiFi

Initally, the device configures itself as a WiFi access point (AP).

  • ESSID: MicroPython-xxxxxx (x’s are replaced with part of the MAC address).
  • Password: micropythoN (note the upper-case N).
  • IP address of the board: 192.168.4.1.
  • DHCP-server is activated.

WebREPL

Python prompt over WiFi, connecting through a browser.

Please follow the instructions there.

More detailed instructions can be found at http://docs.micropython.org/en/latest/esp8266/esp8266/tutorial/intro.html

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.