add micropython.rst

wemos · Oct 18, 2019 · a36c979 · a36c979
1 parent f9f2d91
commit a36c979
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 4 deletions.
diff --git a/docs/en/ch340_driver.rst b/docs/en/ch340_driver.rst
@@ -0,0 +1,6 @@
+CH340 Driver
+===============
+
+  * `Windows V3.5 <https://github.com/wemos/ch340_driver/raw/master/CH341SER_WIN_3.5.ZIP>`_
+  * `Mac OSX V1.5 <https://github.com/wemos/ch340_driver/raw/master/CH341SER_MAC_1.5.ZIP>`_
+
diff --git a/docs/en/conf.py b/docs/en/conf.py
@@ -28,6 +28,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx-prompt'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/en/d1/d1_mini.rst b/docs/en/d1/d1_mini.rst
@@ -12,7 +12,11 @@ LOLIN D1 mini
 .. _BOTTOM_IMG: ../_static/d1_mini_v3.1.0_2_16x16.jpg
 
 
+.. .. raw:: html
 
+..     <div style="text-align: center; margin-bottom: 2em;">
+..     <iframe width="100%" height="350" src="https://www.youtube.com/embed/oJsUvBQyHBs?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
+..     </div>
 
 
 A mini wifi board with 4MB flash based on ESP-8266EX.
@@ -28,8 +32,8 @@ Features
 
 Tutorials
 ----------------------
-  * Get started in MicroPython
-  * Get started in Arduino
+  * :doc:`../tutorials/micropython`
+  * :doc:`../tutorials/arduino`
 
 Documentation
 ----------------------
@@ -92,6 +96,8 @@ Pin
 | RST  | Reset                        | RST          |
 +------+------------------------------+--------------+
 
+.. note:: All of the IO pins run at 3.3V.
+
 Version
 ----------------------
   * V3.1.0(current)

diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -13,8 +13,7 @@ WEMOS Docs
    :hidden:
    :caption: Tutorials:
 
-   Arduino <d1/index>
-   MicroPython <d1/index>
+   Tutorials <tutorials/index>
 
 .. Indices and tables
 .. ==================

diff --git a/docs/en/tutorials/arduino.rst b/docs/en/tutorials/arduino.rst
@@ -0,0 +1,17 @@
+Get started with Arduino
+==========================
+
+Requirements
+---------------
+  * :doc:`../ch340_driver`
+  * `Python <https://www.python.org/downloads/>`_
+  * `Arduino IDE <https://www.arduino.cc/>`_
+
+Installing Hardware package
+-----------------------------
+  * `esp8266 package <https://github.com/esp8266/Arduino>`_ (D1 mini/D1 mini Pro)
+  * `esp32 package <https://github.com/espressif/arduino-esp32>`_ (D32/D32 Pro)
+
+Configure Board
+-------------------
+After install hardware package, you will see WEMOS boards in the Tools→Board:xxx Choose your right board.
diff --git a/docs/en/tutorials/index.rst b/docs/en/tutorials/index.rst
@@ -0,0 +1,15 @@
+Tutorials
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   Arduino <arduino>
+   MicroPython <micropython>
+
+
+
+
+
+
+
diff --git a/docs/en/tutorials/micropython.rst b/docs/en/tutorials/micropython.rst
@@ -0,0 +1,47 @@
+Get started with MicroPython
+=================================
+
+Requirements
+---------------
+  * :doc:`../ch340_driver`
+  * `Python <https://www.python.org/downloads/>`_
+  * `esptool <https://github.com/espressif/esptool>`_ (for flash esp8266&esp32 firmware.)
+  * w600tool
+
+MicroPython firmware
+------------------------
+
+Choose the right firmware:
+  * `D1 mini/D1 mini Pro firmware <https://micropython.org/download#esp8266>`_ (esp8266)
+  * `D32/D32 Pro firmware <https://micropython.org/download#esp32>`_ (esp32)(*D32 Pro cloud use Firmware with SPIRAM support*)
+  * w600 firmware (W600-Pico)
+
+Flash firmware
+------------------------
+
+.. note::  Don't forget to change **YOUR_PORT_NAME** and **YOUR_FIRMWARE.bin**. In Linux, **YOUR_PORT_NAME** is like /dev/ttyUSB0. In windows, **YOUR_PORT_NAME** is like COM4.
+
+
+D1 mini
+*********************
+
+.. prompt:: bash $
+
+    esptool.py --port YOUR_PORT_NAME erase_flash
+    esptool.py --port YOUR_PORT_NAME --baud 1000000 write_flash --flash_size=4MB -fm qio 0 YOUR_FIRMWARE.bin
+
+D32/D32 Pro
+*******************
+
+.. prompt:: bash $
+
+    esptool.py --port YOUR_PORT_NAME erase_flash
+    esptool.py --port YOUR_PORT_NAME --baud 1000000 write_flash -z 0x1000 YOUR_FIRMWARE.bin
+
+
+
+W600-Pico
+*******************
+
+
+