diff --git a/firmware/README.MD b/firmware/README.MD index c98a7f3..8e8b78a 100644 --- a/firmware/README.MD +++ b/firmware/README.MD @@ -1,4 +1,81 @@ -# How to flash ? +# Write to new users -1. [Win10](https://github.com/Xinyuan-LilyGO/LilyGo-Document/blob/master/WinFlashBin.md) -2. [Mac & Liunx](https://github.com/Xinyuan-LilyGO/LilyGo-Document/blob/master/MacFlashBin.md) +- This page provides a quick diagnosis of whether the hardware is normal. The firmware in the example table below provides quick testing of the hardware. Please follow the steps below to test + +# 1️⃣ Quickly diagnose hardware + +| Firmware Name | description | +| ---------------------------------------------------------- | ----------------------------------------- | +| [firmware-c3-t-keyboard.bin](./firmware-c3-t-keyboard.bin) | [T-Deck Keyboard C3 firmware][1] | +| [T-Deck_UnitTest_241004.bin](./T-Deck_UnitTest_241004.bin) | [T-Deck/T-Deck-Plus function firmware][1] | +| [firmware-c3-t-keyboard.bin](./firmware-c3-t-keyboard.bin) | [T-Deck/T-Deck-Plus factory firmware][2] | + +[1]: https://www.lilygo.cc/products/t-deck +[2]: https://www.lilygo.cc/products/t-deck +[3]: https://www.lilygo.cc/products/t-deck + + + +### Use ESP Download Tool + +- Download [Flash_download_tool](https://www.espressif.com.cn/sites/default/files/tools/flash_download_tool_3.9.7_0.zip) + +![web_flasher](./images/esp_downloader.gif) + +* Note that after writing is completed, you need to press RST to reset. +* When writing the keyboard firmware, you need to select ESP32-C3 in the chip type + +### Use Web Flasher + +- [ESP Web Flasher Online](https://espressif.github.io/esptool-js/) + +![web_flasher](./images/web_flasher.gif) + +* Note that after writing is completed, you need to press RST to reset. + +### Use command line + + +If system asks about install Developer Tools, do it. + +``` +python3 -m pip install --upgrade pip +python3 -m pip install esptool +``` + +In order to launch esptool.py, exec directly with this: + +``` +python3 -m esptool +``` + +For T-Deck/T-Deck-Plus use the following command to write + +``` +esptool --chip esp32s3 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m 0x0 T-Deck_UnitTest_241004.bin + +``` + + +For ESP32-C3 Keyboard use the following command to write + +``` +esptool --chip esp32c3 --baud 921600 --before default_reset --after hard_reset write_flash -z --flash_mode dio --flash_freq 80m 0x0 firmware-c3-t-keyboard.bin + +``` + + +# 2️⃣FAQ + +- Can't upload any sketch,Please enter the upload mode manually. + 1. Connect the board via the USB cable + 2. Press and hold the **BOOT** button , While still pressing the **BOOT** button (On the trackball above the keyboard, press down) + 3. Press **RST** button + 4. Release the **RST** button + 5. Release the **BOOT** button (If there is no **BOOT** button, disconnect IO0 from GND.) + 6. Upload sketch + 7. Press the **RST** button to exit download mode + +- T-Keyboard the programming and burning interface of ESP32C3 is located at the 6Pin header on the side of the RST button, and the order starts from the top of the RST button, which are 3V3, GND, RST, BOOT, RX, TX, You need to connect USB TO TTL externally to burn the keyboard firmware. For TTL without automatic download circuit, before powering on, short-circuit the BOOT Pin and GND, and then power on. At this time, T-Keyboard will enter the download mode. After the burning is completed, you need to disconnect GND and BOOT before running the program. + + ![c3_boot](../images/c3_boot.jpg) \ No newline at end of file diff --git a/firmware/images/esp32s3-1.png b/firmware/images/esp32s3-1.png new file mode 100644 index 0000000..514fb69 Binary files /dev/null and b/firmware/images/esp32s3-1.png differ diff --git a/firmware/images/esp32s3-2.png b/firmware/images/esp32s3-2.png new file mode 100644 index 0000000..635d9bb Binary files /dev/null and b/firmware/images/esp32s3-2.png differ diff --git a/firmware/images/esp_downloader.gif b/firmware/images/esp_downloader.gif new file mode 100644 index 0000000..8310d2c Binary files /dev/null and b/firmware/images/esp_downloader.gif differ diff --git a/firmware/images/log.png b/firmware/images/log.png new file mode 100644 index 0000000..6b35d5e Binary files /dev/null and b/firmware/images/log.png differ diff --git a/firmware/images/web_flasher.gif b/firmware/images/web_flasher.gif new file mode 100644 index 0000000..afcca1a Binary files /dev/null and b/firmware/images/web_flasher.gif differ