T-Deck

Name: T-Deck
Author: xinyuan-lilygo

Multi-purpose View the repo

623 stars · 118 forksGitHub repo · as of 2026-11-11 17:08 UTC

Maintainer: xinyuan-lilygo
Chip families: esp32-s3

Boards with a recipe, by trust tier

Unverified

T-DeckUnverifiedLILYGO
Flash T-Deckguidedread the caveat
Unverified esp-atlas asserts this board↔firmware link at the shown trust tier — it does not guarantee your specific unit or the current firmware version. Flashing can erase keys/config and can brick the device. At your own risk.
Caveat: This is LilyGO's own example repository for the T-Deck and T-Deck Plus, not a single application. Its platformio.ini selects env:T-Deck (board=T-Deck) by default and builds one example at a time through src_dir; the default is examples/UnitTest (commit 9aac147). Pick the example you want in src_dir before building. Not verified: no current successful build confirmed and not tested on hardware for this atlas.

README

✨ LilyGO T-Deck ✨

English | 中文

[!TIP]

For the factory firmware of the new version, please visit LilyGoLib.

News:

T-Deck-Plus has assigned the pins on the Grove interface to the GPS module, so the Grove interface of T-Deck-Plus cannot be used.
T-Deck updated TFT_eSPI ST7789 initialization sequence on 20240726. Currently, the changes have not been pushed to the TFT_eSPI upstream branch. If you find that the screen display is incorrect during use, please check whether this is consistent with the initialization sequence in the warehouse.

1️⃣ Examples preview

examples 
├─Keyboard_ESP32C3       # ESP32C3 keyboard I2C slave
├─Keyboard_T_Deck_Master # T-Deck read from keyboard
├─LoRaWAN_Starter        # LoRaWAN example
├─Microphone             # Noise detection  
├─Touchpad               # Read touch coordinates 
├─GPSShield              # GPS Shield example
├─lvgl_example           # lvgl example
└─UnitTest               # Factory hardware unit testing

2️⃣ Quick Start

PlatformIO

Install VisualStudioCode and Python
Search for the PlatformIO plugin in the VisualStudioCode extension and install it.
After the installation is complete, you need to restart VisualStudioCode
After restarting VisualStudioCode, select File in the upper left corner of VisualStudioCode -> Open Folder -> select the T-Deck directory
Click on the platformio.ini file, and in the platformio column, cancel the sample line that needs to be used, please make sure that only one line is valid
Click the (✔) symbol in the lower left corner to compile
Connect the board to the computer USB
Click (→) to upload firmware
Click (plug symbol) to monitor serial output

Optional:

You can upload the assets contents for the speaker demo, using the "Upload Filesystem Image" on PlatformIO menu.

ArduinoIDE

Install Arduino IDE
In Arduino Preferences, on the Settings tab, enter the https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json URL in the Additional boards manager URLs input box. Please pay attention to the version. The test phase is using 2.0.14. It is not certain that versions above 2.0.14 can run. When the operation is abnormal, please downgrade to a version below 2.0.14. , As of 2024/08/02, TFT_eSPI does not work on versions higher than 2.0.14, see TFT_eSPI/issue3329
Copy all the folders in the T-Deck/lib directory to <C:\Users\UserName\Documents\Arduino\libraries>. If there is no libraries directory, please create a new one. Please note that you are not copying the lib directory, but copying the folders in the lib directory
Open ArduinoIDE ,Tools , Look at the picture to choose | T-Deck(ESP32S3) | T-Keyboard(ESP32C3) | | -------------------- | -------------------- | | | |
Insert USB into the PC and click Upload <If the upload fails, keep pressing the BOOT button, click RST, and then click Upload. When the upload is complete, click RST to exit the download mode>

3️⃣ Tips:

If a microphone is used, the GPIOO button cannot be used
If the sketch cannot be uploaded, then you need to press down the middle of the trackball, and then insert the USB, this means the chip is in the download mode, and then click to upload the sketch.
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 TX,RX,BOOT,RST,GND,VCC, 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.
T-Deck can't upload any sketch，Please enter the upload mode manually.
1. Connect the USB-C cable
2. Toggle the switch to ON
3. Press and hold the center trackball
4. Press the left reset button
5. Upload sketch
6. If you still cannot upload the sketch successfully according to the above method, please check whether the resistor in this issue62 exists. Please remove it and test again.
7. How to enter download mode Youtube
fatal error: esp_vad.h: No such file or directory
1. See issus
Grove interface model?
- HY2.0-4P

4️⃣ Where to buy:

5️⃣ Pins:

See utilities.h

Shell

See shell

Read the full README on GitHub

source github.com/Xinyuan-LilyGO/T-Deck