From 5630778f0f3a114f5b7d7f71f3df0bd1c3b378f6 Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Tue, 8 Nov 2016 04:52:07 +0300 Subject: [PATCH] esp8266: Update docs for esptool 1.2.1/SDK 2.0 (--flash_size=detect). --- docs/esp8266/tutorial/intro.rst | 8 +++++--- esp8266/README.md | 9 +++++---- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/esp8266/tutorial/intro.rst b/docs/esp8266/tutorial/intro.rst index 32e9326b37..87d4463406 100644 --- a/docs/esp8266/tutorial/intro.rst +++ b/docs/esp8266/tutorial/intro.rst @@ -54,7 +54,7 @@ device before putting on new MicroPython firmware. Currently we only support esptool.py to copy across the firmware. You can find this tool here: ``__, or install it -using pip:: +using pip (at least version 1.2.1 is required):: pip install esptool @@ -69,7 +69,7 @@ Using esptool.py you can erase the flash with the command:: And then deploy the new firmware using:: - esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=8m 0 esp8266-2016-05-03-v1.8.bin + esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect 0 esp8266-2016-05-03-v1.8.bin You might need to change the "port" setting to something else relevant for your PC. You may also need to reduce the baudrate if you get errors when flashing @@ -80,7 +80,7 @@ For some boards with a particular FlashROM configuration (e.g. some variants of a NodeMCU board) you may need to use the following command to deploy the firmware (note the ``-fm dio`` option):: - esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=8m -fm dio 0 esp8266-2016-05-03-v1.8.bin + esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect -fm dio 0 esp8266-2016-05-03-v1.8.bin If the above commands run without error then MicroPython should be installed on your board! @@ -138,6 +138,8 @@ after it, here are troubleshooting recommendations: * If lower baud rate didn't help, you may want to try older version of esptool.py, which had a different programming algorithm:: pip install esptool==1.0.1 + This version doesn't support ``--flash_size=detect`` option, so you will + need to specify FlashROM size explicitly (in megabits). * The ``--flash_size`` option in the commands above is mandatory. Omitting it will lead to a corrupted firmware. diff --git a/esp8266/README.md b/esp8266/README.md index c998b7ad18..54591fcc13 100644 --- a/esp8266/README.md +++ b/esp8266/README.md @@ -70,13 +70,14 @@ $ 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 `8m`. -To specify other values, use, eg: +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): ```bash -$ make PORT=/dev/ttyUSB0 FLASH_MODE=qio FLASH_SIZE=8m deploy +$ make PORT=/dev/ttyUSB0 FLASH_MODE=qio FLASH_SIZE=32m deploy ``` -The image produced is `firmware-combined.bin`, to be flashed at 0x00000. +The image produced is `build/firmware-combined.bin`, to be flashed at 0x00000. First start -----------