Skip to content

Commit d46cd02

Browse files
committed
docs/esp8266/quickref: Add info about WebREPL.
1 parent df06e34 commit d46cd02

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

docs/esp8266/quickref.rst

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,32 @@ For low-level driving of a NeoPixel::
273273

274274
import esp
275275
esp.neopixel_write(pin, grb_buf, is800khz)
276+
277+
WebREPL (web browser interactive prompt)
278+
----------------------------------------
279+
280+
WebREPL (REPL over WebSockets, accessible via a web browser) is an
281+
experimental feature available in ESP8266 port. Download web client
282+
from https://github.com/micropython/webrepl , and start daemon using::
283+
284+
import webrepl
285+
webrepl.start()
286+
287+
(Release version will have it started on boot by default.)
288+
289+
On a first connection, you will be prompted to set password for future
290+
sessions to use.
291+
292+
The supported way to use WebREPL is by connecting to ESP8266 access point,
293+
but the daemon is also started on STA interface if it is active, so if your
294+
routers is set up and works correctly, you may also use it while connecting
295+
to your normal Internet access point (use ESP8266 AP connection method if
296+
face any issues).
297+
298+
WebREPL is an experimental feature and a work in progress, and has known
299+
issues. There's also provision to transfer (both upload and download)
300+
files over WebREPL connection, but it has unstable status (be ready to
301+
reboot a module in case of issues). It still may be a practical way to
302+
get script files onto ESP8266, so give it a try using ``webrepl_cli.py``
303+
from the repository above. See forum for other community-supported
304+
alternatives to transfer files to ESP8266.

0 commit comments

Comments
 (0)