Skip to content

Commit 8faf2dc

Browse files
author
danicampora
committed
docs/wipy: Add wipy tutorials section.
1 parent 36ae417 commit 8faf2dc

File tree

6 files changed

+39
-3
lines changed

6 files changed

+39
-3
lines changed

docs/library/network.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ For example::
3737
Constructors
3838
------------
3939

40-
.. class:: server(id, ...)
40+
.. class:: network.server(id, ...)
4141

4242
Create a server instance, see ``init`` for parameters of initialization.
4343

docs/topindex.html

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ <h1>MicroPython documentation</h1>
3434
<a class="biglink" href="{{ pathto(port + "/general") }}">General information about {{ port_name }}</a><br/>
3535
<span class="linkdescr">read this first for a quick overview</span>
3636
</p>
37-
{% endif %}
38-
{% if port == "pyboard" %}
3937
<p class="biglink">
4038
<a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials and code examples</a><br/>
4139
<span class="linkdescr">start here</span>

docs/wipy/general.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ to one, otherwise FileZilla will try to open a second command connection when re
6767
and saving files, and for simplicity and to reduce code size, only one command and one
6868
data connections are possible. Other FTP clients might behave in a similar way.
6969

70+
.. _wipy_firmware_upgrade:
71+
7072
Upgrading the firmware Over The Air
7173
-----------------------------------
7274

@@ -79,6 +81,10 @@ verify its integrity. Now, reset the MCU by pressing the switch on the board, or
7981
import machine
8082
machine.reset()
8183

84+
Software updates can be found in: https://github.com/wipy/wipy/releases
85+
It's always recommended to update to the latest software, but make sure to
86+
read the ``release notes`` before.
87+
8288
Boot modes
8389
----------
8490

docs/wipy/tutorial/index.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. _wipy_tutorial_index:
2+
3+
WiPy tutorials and examples
4+
===========================
5+
6+
Performing firmware upgrades
7+
----------------------------
8+
9+
For detalied instructions see :ref:`OTA How-To <wipy_firmware_upgrade>`.
10+
11+
Getting started with Blynk and the WiPy
12+
---------------------------------------
13+
14+
Blynk is a platform with iOS and Android apps to control
15+
Arduino, Raspberry Pi and the likes over the Internet.
16+
You can easily build graphic interfaces for all your
17+
projects by simply dragging and dropping widgets.
18+
19+
There are several examples available that work out-of-the-box with
20+
the WiPy. Before anything else, make sure that your WiPy is running
21+
the latest software, check :ref:`OTA How-To <wipy_firmware_upgrade>`.
22+
23+
1. Get the `Blynk library <https://github.com/wipy/wipy/blob/master/lib/blynk/BlynkLib.py>`_ and put it in ``/flash/lib/`` via FTP.
24+
2. Get the `Blynk examples <https://github.com/wipy/wipy/tree/master/examples/blynk>`_ edit the network settings, and afterwards
25+
upload them to ``/flash/lib/`` via FTP as well.
26+
3. Follow the instructions on each example to setup the Blynk dashboard on your smartphone.
27+
4. Give it a try, for instance::
28+
29+
>>> execfile('01_simple.py')
30+

docs/wipy_contents.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ MicroPython documentation contents
55

66
wipy/quickref.rst
77
wipy/general.rst
8+
wipy/tutorial/index.rst
89
library/index.rst
910
reference/index.rst
1011
license.rst

docs/wipy_index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ MicroPython documentation and references
55

66
wipy/quickref.rst
77
wipy/general.rst
8+
wipy/tutorial/index.rst
89
library/index.rst
910
license.rst
1011
wipy_contents.rst

0 commit comments

Comments
 (0)