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
Dan Halbert ef61b5ecb5 Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
..
boards/feather_huzzah This introduces an alternative hardware API called nativeio structured around different functions that are typically accelerated by native hardware. Its not meant to reflect the structure of the hardware. 6 years ago
common-hal Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
modules Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
Makefile Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
README.md esp8266/README: Make "Documentation" a top-level section. 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/esp8266.ld, esp8266_ota.ld: Grow main firmware size by 32KB. 6 years ago
esp8266_512k.ld esp8266: Factor out common linker code to esp8266_common.ld. 6 years ago
esp8266_common.ld Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
esp8266_ota.ld esp8266/esp8266.ld, esp8266_ota.ld: Grow main firmware size by 32KB. 6 years ago
esp_init_data.c esp8266/etshal.h: Add prototypes for SPIRead/SPIWrite/SPIEraseSector. 6 years ago
esp_mphal.c Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
esp_mphal.h all: Use the name MicroPython consistently in comments 5 years ago
espapa102.c esp8266: Make APA102 driver inclusion configurable. 6 years ago
espapa102.h all: Unify header guard usage. 5 years ago
espneopixel.c Save space by only supporting 800khz neopixels. 6 years ago
espneopixel.h Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
esppwm.c esp8266/esppwm.c: Fix IRQ handler prototype. 7 years ago
esppwm.h all: Unify header guard usage. 5 years ago
espuart.c Merge tag 'v1.9.1' 6 years ago
espuart.h Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
ets_alt_task.c esp8266/ets_alt_task.c: Prevent spurious large increment of ticks_ms() 6 years ago
ets_alt_task.h Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
etshal.h all: Unify header guard usage. 5 years ago
fatfs_port.c all: Use the name MicroPython consistently in comments 5 years ago
gccollect.c all: Use the name MicroPython consistently in comments 5 years ago
gccollect.h all: Use the name MicroPython consistently in comments 5 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 all: Use the name MicroPython consistently in comments 5 years ago
hspi.h esp8266/modpybhspi: Add a HSPI module for hardware SPI support 6 years ago
hspi_register.h all: Remove trailing spaces, per coding conventions. 5 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: Use the name MicroPython consistently in comments 5 years ago
machine_hspi.c all: Raise exceptions via mp_raise_XXX 5 years ago
machine_pin.c all: Raise exceptions via mp_raise_XXX 5 years ago
machine_pwm.c Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
machine_rtc.c all: Raise exceptions via mp_raise_XXX 5 years ago
machine_uart.c Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
machine_wdt.c esp8266: Convert to mp_rom_map_elem_t. 5 years ago
main.c Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
makeimg.py esp8266/makeimg.py: Append md5 hash to the generated binary. 6 years ago
modesp.c Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
modmachine.c all: Raise exceptions via mp_raise_XXX 5 years ago
modmachine.h all: Unify header guard usage. 5 years ago
modnetwork.c all: Raise exceptions via mp_raise_XXX 5 years ago
modpyb.c all: Use the name MicroPython consistently in comments 5 years ago
modutime.c all: Use the name MicroPython consistently in comments 5 years ago
mpconfigport.h Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master. 5 years ago
mpconfigport_512k.h esp8266/mpconfigport_512k: Use terse error messages to get 512k to fit. 5 years ago
qstrdefsport.h all: Use the name MicroPython consistently in comments 5 years ago
strtoll.c esp8266: Change bignum from mpz to longlong; move some rodata to iram. 8 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 all: Unify header guard usage. 5 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.

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

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

Documentation

More detailed documentation and instructions can be found at http://docs.micropython.org/en/latest/esp8266/ , which includes Quick Reference, Tutorial, General Information related to ESP8266 port, and to MicroPython in general.

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.

Additional information may be available by the documentation links above.