Skip to content

T-Display Keyboard Quick Start

Required Libraries

LibraryVersionSource
TFT_eSPILatestGitHub

Arduino

  1. Install VS Code and the PlatformIO IDE extension
  2. Clone the repository:
    bash
    git clone https://github.com/Xinyuan-LilyGO/TTGO-T-Display.git
  3. Open platformio.ini and select your example
  4. Click to build, click to upload

Arduino IDE

1. Install ESP32 Board Support

  1. Open Arduino IDE → FilePreferences
  2. Add to "Additional Board Manager URLs":
    https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
  3. Go to ToolsBoardBoards Manager, search esp32, install esp32 by Espressif Systems

2. Board Settings

SettingValue
BoardESP32 Dev Module
Upload Speed921600
CPU Frequency240 MHz (WiFi)
Flash Size4 MB (32Mb)
Partition SchemeDefault 4MB with spiffs

3. Upload

Open an example, select the correct port, and click Upload.


Peripheral Examples

Hello World (TFT_eSPI)

cpp
#include <TFT_eSPI.h>

TFT_eSPI tft;

void setup() {
    tft.init();
    tft.setRotation(1);
    tft.fillScreen(TFT_BLACK);
    tft.setTextColor(TFT_WHITE, TFT_BLACK);
    tft.setTextSize(2);
    tft.setCursor(20, 55);
    tft.println("T-Display Keyboard");
}

void loop() {}

FAQ

Q: Upload keeps failing?
A: Hold BOOT, press and release RST, then release BOOT to enter download mode.

Q: What keyboard shell does T-Display Keyboard use?
A: It uses a compact QWERTY-style physical keyboard shell that houses the T-Display (ESP32 + 1.14" ST7789V) board and a battery holder.