summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authordanicampora <daniel@wipy.io>2015-10-19 16:28:29 +0200
committerdanicampora <daniel@wipy.io>2015-10-19 21:17:15 +0200
commit8faf2dc75b140e7f6f915b8d90e4b86366f56997 (patch)
treea06530729c5d9ced2ca2f38ff82c8ae6a24394c8
parent36ae417c9f1417d65ca773d48a36589e300b4f71 (diff)
downloadmicropython-8faf2dc75b140e7f6f915b8d90e4b86366f56997.tar.gz
micropython-8faf2dc75b140e7f6f915b8d90e4b86366f56997.zip
docs/wipy: Add wipy tutorials section.
-rw-r--r--docs/library/network.rst2
-rw-r--r--docs/topindex.html2
-rw-r--r--docs/wipy/general.rst6
-rw-r--r--docs/wipy/tutorial/index.rst30
-rw-r--r--docs/wipy_contents.rst1
-rw-r--r--docs/wipy_index.rst1
6 files changed, 39 insertions, 3 deletions
diff --git a/docs/library/network.rst b/docs/library/network.rst
index 4485ff7e1b..794ce70c87 100644
--- a/docs/library/network.rst
+++ b/docs/library/network.rst
@@ -37,7 +37,7 @@ For example::
Constructors
------------
- .. class:: server(id, ...)
+ .. class:: network.server(id, ...)
Create a server instance, see ``init`` for parameters of initialization.
diff --git a/docs/topindex.html b/docs/topindex.html
index 0a65f42105..fe61b5b927 100644
--- a/docs/topindex.html
+++ b/docs/topindex.html
@@ -34,8 +34,6 @@
<a class="biglink" href="{{ pathto(port + "/general") }}">General information about {{ port_name }}</a><br/>
<span class="linkdescr">read this first for a quick overview</span>
</p>
- {% endif %}
- {% if port == "pyboard" %}
<p class="biglink">
<a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials and code examples</a><br/>
<span class="linkdescr">start here</span>
diff --git a/docs/wipy/general.rst b/docs/wipy/general.rst
index 528dd4c196..e52fcc9266 100644
--- a/docs/wipy/general.rst
+++ b/docs/wipy/general.rst
@@ -67,6 +67,8 @@ to one, otherwise FileZilla will try to open a second command connection when re
and saving files, and for simplicity and to reduce code size, only one command and one
data connections are possible. Other FTP clients might behave in a similar way.
+.. _wipy_firmware_upgrade:
+
Upgrading the firmware Over The Air
-----------------------------------
@@ -79,6 +81,10 @@ verify its integrity. Now, reset the MCU by pressing the switch on the board, or
import machine
machine.reset()
+Software updates can be found in: https://github.com/wipy/wipy/releases
+It's always recommended to update to the latest software, but make sure to
+read the ``release notes`` before.
+
Boot modes
----------
diff --git a/docs/wipy/tutorial/index.rst b/docs/wipy/tutorial/index.rst
new file mode 100644
index 0000000000..751d9d7976
--- /dev/null
+++ b/docs/wipy/tutorial/index.rst
@@ -0,0 +1,30 @@
+.. _wipy_tutorial_index:
+
+WiPy tutorials and examples
+===========================
+
+Performing firmware upgrades
+----------------------------
+
+For detalied instructions see :ref:`OTA How-To <wipy_firmware_upgrade>`.
+
+Getting started with Blynk and the WiPy
+---------------------------------------
+
+Blynk is a platform with iOS and Android apps to control
+Arduino, Raspberry Pi and the likes over the Internet.
+You can easily build graphic interfaces for all your
+projects by simply dragging and dropping widgets.
+
+There are several examples available that work out-of-the-box with
+the WiPy. Before anything else, make sure that your WiPy is running
+the latest software, check :ref:`OTA How-To <wipy_firmware_upgrade>`.
+
+1. Get the `Blynk library <https://github.com/wipy/wipy/blob/master/lib/blynk/BlynkLib.py>`_ and put it in ``/flash/lib/`` via FTP.
+2. Get the `Blynk examples <https://github.com/wipy/wipy/tree/master/examples/blynk>`_ edit the network settings, and afterwards
+ upload them to ``/flash/lib/`` via FTP as well.
+3. Follow the instructions on each example to setup the Blynk dashboard on your smartphone.
+4. Give it a try, for instance::
+
+ >>> execfile('01_simple.py')
+
diff --git a/docs/wipy_contents.rst b/docs/wipy_contents.rst
index 7f45a7aa84..2beffa236e 100644
--- a/docs/wipy_contents.rst
+++ b/docs/wipy_contents.rst
@@ -5,6 +5,7 @@ MicroPython documentation contents
wipy/quickref.rst
wipy/general.rst
+ wipy/tutorial/index.rst
library/index.rst
reference/index.rst
license.rst
diff --git a/docs/wipy_index.rst b/docs/wipy_index.rst
index da81ba6bce..9fe3dce896 100644
--- a/docs/wipy_index.rst
+++ b/docs/wipy_index.rst
@@ -5,6 +5,7 @@ MicroPython documentation and references
wipy/quickref.rst
wipy/general.rst
+ wipy/tutorial/index.rst
library/index.rst
license.rst
wipy_contents.rst