micropython/esp8266
Damien George 93c4a6a3f7 all: Remove 'name' member from mp_obj_module_t struct.
One can instead lookup __name__ in the modules dict to get the value.
2016-09-22 00:23:16 +10:00
..
modules esp8266/modules/ds18x20.py: Add support for DS18S20 devices. 2016-08-29 12:45:07 +10:00
scripts esp8266/modules: Split onewire.py into OneWire and DS18X20 driver. 2016-08-29 12:12:49 +10:00
Makefile py: Move frozen modules rules from esp8266 port for reuse across ports. 2016-09-17 21:00:40 +03:00
README.md esp8266/README: Promote from "highly experimental" to "experimental". 2016-07-02 23:14:22 +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/modmachine: Simplify SPI class implementation multiplexing. 2016-09-04 20:33:11 +03:00
esp_mphal.c esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. 2016-09-20 14:28:17 +10:00
esp_mphal.h esp8266/esp_mphal.h: Add mp_hal_ticks_cpu() for reuse. 2016-08-07 16:03:00 +03: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: Disable IRQs during eps.neopixel_write. 2016-09-06 11:51:35 +10: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: 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/modmachinewdt: Add .deinit() method. 2016-09-03 20:45:11 +03:00
fatfs_port.c esp8266: Use RTC to set date & time stamps for files. 2016-06-16 19:31:58 +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 "sta_if.active(True)" command. 2016-05-10 23:21:32 +03: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: 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: dupterm_task_init() should be called before running _boot.py, etc. 2016-07-23 00:05:38 +03:00
makeimg.py esp8266/makeimg.py: Append md5 hash to the generated binary. 2016-08-04 00:21:05 +03:00
modesp.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10:00
modmachine.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10:00
modmachinewdt.c esp8266/modmachinewdt: Add .deinit() method. 2016-09-03 20:45:11 +03:00
modnetwork.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10:00
modonewire.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10: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/modmachinespi: Add a factory method for SoftSPI/HSPI 2016-08-19 21:19:59 +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
modpybhspi.c esp8266/modmachine: Simplify SPI class implementation multiplexing. 2016-09-04 20:33:11 +03:00
modpybpin.c esp8266: PULL_UP is not supported on Pin(16), so raise an exception. 2016-08-10 12:45:40 +10:00
modpybpwm.c esp8266: Remove pin_id field from C pin object. 2016-04-14 12:43:25 +01:00
modpybrtc.c esp8266/modpybrtc: Use 64-bit arithmetic when computing alarm expiry. 2016-08-25 14:10:25 +10:00
modpybrtc.h esp8266: Let RTC work correctly after deepsleep. 2016-06-06 10:51:12 +01:00
modpybspi.c esp8266/modpybspi: Use generic SPI helper methods to implement SPI. 2016-09-01 16:39:42 +10:00
modpybuart.c esp8266/modpybuart: Fix UART parity setting. 2016-07-27 21:05:45 +03:00
moduos.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10:00
modutime.c all: Remove 'name' member from mp_obj_module_t struct. 2016-09-22 00:23:16 +10:00
mpconfigport.h esp8266/modpybspi: Use generic SPI helper methods to implement SPI. 2016-09-01 16:39:42 +10:00
qstrdefsport.h esp8266/main: Set sys.path to ["", "/", "/lib"]. 2016-05-03 18:25:27 +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.c esp8266/modpybuart: allow setting baudrate and other params 2016-06-30 18:18:50 +02:00
uart.h esp8266/modpybuart: Fix UART parity setting. 2016-07-27 21:05:45 +03: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. To specify another, use, eg:

$ make PORT=/dev/ttyUSB0 deploy

The image produced is 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 (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 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.