add s2 c3 board CircuitPython support

wemos · Sep 2, 2022 · e4a761d · e4a761d
1 parent 99202ad
commit e4a761d
Show file tree

Hide file tree

Showing 7 changed files with 129 additions and 3 deletions.
diff --git a/docs/en/c3/c3_mini.rst b/docs/en/c3/c3_mini.rst
@@ -24,14 +24,15 @@ Features
 * 12x IO
 * ADC, I2C, SPI, UART
 * Compatible with LOLIN D1 mini shields 
-* Compatible with MicroPython, Arduino and ESP-IDF
+* Compatible with MicroPython, Arduino, CircuitPython and ESP-IDF
 * Default firmware: MicroPython
 
 Tutorials
 ----------------------
 
 * :doc:`../tutorials/c3/get_started_with_micropython_c3`
 * :doc:`../tutorials/c3/get_started_with_arduino_c3`
+* :doc:`../tutorials/c3/get_started_with_circuitpython_c3`
 
 Documentation
 ----------------------

diff --git a/docs/en/s2/s2_mini.rst b/docs/en/s2/s2_mini.rst
@@ -25,14 +25,15 @@ Features
 * 27x IO
 * ADC, DAC, I2C, SPI, UART, USB OTG
 * Compatible with LOLIN D1 mini shields 
-* Compatible with MicroPython, Arduino and ESP-IDF
+* Compatible with MicroPython, Arduino, CircuitPython and ESP-IDF
 * Default firmware: MicroPython
 
 Tutorials
 ----------------------
 
 * :doc:`../tutorials/s2/get_started_with_micropython_s2`
 * :doc:`../tutorials/s2/get_started_with_arduino_s2`
+* :doc:`../tutorials/s2/get_started_with_circuitpython_s2`
 
 Documentation
 ----------------------

diff --git a/docs/en/s2/s2_pico.rst b/docs/en/s2/s2_pico.rst
@@ -25,14 +25,15 @@ Features
 * 2MB PSRAM 
 * 21x IO
 * ADC, DAC, I2C, SPI, UART, USB OTG
-* Compatible with MicroPython, Arduino and ESP-IDF
+* Compatible with MicroPython, Arduino, CircuitPython and ESP-IDF
 * Default firmware: MicroPython
 
 Tutorials
 ----------------------
 
 * :doc:`../tutorials/s2/get_started_with_micropython_s2`
 * :doc:`../tutorials/s2/get_started_with_arduino_s2`
+* :doc:`../tutorials/s2/get_started_with_circuitpython_s2`
 
 Documentation
 ----------------------

diff --git a/docs/en/tutorials/c3/get_started_with_circuitpython_c3.rst b/docs/en/tutorials/c3/get_started_with_circuitpython_c3.rst
@@ -0,0 +1,53 @@
+Get started with CircuitPython [C3 series]
+=======================================================
+
+Flash CircuitPython firmware
+----------------------------
+
+Requirements
+---------------
+
+* `Python <https://www.python.org/downloads/>`_
+* `esptool <https://github.com/espressif/esptool>`_ (for flash esp32-c3 firmware.)
+
+.. highlight:: bash
+
+::
+
+      pip install esptool
+      
+S2 Firmware
+------------------
+
+* `Firmware <https://circuitpython.org/downloads?q=lolin+c3>`_
+
+
+Flash firmware
+-------------------
+* Make S2 boards into **Device Firmware Upgrade (DFU)** mode.
+
+  * Press and hold the **[9]** Button
+  * Press and release the  **[Reset]** Button
+  * Release the **[9]** Button
+
+* Flash using esptool.py
+
+  .. highlight:: bash
+
+  ::
+
+    esptool.py --chip esp32c3 --port PORT_NAME --baud 1000000 write_flash -z 0x0 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
+-------------------------
+* `Welcome To CircuitPython <https://learn.adafruit.com/welcome-to-circuitpython>`_
+
+
+
diff --git a/docs/en/tutorials/index.rst b/docs/en/tutorials/index.rst
@@ -6,6 +6,7 @@ Tutorials
 
    MicroPython Tutorials <index_micropython>
    Arduino Tutorials <index_arduino>
+   CircuitPython Tutorials <index_circuitpython>
    Others <index_others>
 
 

diff --git a/docs/en/tutorials/index_circuitpython.rst b/docs/en/tutorials/index_circuitpython.rst
@@ -0,0 +1,16 @@
+CircuitPython Tutorials
+=========================
+
+.. toctree::
+   :maxdepth: 1
+
+   Get started with CircuitPython [S2 series] <s2/get_started_with_circuitpython_s2>
+   Get started with CircuitPython [C3 series] <c3/get_started_with_circuitpython_c3>
+   Get started with CircuitPython [S3 series] <s3/get_started_with_circuitpython_s3>
+
+
+
+
+
+
+
diff --git a/docs/en/tutorials/s2/get_started_with_circuitpython_s2.rst b/docs/en/tutorials/s2/get_started_with_circuitpython_s2.rst
@@ -0,0 +1,53 @@
+Get started with CircuitPython [S2 series]
+=======================================================
+
+Flash CircuitPython firmware
+----------------------------
+
+Requirements
+---------------
+
+* `Python <https://www.python.org/downloads/>`_
+* `esptool <https://github.com/espressif/esptool>`_ (for flash esp32-s2 firmware.)
+
+.. highlight:: bash
+
+::
+
+      pip install esptool
+      
+S2 Firmware
+------------------
+
+* `Firmware <https://circuitpython.org/downloads?q=lolin+s2>`_
+
+
+Flash firmware
+-------------------
+* Make S2 boards into **Device Firmware Upgrade (DFU)** mode.
+
+  * Press and hold the **[0]** Button
+  * Press and release the  **[Reset]** Button
+  * Release the **[0]** Button
+
+* Flash using esptool.py
+
+  .. highlight:: bash
+
+  ::
+
+    esptool.py --chip esp32s2 --port PORT_NAME --baud 1000000 write_flash -z 0x0 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
+-------------------------
+* `Welcome To CircuitPython <https://learn.adafruit.com/welcome-to-circuitpython>`_
+
+
+