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/ports/esp8266
Dan Halbert bc760dd341 WIP: complete manual inspection of all significant changes 4 years ago
..
boards/feather_huzzah Merge commit 'f869d6b2e339c04469c6c9ea3fb2fabd7bbb2d8c' into nrf2_merge 5 years ago
common-hal WIP: complete manual inspection of all significant changes 4 years ago
modules WIP: complete manual inspection of all significant changes 4 years ago
Makefile WIP: complete manual inspection of all significant changes 4 years ago
README.md esp8266/README.md: Update build instruction to reflect new ports dir. 5 years ago
eagle.rom.addr.v6.ld ports: Make new ports/ sub-directory and move all ports there. 5 years ago
esp8266.ld ports: Make new ports/ sub-directory and move all ports there. 5 years ago
esp8266_512k.ld ports: Make new ports/ sub-directory and move all ports there. 5 years ago
esp8266_common.ld WIP: after merge; before testing 4 years ago
esp8266_ota.ld ports: Make new ports/ sub-directory and move all ports there. 5 years ago
esp_init_data.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
esp_mphal.c WIP: complete manual inspection of all significant changes 4 years ago
esp_mphal.h esp8266: Change UART(0) to attach to REPL via uos.dupterm interface. 5 years ago
espneopixel.c WIP: complete manual inspection of all significant changes 4 years ago
espneopixel.h WIP: complete manual inspection of all significant changes 4 years ago
esppwm.c esp8266/esppwm: Always start timer to avoid glitch from full to nonfull. 5 years ago
esppwm.h esp8266/esppwm: Clip negative duty numbers to 0. 5 years ago
ets_alt_task.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
ets_alt_task.h Merge commit 'f869d6b2e339c04469c6c9ea3fb2fabd7bbb2d8c' into nrf2_merge 5 years ago
etshal.h WIP: complete manual inspection of all significant changes 4 years ago
fatfs_port.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
gccollect.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
gccollect.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
gchelper.s ports: Make new ports/ sub-directory and move all ports there. 5 years ago
help.c py/builtinhelp: Change signature of help text var from pointer to array. 5 years ago
hspi.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
hspi.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
hspi_register.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
intr.c Clean up interrupt handling for pulseio.PulseIn implementation for #716 ESP8266 5 years ago
lexerstr32.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
machine_adc.c all: Remove inclusion of internal py header files. 5 years ago
machine_hspi.c esp8266/modmachine: Allow I2C and SPI to be configured out of the build. 5 years ago
machine_pin.c all: Remove inclusion of internal py header files. 5 years ago
machine_pwm.c Merge commit 'f869d6b2e339c04469c6c9ea3fb2fabd7bbb2d8c' into nrf2_merge 5 years ago
machine_rtc.c all: Remove inclusion of internal py header files. 5 years ago
machine_uart.c WIP: complete manual inspection of all significant changes 4 years ago
machine_wdt.c all: Use NULL instead of "" when calling mp_raise exception helpers. 5 years ago
main.c WIP: complete manual inspection of all significant changes 4 years ago
makeimg.py ports: Make new ports/ sub-directory and move all ports there. 5 years ago
modesp.c WIP: complete manual inspection of all significant changes 4 years ago
modmachine.c esp8266/modmachine: Allow I2C and SPI to be configured out of the build. 5 years ago
modmachine.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
modnetwork.c WIP: complete manual inspection of all significant changes 4 years ago
modpyb.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
modutime.c WIP: complete manual inspection of all significant changes 4 years ago
mpconfigport.h WIP: complete manual inspection of all significant changes 4 years ago
mpconfigport_512k.h esp8266: Disable DEBUG_PRINTERS for 512k build. 5 years ago
posix_helpers.c WIP: after merge; before testing 4 years ago
qstrdefsport.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
strtoll.c ports: Make new ports/ sub-directory and move all ports there. 5 years ago
uart.c WIP: complete manual inspection of all significant changes 4 years ago
uart.h WIP: complete manual inspection of all significant changes 4 years ago
uart_register.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
user_config.h ports: Make new ports/ sub-directory and move all ports there. 5 years ago
xtirq.h ports: Make new ports/ sub-directory and move all ports there. 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 ports/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

Be sure to change ESP8266's WiFi access point password ASAP, see below.

Serial prompt

You can access the REPL (Python prompt) over UART (the same as used for programming).

  • Baudrate: 115200

Run help() for some basic information.

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.
  • Please be sure to change the password to something non-guessable immediately. help() gives information how.

WebREPL

Python prompt over WiFi, connecting through a browser.

upip

The ESP8266 port comes with builtin upip package manager, which can be used to install additional modules (see the main README for more information):

>>> import upip
>>> upip.install("micropython-pystone_lowmem")
[...]
>>> import pystone_lowmem
>>> pystone_lowmem.main()

Downloading and installing packages may requite a lot of free memory, if you get an error, retry immediately after the hard reset.

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.