You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
circuitpython/esp8266
Damien George 52f8f5666a esp8266: Update lexer constructors so they can raise exceptions. 6 years ago
..
modules esp8266: Change to use new generic VFS sub-system. 6 years ago
scripts esp8266: Change to use new generic VFS sub-system. 6 years ago
Makefile esp8266: Switch to use OO version of FatFs library. 6 years ago
README.md esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect). 6 years ago
axtls_helpers.c esp8266/axtls_helpers: Remove abort_(), now in lib/embed/. 6 years ago
eagle.rom.addr.v6.ld esp8266/eagle.rom.addr.v6.ld: Add Enable_QMode symbol from SDK 2.0.0. 6 years ago
esp8266.ld esp8266: Factor out common linker code to esp8266_common.ld. 6 years ago
esp8266_512k.ld esp8266: Factor out common linker code to esp8266_common.ld. 6 years ago
esp8266_common.ld esp8266: Switch to use OO version of FatFs library. 6 years ago
esp8266_ota.ld esp8266: Factor out common linker code to esp8266_common.ld. 6 years ago
esp_init_data.c esp8266/etshal.h: Add prototypes for SPIRead/SPIWrite/SPIEraseSector. 6 years ago
esp_mphal.c lib/interrupt_char: Factor out typical Ctrl+C handling from esp8266 port. 6 years ago
esp_mphal.h extmod/machine_spi: Provide reusable software SPI class. 6 years ago
espapa102.c esp8266: Make APA102 driver inclusion configurable. 6 years ago
espapa102.h esp8266: Add APA102 serial individually controllable LEDs support. 7 years ago
espneopixel.c esp8266/espneopixel.c: Solve glitching LED issues with cpu at 80MHz. 6 years ago
espneopixel.h esp8266: Add esp.neopixel_write function to bit-bang WS2812 data. 7 years ago
esponewire.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
esponewire.h esp8266: Separate 1-wire timing funcs from Python module to save iRAM. 7 years ago
esppwm.c esp8266/esppwm.c: Fix IRQ handler prototype. 7 years ago
esppwm.h esp8266: Add PWM support. 7 years ago
ets_alt_task.c esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. 6 years ago
ets_alt_task.h esp8266: Extend system microsecond counter to 64-bits; use in ticks_ms. 6 years ago
etshal.h esp8266/etshal.h: Adjust size of MD5_CTX structure. 6 years ago
fatfs_port.c esp8266/fatfs_port: Include new oofatfs header. 6 years ago
gccollect.c esp8266: When doing GC be sure to trace the memory holding native code. 6 years ago
gccollect.h esp8266: When doing GC be sure to trace the memory holding native code. 6 years ago
gchelper.s esp8266: New port of Micro Python to ESP8266 wifi module. 8 years ago
help.c esp8266: Convert to use builtin help function. 6 years ago
hspi.c esp8266/hspi: Enable duplex operation of hardware SPI 6 years ago
hspi.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support 6 years ago
hspi_register.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support 6 years ago
intr.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
lexerstr32.c esp8266: Update lexer constructors so they can raise exceptions. 6 years ago
machine_adc.c all: Consistently update signatures of .make_new and .call methods. 6 years ago
machine_hspi.c esp8266: Refactor to use extmod implementation of software SPI class. 6 years ago
machine_pin.c esp8266/machine_pin: Implement pin ioctl protocol. 6 years ago
machine_pwm.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
machine_rtc.c all: Consistently update signatures of .make_new and .call methods. 6 years ago
machine_uart.c py: Add iter_buf to getiter type method. 6 years ago
machine_wdt.c all: Consistently update signatures of .make_new and .call methods. 6 years ago
main.c esp8266: Update lexer constructors so they can raise exceptions. 6 years ago
makeimg.py esp8266/makeimg.py: Append md5 hash to the generated binary. 6 years ago
modesp.c esp8266/modesp: Fix a typo, print -> printf. 6 years ago
modmachine.c esp8266/modmachine: Add Signal class. 6 years ago
modmachine.h esp8266: Refactor to use extmod implementation of software SPI class. 6 years ago
modnetwork.c esp8266/modnetwork.c: Expose configuration for station DHCP hostname. 6 years ago
modonewire.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
modpyb.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
moduos.c esp8266/moduos: Populate release field of uname in case it was GC'd. 6 years ago
modutime.c esp8266: Rename "machine" module implementation to use contemporary naming. 6 years ago
mpconfigport.h esp8266/mpconfigport.h: Enable help('modules') feature. 6 years ago
mpconfigport_512k.h esp8266: Change to use new generic VFS sub-system. 6 years ago
qstrdefsport.h esp8266: Change to use new generic VFS sub-system. 6 years ago
strtoll.c esp8266: Change bignum from mpz to longlong; move some rodata to iram. 8 years ago
uart.c esp8266/uart: Add support for polling uart device. 6 years ago
uart.h esp8266/uart: Add support for polling uart device. 6 years ago
uart_register.h esp8266: New port of Micro Python to ESP8266 wifi module. 8 years ago
user_config.h esp8266: New port of Micro Python to ESP8266 wifi module. 8 years ago
xtirq.h esp8266/xtirq: Add xtirq.h for controlling xtensa irqs. 7 years ago

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.