diff options
| author | Andrew Mulholland <gbaman@users.noreply.github.com> | 2016-12-27 14:16:56 +0000 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2016-12-30 14:27:02 +1100 |
| commit | 71ff0b549d179acb210b4a2cc44ba726f61eede4 (patch) | |
| tree | e49b4b1da308f254a5ff6a74646297bb52c963c2 /docs/esp8266/tutorial/intro.rst | |
| parent | b315d76b6b76a81a11d1456fa43e195b711e406b (diff) | |
| download | micropython-71ff0b549d179acb210b4a2cc44ba726f61eede4.tar.gz micropython-71ff0b549d179acb210b4a2cc44ba726f61eede4.zip | |
docs/esp8266/tutorial: Update intro to add Getting the firmware section.
Add a "Getting the firmware" section to better describe how to get hold of
the MicroPython firmware, especially if you have a 512kb module.
Diffstat (limited to 'docs/esp8266/tutorial/intro.rst')
| -rw-r--r-- | docs/esp8266/tutorial/intro.rst | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/esp8266/tutorial/intro.rst b/docs/esp8266/tutorial/intro.rst index 87d4463406..fe824cffff 100644 --- a/docs/esp8266/tutorial/intro.rst +++ b/docs/esp8266/tutorial/intro.rst @@ -35,11 +35,30 @@ If your board has a USB connector on it then most likely it is powered through this when connected to your PC. Otherwise you will need to power it directly. Please refer to the documentation for your board for further details. +Getting the firmware +-------------------- + +The first thing you need to do is download the most recent MicroPython firmware +.bin file to load onto your ESP8266 device. You can download it from the +`MicroPython downloads page <http://micropython.org/download#esp8266>`_. +From here, you have 3 main choices + +* Stable firmware builds for 1024kb modules and above. +* Daily firmware builds for 1024kb modules and above. +* Daily firmware builds for 512kb modules. + +The best bet is nearly always to go for the Stable firmware builds. +An exception to this though is if you have an ESP8266 module with only 512kb +of onboard storage. You can easily tell by trying to load a Stable firmware +build and if you get the error below, then you may have to use the Daily +firmware builds for 512kb modules. + WARNING: Unlikely to work as data goes beyond end of flash. + Deploying the firmware ---------------------- -The very first thing you need to do is put the MicroPython firmware (compiled -code) on your ESP8266 device. There are two main steps to do this: first you +Once you have the MicroPython firmware (compiled code), you need to load it onto +your ESP8266 device. There are two main steps to do this: first you need to put your device in boot-loader mode, and second you need to copy across the firmware. The exact procedure for these steps is highly dependent on the particular board and you will need to refer to its documentation for details. |