micropython/esp8266
Damien George 9df6b3a2c2 esp8266/modpybpin: Use enum+array instead of struct for parsing args. 2016-05-03 12:44:28 +01:00
..
scripts esp8266/scripts/neopixel.py: Swap red and green in pixel accessor. 2016-05-03 11:17:37 +01:00
Makefile esp8266/Makefile: Be sure to pass cross-compiling AR when building axtls. 2016-05-02 01:22:42 +03:00
README.md esp8266/README: Mention WebREPL. 2016-04-30 23:02:54 +03:00
axtls_helpers.c esp8266/axtls_helpers: Helper/wrapper functions for axTLS. 2016-04-27 14:54:36 +03:00
eagle.rom.addr.v6.ld esp8266: Switch integer arith routines to BootROM. 2016-04-14 15:06:07 +03:00
esp8266.ld esp8266/esp8266.ld: Put axTLS to FlashROM. 2016-04-27 00:45:09 +03:00
esp_mphal.c esp8266/esp_mphal: Add ets_esf_free_bufs(), etc. functions. 2016-05-03 00:18:14 +03:00
esp_mphal.h esp8266/esp_mphal: Add ets_esf_free_bufs(), etc. functions. 2016-05-03 00:18:14 +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
esponewire.c esp8266: Separate 1-wire timing funcs from Python module to save iRAM. 2016-04-14 12:44:26 +01: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/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/modesp: Add malloc() and free() functions. 2016-05-03 00:35:11 +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
help.c esp8266/help: Add cheatsheet for basic WiFi configuration. 2016-04-29 00:34:08 +03:00
intr.c esp8266: Add hard IRQ callbacks for pin change on GPIO0-15. 2016-04-14 12:44:26 +01:00
lexerstr32.c esp8266: Store frozen modules in FlashROM. 2016-03-17 23:06:47 +08:00
main.c esp8266: Add hard IRQ callbacks for pin change on GPIO0-15. 2016-04-14 12:44:26 +01:00
makeimg.py esp8266: Minimize gap between Inst/DataRAM segments and FlashROM segment. 2016-04-03 15:45:14 +03:00
modesp.c esp8266/modesp: Add malloc() and free() functions. 2016-05-03 00:35:11 +03:00
modmachine.c py: Move call_function_*_protected() functions to py/ for reuse. 2016-04-25 19:31:17 +03:00
modnetwork.c esp8266/modnetwork: Remove .mac() method, move to .config("mac"). 2016-05-03 01:02:14 +03:00
modonewire.c esp8266: Separate 1-wire timing funcs from Python module to save iRAM. 2016-04-14 12:44:26 +01:00
modpyb.c esp8266: Move pyb.info() function to esp module and remove pyb module. 2016-04-28 12:23:55 +01:00
modpyb.h esp8266: Move pyb.info() function to esp module and remove pyb module. 2016-04-28 12:23:55 +01: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
modpybpin.c esp8266/modpybpin: Use enum+array instead of struct for parsing args. 2016-05-03 12:44:28 +01:00
modpybpwm.c esp8266: Remove pin_id field from C pin object. 2016-04-14 12:43:25 +01:00
modpybrtc.c esp8266: Implement basic deep-sleep capabilities. 2016-04-21 11:43:37 +01:00
modpybrtc.h esp8266: Implement basic deep-sleep capabilities. 2016-04-21 11:43:37 +01:00
modpybspi.c esp8266: Change software SPI driver to use general pin HAL. 2016-04-22 10:44:06 +01:00
modpybuart.c esp8266: Implement UART.read functionality. 2016-04-21 15:19:19 +01:00
moduos.c esp8266/moduos: Add dupterm_notify() function. 2016-04-17 18:09:52 +03:00
modutime.c esp8266/modutime: Support float argument to time.sleep(). 2016-03-04 16:52:30 +02:00
mpconfigport.h esp8266: Change platform name from ESP8266 to esp8266. 2016-05-02 18:54:46 +01:00
qstrdefsport.h esp8266: Adapt port to use new auto-qstr generation. 2016-04-16 13:20:02 +01: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: Remove obsolete UART rx buffering code. 2016-04-21 15:27:18 +01:00
uart.h esp8266: Add uart_rx_wait and uart_rx_char functions. 2016-04-21 15:19:00 +01: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

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

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