2015-10-12 07:06:25 +08:00
|
|
|
MicroPython port to ESP8266
|
|
|
|
|
===========================
|
2014-11-29 23:06:20 +08:00
|
|
|
|
2015-06-20 02:09:53 +08:00
|
|
|
This is a highly experimental port of MicroPython for the WiFi modules based
|
2015-06-18 16:46:43 +08:00
|
|
|
on Espressif ESP8266 chip.
|
|
|
|
|
|
|
|
|
|
WARNING: The port is highly experimental and any APIs are subject to change.
|
2014-11-29 23:06:20 +08:00
|
|
|
|
|
|
|
|
Currently implemented features include:
|
|
|
|
|
- REPL (Python prompt) over UART0.
|
|
|
|
|
- Garbage collector, exceptions.
|
|
|
|
|
- Unicode support.
|
2016-03-27 21:10:58 +08:00
|
|
|
- Builtin modules: gc, array, collections, io, struct, sys, esp, network,
|
|
|
|
|
many more.
|
2016-03-23 18:08:15 +08:00
|
|
|
- Arbitrary-precision long integers and 30-bit precision floats.
|
|
|
|
|
- Basic WiFi support.
|
2016-03-27 21:10:58 +08:00
|
|
|
- Sockets using modlwip.
|
|
|
|
|
- GPIO and bit-banging I2C, SPI support.
|
|
|
|
|
- 1-Wire and WS2812 (aka Neopixel) protocols support.
|
2014-11-29 23:06:20 +08:00
|
|
|
|
|
|
|
|
On the TODO list:
|
2015-06-17 18:12:49 +08:00
|
|
|
- Full wifi support.
|
2014-11-29 23:06:20 +08:00
|
|
|
- Internal filesystem using the flash.
|
|
|
|
|
- ...
|
|
|
|
|
|
2016-04-03 05:01:31 +08:00
|
|
|
Work-in-progress documentation is available at
|
|
|
|
|
http://docs.micropython.org/en/latest/esp8266/ .
|
|
|
|
|
|
2014-11-29 23:06:20 +08:00
|
|
|
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
|
2016-02-09 04:35:24 +08:00
|
|
|
run `make` in its directory to build and install the SDK locally. Make sure
|
|
|
|
|
to add toolchain bin directory to your PATH.
|
2014-11-29 23:06:20 +08:00
|
|
|
|
2016-03-08 15:22:00 +08:00
|
|
|
Add the external dependencies to the MicroPython repository checkout:
|
|
|
|
|
```bash
|
|
|
|
|
$ git submodule update --init
|
|
|
|
|
```
|
|
|
|
|
See the README in the repository root for more information about external
|
|
|
|
|
dependencies.
|
|
|
|
|
|
2015-10-12 07:06:25 +08:00
|
|
|
Then, to build MicroPython for the ESP8266, just run:
|
2014-11-29 23:06:20 +08:00
|
|
|
```bash
|
2016-03-08 15:22:00 +08:00
|
|
|
$ cd esp8266
|
2014-11-29 23:06:20 +08:00
|
|
|
$ make
|
|
|
|
|
```
|
|
|
|
|
This should produce binary images in the `build/` subdirectory. To flash them
|
|
|
|
|
to your ESP8266, use:
|
|
|
|
|
```bash
|
|
|
|
|
$ make deploy
|
|
|
|
|
```
|
|
|
|
|
This will use the `esptool.py` script to download the images. You must have
|
|
|
|
|
your ESP module in the bootloader, and connected to a serial port on your PC.
|
|
|
|
|
The default serial port is `/dev/ttyACM0`. To specify another, use, eg:
|
|
|
|
|
```bash
|
|
|
|
|
$ make PORT=/dev/ttyUSB0 deploy
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The images that are built are:
|
|
|
|
|
- `firmware.elf-0x00000.bin`: to be flashed at 0x00000
|
|
|
|
|
- `firmware.elf-0x10000.bin`: to be flashed at 0x10000
|
|
|
|
|
|
|
|
|
|
There is also a combined image, made up of the above 2 binary files with the
|
|
|
|
|
appropriate padding:
|
|
|
|
|
- `firmware-combined.bin`: to be flashed at 0x00000
|
