micropython/esp8266
Paul Sokolovsky fbe7a81e30 esp8266/README: Add notice about 512K version. 2017-04-14 01:03:46 +03:00
..
modules esp8266: Change to use new generic VFS sub-system. 2017-01-27 17:21:45 +11:00
scripts esp8266: Change to use new generic VFS sub-system. 2017-01-27 17:21:45 +11:00
Makefile all: Use full path name when including mp-readline/timeutils/netutils. 2017-03-31 22:29:39 +11:00
README.md esp8266/README: Add notice about 512K version. 2017-04-14 01:03:46 +03:00
axtls_helpers.c esp8266/axtls_helpers: Remove abort_(), now in lib/embed/. 2016-07-30 00:36:28 +03:00
eagle.rom.addr.v6.ld esp8266/eagle.rom.addr.v6.ld: Add Enable_QMode symbol from SDK 2.0.0. 2016-08-01 00:01:49 +03:00
esp8266.ld esp8266: Factor out common linker code to esp8266_common.ld. 2017-01-25 09:49:55 +11:00
esp8266_512k.ld esp8266: Factor out common linker code to esp8266_common.ld. 2017-01-25 09:49:55 +11:00
esp8266_common.ld esp8266: Enable micropython.schedule() with locking in pin callback. 2017-03-20 15:20:26 +11:00
esp8266_ota.ld esp8266: Factor out common linker code to esp8266_common.ld. 2017-01-25 09:49:55 +11:00
esp_init_data.c esp8266/etshal.h: Add prototypes for SPIRead/SPIWrite/SPIEraseSector. 2016-11-02 02:16:20 +03:00
esp_mphal.c esp8266: Enable micropython.schedule() with locking in pin callback. 2017-03-20 15:20:26 +11:00
esp_mphal.h extmod/machine_spi: Provide reusable software SPI class. 2016-12-08 13:47:01 +11:00
espapa102.c esp8266: Make APA102 driver inclusion configurable. 2016-08-01 00:03:55 +03:00
espapa102.h esp8266: Add APA102 serial individually controllable LEDs support. 2016-05-19 22:29:11 +03:00
espneopixel.c esp8266/espneopixel.c: Solve glitching LED issues with cpu at 80MHz. 2016-11-07 17:13:49 +11:00
espneopixel.h esp8266: Add esp.neopixel_write function to bit-bang WS2812 data. 2016-03-26 10:55:21 +02:00
esponewire.c esp8266: Rename "machine" module implementation to use contemporary naming. 2016-11-06 01:30:19 +03:00
esponewire.h esp8266: Separate 1-wire timing funcs from Python module to save iRAM. 2016-04-14 12:44:26 +01: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: Extend system microsecond counter to 64-bits; use in ticks_ms. 2016-09-20 14:28:17 +10:00
ets_alt_task.h esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. 2016-09-20 14:28:17 +10:00
etshal.h esp8266/etshal.h: Adjust size of MD5_CTX structure. 2016-11-02 02:16:35 +03:00
fatfs_port.c all: Use full path name when including mp-readline/timeutils/netutils. 2017-03-31 22:29:39 +11:00
gccollect.c esp8266: When doing GC be sure to trace the memory holding native code. 2016-12-20 11:20:01 +11:00
gccollect.h esp8266: When doing GC be sure to trace the memory holding native code. 2016-12-20 11:20:01 +11:00
gchelper.s esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
help.c esp8266: Convert to use builtin help function. 2017-01-22 11:56:16 +11:00
hspi.c esp8266/hspi: Enable duplex operation of hardware SPI 2016-08-25 21:24:22 +03:00
hspi.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support 2016-08-19 21:19:59 +03:00
hspi_register.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support 2016-08-19 21:19:59 +03:00
intr.c esp8266: Rename "machine" module implementation to use contemporary naming. 2016-11-06 01:30:19 +03:00
lexerstr32.c esp8266: Update lexer constructors so they can raise exceptions. 2017-03-14 11:52:05 +11:00
machine_adc.c all: Consistently update signatures of .make_new and .call methods. 2017-01-04 16:10:42 +03:00
machine_hspi.c esp8266: Refactor to use extmod implementation of software SPI class. 2016-12-08 14:41:58 +11:00
machine_pin.c extmod/machine_signal: Support all Pin's arguments to the constructor. 2017-04-11 00:12:20 +03:00
machine_pwm.c esp8266: Rename "machine" module implementation to use contemporary naming. 2016-11-06 01:30:19 +03:00
machine_rtc.c all: Use full path name when including mp-readline/timeutils/netutils. 2017-03-31 22:29:39 +11:00
machine_uart.c py: Add iter_buf to getiter type method. 2017-02-16 18:38:06 +11:00
machine_wdt.c all: Consistently update signatures of .make_new and .call methods. 2017-01-04 16:10:42 +03:00
main.c esp8266: Only execute main.py if in friendly REPL mode. 2017-03-14 13:04:03 +11:00
makeimg.py esp8266/makeimg.py: Append md5 hash to the generated binary. 2016-08-04 00:21:05 +03:00
modesp.c esp8266/modesp: Remove long-obsolete and unused espconn bindings. 2017-03-27 12:05:18 +11:00
modmachine.c esp8266: Change machine.Timer callback to soft callback. 2017-03-20 15:20:26 +11:00
modmachine.h esp8266: Refactor to use extmod implementation of software SPI class. 2016-12-08 14:41:58 +11:00
modnetwork.c all: Use full path name when including mp-readline/timeutils/netutils. 2017-03-31 22:29:39 +11:00
modonewire.c esp8266: Rename "machine" module implementation to use contemporary naming. 2016-11-06 01:30:19 +03:00
modpyb.c esp8266: Rename "machine" module implementation to use contemporary naming. 2016-11-06 01:30:19 +03:00
moduos.c esp8266/moduos: Populate release field of uname in case it was GC'd. 2017-02-13 11:47:17 +11:00
modutime.c all: Use full path name when including mp-readline/timeutils/netutils. 2017-03-31 22:29:39 +11:00
mpconfigport.h extmod/machine_signal: Support all Pin's arguments to the constructor. 2017-04-11 00:12:20 +03:00
mpconfigport_512k.h esp8266: Change to use new generic VFS sub-system. 2017-01-27 17:21:45 +11:00
qstrdefsport.h esp8266: Change to use new generic VFS sub-system. 2017-01-27 17:21:45 +11:00
strtoll.c esp8266: Change bignum from mpz to longlong; move some rodata to iram. 2014-11-28 14:58:25 +00:00
uart.c esp8266/uart: Add support for polling uart device. 2017-02-03 17:15:43 +11:00
uart.h esp8266/uart: Add support for polling uart device. 2017-02-03 17:15:43 +11:00
uart_register.h esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
user_config.h esp8266: New port of Micro Python to ESP8266 wifi module. 2014-11-27 20:30:33 +00:00
xtirq.h esp8266/xtirq: Add xtirq.h for controlling xtensa irqs. 2016-05-26 15:47:47 +01:00

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.

512KB FlashROM version

The normal build described above requires modules with at least 1MB of FlashROM onboard. There's a special configuration for 512KB modules, which can be built with make 512k. This configuration is highly limited, lacks filesystem support, WebREPL, and has many other features disabled. It's mostly suitable for advanced users who are interested to fine-tune options to achieve a required setup. If you are an end user, please consider using a module with at least 1MB of FlashROM.

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 (xs 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 in beta, 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.