Skip to content

Commit 9142179

Browse files
jasonhildebranddanicampora
authored andcommitted
docs/wipy: Add warning about losing wlan connection when changing mode.
Also provide workarounds, link to other revelant sections, and fix some typos.
1 parent 7080e96 commit 9142179

4 files changed

Lines changed: 17 additions & 3 deletions

File tree

docs/wipy/general.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,8 @@ For instance, on a linux shell (when connected to the WiPy in AP mode)::
4343

4444
$ telnet 192.168.1.1
4545

46+
.. _wipy_filesystem:
47+
4648
Local file system and FTP access
4749
--------------------------------
4850

docs/wipy/tutorial/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ WiPy tutorials and examples
44
===========================
55

66
Before starting, make sure that you are running the latest firmware,
7-
for instrucctions see :ref:`OTA How-To <wipy_firmware_upgrade>`.
7+
for instructions see :ref:`OTA How-To <wipy_firmware_upgrade>`.
88

99
.. toctree::
1010
:maxdepth: 1

docs/wipy/tutorial/repl.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ interactive MicroPython prompt that you can access on the WiPy. Using
66
the REPL is by far the easiest way to test out your code and run commands.
77
You can use the REPL in addition to writing scripts in ``main.py``.
88

9+
.. _wipy_uart:
10+
911
To use the REPL, you must connect to the WiPy either via :ref:`telnet <wipy_telnet>`,
10-
or with a USB to serial converter wired to the one the two UARTs on the
11-
WiPy. To enable REPL duplication on UART0 (the one accesible via the expansion board)
12+
or with a USB to serial converter wired to one of the two UARTs on the
13+
WiPy. To enable REPL duplication on UART0 (the one accessible via the expansion board)
1214
do::
1315

1416
>>> from machine import UART

docs/wipy/tutorial/wlan.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,15 @@ You can check the current mode (which is always ``WLAN.AP`` after power up)::
1313

1414
>>> wlan.mode()
1515

16+
.. warning::
17+
When you change the WLAN mode following the instructions below, your WLAN
18+
connection to the WiPy will be broken. This means you will not be able
19+
to run these commands interactively over the WLAN.
20+
21+
There are two ways around this::
22+
1. put this setup code into your :ref:`boot.py file<wipy_filesystem>` so that it gets executed automatically after reset.
23+
2. :ref:`duplicate the REPL on UART <wipy_uart>`, so that you can run commands via USB.
24+
1625
Connecting to your home router
1726
------------------------------
1827

@@ -22,6 +31,7 @@ it as a station::
2231
from network import WLAN
2332
wlan = WLAN(mode=WLAN.STA)
2433

34+
2535
Now you can proceed to scan for networks::
2636

2737
nets = wlan.scan()

0 commit comments

Comments
 (0)