Skip to content

Commit e73a0b9

Browse files
JYOuyangdpgeorge
authored andcommitted
docs/esp8266/tutorial: Update since esptool 1.3 added Python 3 support.
esptool 1.3 now supports both Python 2.7 and 3.4+. Updated github link to now-official espressif repo.
1 parent 2646b9e commit e73a0b9

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

docs/esp8266/tutorial/intro.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,25 @@ For best results it is recommended to first erase the entire flash of your
7272
device before putting on new MicroPython firmware.
7373

7474
Currently we only support esptool.py to copy across the firmware. You can find
75-
this tool here: `<https://github.com/themadinventor/esptool/>`__, or install it
76-
using pip (at least version 1.2.1 is required)::
75+
this tool here: `<https://github.com/espressif/esptool/>`__, or install it
76+
using pip::
7777

7878
pip install esptool
7979

80-
It requires Python 2.7, so you may need to use ``pip2`` instead of ``pip`` in
81-
the command above. Any other
82-
flashing program should work, so feel free to try them out, or refer to the
83-
documentation for your board to see its recommendations.
80+
Versions starting with 1.3 support both Python 2.7 and Python 3.4 (or newer).
81+
An older version (at least 1.2.1 is needed) works fine but will require Python
82+
2.7.
83+
84+
Any other flashing program should work, so feel free to try them out or refer
85+
to the documentation for your board to see its recommendations.
8486

8587
Using esptool.py you can erase the flash with the command::
8688

8789
esptool.py --port /dev/ttyUSB0 erase_flash
8890

8991
And then deploy the new firmware using::
9092

91-
esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect 0 esp8266-2016-05-03-v1.8.bin
93+
esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect 0 esp8266-20170108-v1.8.7.bin
9294

9395
You might need to change the "port" setting to something else relevant for your
9496
PC. You may also need to reduce the baudrate if you get errors when flashing
@@ -99,7 +101,7 @@ For some boards with a particular FlashROM configuration (e.g. some variants of
99101
a NodeMCU board) you may need to use the following command to deploy
100102
the firmware (note the ``-fm dio`` option)::
101103

102-
esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect -fm dio 0 esp8266-2016-05-03-v1.8.bin
104+
esptool.py --port /dev/ttyUSB0 --baud 460800 write_flash --flash_size=detect -fm dio 0 esp8266-20170108-v1.8.7.bin
103105

104106
If the above commands run without error then MicroPython should be installed on
105107
your board!
@@ -158,7 +160,9 @@ after it, here are troubleshooting recommendations:
158160
esptool.py, which had a different programming algorithm::
159161
pip install esptool==1.0.1
160162
This version doesn't support ``--flash_size=detect`` option, so you will
161-
need to specify FlashROM size explicitly (in megabits).
163+
need to specify FlashROM size explicitly (in megabits). It also requires
164+
Python 2.7, so you may need to use ``pip2`` instead of ``pip`` in the
165+
command above.
162166

163167
* The ``--flash_size`` option in the commands above is mandatory. Omitting
164168
it will lead to a corrupted firmware.
@@ -179,7 +183,7 @@ after it, here are troubleshooting recommendations:
179183
application in the ESP8266 community.
180184

181185
* If you still experience problems with even flashing the firmware, please
182-
refer to esptool.py project page, https://github.com/themadinventor/esptool
186+
refer to esptool.py project page, https://github.com/espressif/esptool
183187
for additional documentation and bug tracker where you can report problems.
184188

185189
* If you are able to flash firmware, but ``--verify`` option or

0 commit comments

Comments
 (0)