diff --git a/_static/getting_started_pics/burn_firmware_01.png b/_static/getting_started_pics/burn_firmware_01.png new file mode 100644 index 00000000..8ee8dfb1 Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_01.png differ diff --git a/_static/getting_started_pics/burn_firmware_02.png b/_static/getting_started_pics/burn_firmware_02.png new file mode 100644 index 00000000..99d08b21 Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_02.png differ diff --git a/_static/getting_started_pics/burn_firmware_03.png b/_static/getting_started_pics/burn_firmware_03.png new file mode 100644 index 00000000..3900380e Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_03.png differ diff --git a/_static/getting_started_pics/burn_firmware_04.png b/_static/getting_started_pics/burn_firmware_04.png new file mode 100644 index 00000000..cba8a1f9 Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_04.png differ diff --git a/_static/getting_started_pics/burn_firmware_05.png b/_static/getting_started_pics/burn_firmware_05.png new file mode 100644 index 00000000..ceb729f4 Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_05.png differ diff --git a/_static/getting_started_pics/burn_firmware_06.png b/_static/getting_started_pics/burn_firmware_06.png new file mode 100644 index 00000000..e5be8c56 Binary files /dev/null and b/_static/getting_started_pics/burn_firmware_06.png differ diff --git a/_static/getting_started_pics/download_M5Burner.png b/_static/getting_started_pics/download_M5Burner.png new file mode 100644 index 00000000..90eb4217 Binary files /dev/null and b/_static/getting_started_pics/download_M5Burner.png differ diff --git a/en/get-started/how_to_burn_firmware_en.md b/en/get-started/how_to_burn_firmware_en.md index 04e7ce7c..1415ecc7 100644 --- a/en/get-started/how_to_burn_firmware_en.md +++ b/en/get-started/how_to_burn_firmware_en.md @@ -4,6 +4,51 @@ This article will guide you how to burn a right firmware to your board. ### For MacOS - +***(Coming soon...)*** ### For Windows + +#### 1. Download M5Burner + +For downloading M5Burner, visit the [offical website](http://www.m5stack.com) please. + +![image](../../_static/getting_started_pics/download_M5Burner.png) + +#### 2. Burn the firmware + +Unpack the M5Burner tool which you donwloaded for official website just now in any folder, then execute the executable file `M5Burner.exe`. + +![image](../../_static/getting_started_pics/burn_firmware_01.png) + + +**Then choice the `serial port` which is connected with your board and the `Baud` which is 921600 following below steps.** + +![image](../../_static/getting_started_pics/burn_firmware_02.png) + +**1. Choice a right firmware** + +a. select `M5Flow-vx.x` option, if you want to program with [M5Flow](http://flow.m5stack.com) + +b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA) + +**2. Click `Erase`** + +![image](../../_static/getting_started_pics/burn_firmware_06.png) + +*If M5Burner shows the information `Hard resetting via RTS pin...` below, it means chip has been erased successfully.* + +![image](../../_static/getting_started_pics/burn_firmware_04.png) + + +**3. Click `Burn`** + +![image](../../_static/getting_started_pics/burn_firmware_03.png) + +*If M5Burner shows the information `Leaving... Staying in bootloader.` below, it means chip has been burnt successfully.* + +![image](../../_static/getting_started_pics/burn_firmware_05.png) + +#### ***Note:*** +***1. If M5Burner means be busy after clicking `Burn`, please wait for a few minutes. It'll be normal after the firmware has been burnt successfully.*** + +***2. If the burning procedure has been interrupted(like M5Burner has been closed suddenly...), it's better to burn your board again.*** \ No newline at end of file diff --git a/en/get-started/how_to_burn_firmware_en.rst b/en/get-started/how_to_burn_firmware_en.rst index e69de29b..75f7c551 100644 --- a/en/get-started/how_to_burn_firmware_en.rst +++ b/en/get-started/how_to_burn_firmware_en.rst @@ -0,0 +1,83 @@ +How to Burn Firmware +==================== + +This article will guide you how to burn a right firmware to your board. + +For MacOS +~~~~~~~~~ + +***(Coming soon...)*** + +For Windows +~~~~~~~~~~~ + +1. Download M5Burner +^^^^^^^^^^^^^^^^^^^^ + +For downloading M5Burner, visit the `offical +website `__ please. + +.. figure:: ../../_static/getting_started_pics/download_M5Burner.png + :alt: image + + image +2. Burn the firmware +^^^^^^^^^^^^^^^^^^^^ + +Unpack the M5Burner tool which you donwloaded for official website just +now in any folder, then execute the executable file ``M5Burner.exe``. + +.. figure:: ../../_static/getting_started_pics/burn_firmware_01.png + :alt: image + + image +**Then choice the ``serial port`` which is connected with your board and +the ``Baud`` which is 921600 following below steps.** + +.. figure:: ../../_static/getting_started_pics/burn_firmware_02.png + :alt: image + + image +**1. Choice a right firmware** + +a. select ``M5Flow-vx.x`` option, if you want to program with + `M5Flow `__ + +b. select ``M5Cam-vx.x (/M5Cam-psram)`` option, if you own a ESP32CAM (/ + M5CAMERA) + +**2. Click ``Erase``** + +.. figure:: ../../_static/getting_started_pics/burn_firmware_06.png + :alt: image + + image +*If M5Burner shows the information ``Hard resetting via RTS pin...`` +below, it means chip has been erased successfully.* + +.. figure:: ../../_static/getting_started_pics/burn_firmware_04.png + :alt: image + + image +**3. Click ``Burn``** + +.. figure:: ../../_static/getting_started_pics/burn_firmware_03.png + :alt: image + + image +*If M5Burner shows the information ``Leaving... Staying in bootloader.`` +below, it means chip has been burnt successfully.* + +.. figure:: ../../_static/getting_started_pics/burn_firmware_05.png + :alt: image + + image +***Note:*** +^^^^^^^^^^^ + +***1. If M5Burner means be busy after clicking ``Burn``, please wait for +a few minutes. It'll be normal after the firmware has been burnt +successfully.*** + +***2. If the burning procedure has been interrupted(like M5Burner has +been closed suddenly...), it's better to burn your board again.***