diff options
Diffstat (limited to 'docs/esp8266/tutorial')
-rw-r--r-- | docs/esp8266/tutorial/filesystem.rst | 7 | ||||
-rw-r--r-- | docs/esp8266/tutorial/intro.rst | 8 | ||||
-rw-r--r-- | docs/esp8266/tutorial/repl.rst | 30 |
3 files changed, 25 insertions, 20 deletions
diff --git a/docs/esp8266/tutorial/filesystem.rst b/docs/esp8266/tutorial/filesystem.rst index 9033a8576f..27b0d2608c 100644 --- a/docs/esp8266/tutorial/filesystem.rst +++ b/docs/esp8266/tutorial/filesystem.rst @@ -64,7 +64,6 @@ device starts up. Accessing the filesystem via WebREPL ------------------------------------ -You can access the filesystem over WebREPL using the provided command-line -tool. This tool is found at `<https://github.com/micropython/webrepl>`__ -and is called webrepl_cli.py. Please refer to that program for information -on how to use it. +You can access the filesystem over WebREPL using the web client in a browser +or via the command-line tool. Please refer to Quick Reference and Tutorial +sections for more information about WebREPL. 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: `<https://github.com/themadinventor/esptool/>`__, 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/docs/esp8266/tutorial/repl.rst b/docs/esp8266/tutorial/repl.rst index 338e9fdd8f..1922da128d 100644 --- a/docs/esp8266/tutorial/repl.rst +++ b/docs/esp8266/tutorial/repl.rst @@ -41,6 +41,18 @@ For your convenience, WebREPL client is hosted at locally from the the GitHub repository `<https://github.com/micropython/webrepl>`__ . +Before connecting to WebREPL, you should set a password and enable it via +a normal serial connection. Initial versions of MicroPython for ESP8266 +came with WebREPL automatically enabled on the boot and with the +ability to set a password via WiFi on the first connection, but as WebREPL +was becoming more widely known and popular, the initial setup has switched +to a wired connection for improved security:: + + import webrepl_setup + +Follow the on-screen instructions and prompts. To make any changes active, +you will need to reboot your device. + To use WebREPL connect your computer to the ESP8266's access point (MicroPython-xxxxxx, see the previous section about this). If you have already reconfigured your ESP8266 to connect to a router then you can @@ -49,19 +61,11 @@ skip this part. Once you are on the same network as the ESP8266 you click the "Connect" button (if you are connecting via a router then you may need to change the IP address, by default the IP address is correct when connected to the ESP8266's access -point). If the connection succeeds then you should see a welcome message. - -On the first connection you need to set a password. Make sure that the -terminal widget is selected by clicking on it, and then follow prompts to -type in your password twice (they should match each other). Then ESP8266 -will then reboot with the password applied (the WiFi will go down but come -back up again). Note that some modules may have troubles rebooting -automatically and need reset button press or power cycle (do this if -you don't see ESP8266 access point appearing in a minute or so). - -You should then click the "Connect" button again, and enter your password -to connect. If you type in the correct password you should get a prompt -looking like ``>>>``. You can now start typing Python commands! +point). If the connection succeeds then you should see a password prompt. + +Once you type the password configured at the setup step above, press Enter once +more and you should get a prompt looking like ``>>>``. You can now start +typing Python commands! Using the REPL -------------- |