@@ -32,7 +32,8 @@ Build instructions
3232The tool chain required for the build is the OpenSource ESP SDK, which can be
3333found at < https://github.com/pfalcon/esp-open-sdk > . Clone this repository and
3434run ` make ` in its directory to build and install the SDK locally. Make sure
35- to add toolchain bin directory to your PATH.
35+ to add toolchain bin directory to your PATH. Read esp-open-sdk's README for
36+ additional important information on toolchain setup.
3637
3738Add the external dependencies to the MicroPython repository checkout:
3839``` bash
@@ -46,22 +47,26 @@ Then, to build MicroPython for the ESP8266, just run:
4647$ cd esp8266
4748$ make
4849```
49- This should produce binary images in the ` build/ ` subdirectory. To flash them
50- to your ESP8266, use:
50+ This will produce binary images in the ` build/ ` subdirectory. If you install
51+ MicroPython to your module for the first time, or after installing any other
52+ firmware, you should erase flash completely:
53+
54+ ```
55+ esptool.py --port /dev//ttyXXX erase_flash
56+ ```
57+
58+ Erase flash also as a troubleshooting measure, if a module doesn't behave as
59+ expected.
60+
61+ To flash MicroPython image to your ESP8266, use:
5162``` bash
5263$ make deploy
5364```
5465This will use the ` esptool.py ` script to download the images. You must have
55- your ESP module in the bootloader, and connected to a serial port on your PC.
66+ your ESP module in the bootloader mode , and connected to a serial port on your PC.
5667The default serial port is ` /dev/ttyACM0 ` . To specify another, use, eg:
5768``` bash
5869$ make PORT=/dev/ttyUSB0 deploy
5970```
6071
61- The images that are built are:
62- - ` firmware.elf-0x00000.bin ` : to be flashed at 0x00000
63- - ` firmware.elf-0x10000.bin ` : to be flashed at 0x10000
64-
65- There is also a combined image, made up of the above 2 binary files with the
66- appropriate padding:
67- - ` firmware-combined.bin ` : to be flashed at 0x00000
72+ The image produced is ` firmware-combined.bin ` , to be flashed at 0x00000.
0 commit comments