From a13d22f92177e3b33145aaeaed60e97e0dd540ce Mon Sep 17 00:00:00 2001 From: Martijn Koster Date: Mon, 26 Oct 2015 19:41:14 +0000 Subject: [PATCH] docs/wipy: Fix several typos and change some pyboard to WiPy. --- docs/wipy/general.rst | 4 ++-- docs/wipy/quickref.rst | 6 +++--- docs/wipy/tutorial/intro.rst | 4 ++-- docs/wipy/tutorial/repl.rst | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst index 3b8ff3d1b7..8fe361d1d1 100644 --- a/docs/wipy/general.rst +++ b/docs/wipy/general.rst @@ -37,7 +37,7 @@ Telnet REPL ----------- Linux stock telnet works like a charm (also on OSX), but other tools like putty -work quite too. The default credentials are: **user:** ``micro``, **password:** ``python``. +work quite well too. The default credentials are: **user:** ``micro``, **password:** ``python``. See :ref:`network.server ` for info on how to change the defaults. For instance, on a linux shell (when connected to the WiPy in AP mode):: @@ -157,7 +157,7 @@ alive. This can be overridden through the :mod:`wipy` module:: There are currently 2 kinds of errors that you might see: -1. If the heartbeat LED flashes quickly, then a Python script(eg ``main.py``) +1. If the heartbeat LED flashes quickly, then a Python script (eg ``main.py``) has an error. Use the REPL to debug it. 2. If the heartbeat LED stays on, then there was a hard fault, you cannot recover from this, the only way out is to press the reset switch. diff --git a/docs/wipy/quickref.rst b/docs/wipy/quickref.rst index 9f4a55070d..8c62486cde 100644 --- a/docs/wipy/quickref.rst +++ b/docs/wipy/quickref.rst @@ -18,7 +18,7 @@ See the :mod:`machine` module:: machine.freq() # get the CPU frequency machine.unique_id() # return the 6-byte unique id of the board (the WiPy's MAC address) - machine.idle() # average curernt decreases to (~12mA), any interrupts wakes it up + machine.idle() # average current decreases to (~12mA), any interrupts wake it up machine.sleep() # everything except for WLAN is powered down (~950uA avg. current) # wakes from Pin, RTC or WLAN machine.deepsleep() # deepest sleep mode, MCU starts from reset. Wakes from Pin and RTC. @@ -187,7 +187,7 @@ See :ref:`network.WLAN ` and :mod:`machine`. :: wifi = WLAN(mode=WLAN.STA) # go for fixed IP settings wifi.ifconfig(config=('192.168.0.107', '255.255.255.0', '192.168.0.1', '8.8.8.8')) - wifi.scan() # scan for available netrworks + wifi.scan() # scan for available networks wifi.connect(ssid='mynetwork', auth=(WLAN.WPA2, 'mynetworkkey')) while not wifi.isconnected(): pass @@ -205,7 +205,7 @@ See :ref:`network.server ` :: from network import server - # init with new user, pass word and seconds timeout + # init with new user, password and seconds timeout server = server.init(login=('user', 'password'), timeout=60) server.timeout(300) # change the timeout server.timeout() # get the timeout diff --git a/docs/wipy/tutorial/intro.rst b/docs/wipy/tutorial/intro.rst index 76d3ae985f..7dc5f1c13d 100644 --- a/docs/wipy/tutorial/intro.rst +++ b/docs/wipy/tutorial/intro.rst @@ -17,7 +17,7 @@ Because the WiPy/expansion board does not have a housing it needs a bit of care: If you experience a lot of static electricity in your area (eg dry and cold climates), take extra care not to shock the WiPy. If your WiPy came in a ESD bag, then this bag is the best way to store and carry the - pyboard as it will protect it agains static discharges. + WiPy as it will protect it agains static discharges. As long as you take care of the hardware, you should be okay. It's almost impossible to break the software on the WiPy, so feel free to play around @@ -46,7 +46,7 @@ Powering by an external power source The WiPy can be powered by a battery or other external power source. **Be sure to connect the positive lead of the power supply to VIN, and -ground to GND. There is no polarity protection on the pyboard so you +ground to GND. There is no polarity protection on the WiPy so you must be careful when connecting anything to VIN.** - When powering via ``VIN``: diff --git a/docs/wipy/tutorial/repl.rst b/docs/wipy/tutorial/repl.rst index 56c434f5ab..87b296f886 100644 --- a/docs/wipy/tutorial/repl.rst +++ b/docs/wipy/tutorial/repl.rst @@ -82,10 +82,10 @@ MicroPython prompt, i.e. ``>>>``. Let's make sure it is working with the obliga In the above, you should not type in the ``>>>`` characters. They are there to indicate that you should type the text after it at the prompt. In the end, once -you have entered the text ``print("hello pyboard!")`` and pressed Enter, the output +you have entered the text ``print("hello WiPy!")`` and pressed Enter, the output on your screen should look like it does above. -If you already know some python you can now try some basic commands here. +If you already know some Python you can now try some basic commands here. If any of this is not working you can try either a hard reset or a soft reset; see below.