add c3 mini docs

wemos · Mar 8, 2022 · c6f7c05 · c6f7c05
1 parent c106845
commit c6f7c05
Show file tree

Hide file tree

Showing 5 changed files with 87 additions and 0 deletions.
diff --git a/docs/en/_static/files/c3_mini_firmware/c3_mini_micropython_v1.16.bin b/docs/en/_static/files/c3_mini_firmware/c3_mini_micropython_v1.16.bin
diff --git a/docs/en/tutorials/c3/get_started_with_arduino_c3.rst b/docs/en/tutorials/c3/get_started_with_arduino_c3.rst
@@ -0,0 +1,26 @@
+Get started with Arduino [C3 series]
+==================================================
+
+Requirements
+---------------
+  * `Python <https://www.python.org/downloads/>`_
+  * `Arduino IDE <https://www.arduino.cc/>`_
+
+Installing Hardware package
+-----------------------------
+  * `lastest esp32 package <https://github.com/espressif/arduino-esp32>`_ 
+
+
+Upload Code
+-----------------
+* Make C3 boards into **Device Firmware Upgrade (DFU)** mode.
+
+  * Hold on **Button 9**
+  * Press **Button Reset**
+  * Release **Button 9** When you hear the prompt tone on usb reconnection
+
+Documentation
+-------------------------
+  * `ESP32-S2 and ESP32-C3 Support <https://github.com/espressif/arduino-esp32#esp32-s2-and-esp32-c3-support>`_
+
+
diff --git a/docs/en/tutorials/c3/get_started_with_micropython_c3.rst b/docs/en/tutorials/c3/get_started_with_micropython_c3.rst
@@ -0,0 +1,59 @@
+Get started with MicroPython [C3 series]
+=======================================================
+
+Flash MicroPython firmware
+----------------------------
+
+The boards were already flashed micropython firmware.
+If they lost firmware or you need lastest firmware, 
+you can flash MicroPython firmware by yourself.
+
+Requirements
+---------------
+
+* `Python <https://www.python.org/downloads/>`_
+* `esptool <https://github.com/espressif/esptool>`_ (for flash ESP32-C3 firmware.)
+
+.. highlight:: bash
+
+::
+
+      pip install esptool
+      
+S2 MINI Firmware
+------------------
+* `c3_mini_micropython_v1.16.bin <../../_static/files/c3_mini_firmware/c3_mini_micropython_v1.16.bin>`_
+
+
+
+
+Flash firmware
+-------------------
+* Make S2 boards into **Device Firmware Upgrade (DFU)** mode.
+
+  * Hold on **Button 9**
+  * Press **Button Reset**
+  * Release **Button 9** When you hear the prompt tone on usb reconnection
+
+* Flash using esptool.py
+
+  .. highlight:: bash
+
+  ::
+
+    esptool.py --port PORT_NAME erase_flash
+    esptool.py --port PORT_NAME --baud 1000000 write_flash -z 0 FIRMWARE.bin
+
+.. note::  
+  Don't forget to change **PORT_NAME** and **FIRMWARE.bin**.
+
+  In Linux, **PORT_NAME** is like /dev/ttyUSB0.
+  In windows, **PORT_NAME** is like COM4.
+
+
+Quick reference
+-------------------------
+* `Quick reference for the ESP32 <https://docs.micropython.org/en/latest/esp32/quickref.html>`_
+
+
+
diff --git a/docs/en/tutorials/index_arduino.rst b/docs/en/tutorials/index_arduino.rst
@@ -7,6 +7,7 @@ Arduino Tutorials
    Get started with Arduino [D1/D1 mini series] <d1/get_started_with_arduino_d1>
    Get started with Arduino [D32 series] <d32/get_started_with_arduino_d32>
    Get started with Arduino [S2 series] <s2/get_started_with_arduino_s2>
+   Get started with Arduino [C3 series] <c3/get_started_with_arduino_c3>
 
 
 

diff --git a/docs/en/tutorials/index_micropython.rst b/docs/en/tutorials/index_micropython.rst
@@ -7,6 +7,7 @@ MicroPython Tutorials
    Get started with MicroPython [D1/D1 mini series] <d1/get_started_with_micropython_d1>
    Get started with MicroPython [D32 series] <d32/get_started_with_micropython_d32>
    Get started with MicroPython [S2 series] <s2/get_started_with_micropython_s2>
+   Get started with MicroPython [C3 series] <c3/get_started_with_micropython_c3>
    Get started with MicroPython [W600 series] <w600/get_started_with_micropython_w600>