🌟LilyGO T-RGB🌟

News🏳️‍🌈

• How to integrate LilyGo-T-RGB in your own project, please refer to issue
• LilyGo-T-RGB esp-idf version example, please jump to this LilyGo-Display-IDF

• LilyGo-T-RGB depends on lvgl v8.3.x version. Currently lvgl has released lvgl v9.0 version. When compilation error occurs, please check whether lvgl belongs to v8.3.x

1️⃣Support Product

Product(PinMap)	SOC	Flash	PSRAM	Resolution	Size
T-RGB 2.1 inch Half Circle	ESP32-S3R8	16MB	8MB(OPI)	480x480	2.1 Inch
T-RGB 2.1 inch Full Circle	ESP32-S3R8	16MB	8MB(OPI)	480x480	2.1 Inch
T-RGB 2.8 inch Full Circle	ESP32-S3R8	16MB	8MB(OPI)	480x480	2.8 Inch

Product(PinMap)	Display Driver	Touch Driver
T-RGB 2.1 inch Half Circle	ST7701S	FT3267
T-RGB 2.1 inch Full Circle	ST7701S	CST820
T-RGB 2.8 inch Full Circle	ST7701S	GT911

2️⃣Examples

examples/
├── AdjustBacklight             # Backlight adjustment example
├── Arduino_GFX_HelloWorld      # Arduino_GFX example
├── Arduino_GFX_SpriteGif       # Arduino_GFX example
├── BatteryVoltage*             # Battery voltage reading example
├── RGBPanel                    # lvgl test example
├── TFT_eSPI_Sprite             # TFT_eSPI Sprite Example
├── Touchpad                    # Capacitive touch example
├── DeepSleep                   # Deep Sleep (Touch,Button,Timer)example
├── lv_helloworld               # lvgl get started
├── lv_benchmark                # lvgl benchmark  example
├── lv_factory                  # factory example
├── lv_gif                      # lvgl gif decoding example
├── lv_images                   # lvgl Picture decoding example
├── lv_music                    # lvgl music  example
├── lv_slider                   # lvgl slider  example
└── lv_qrcode                   # lvgl qrcode  example

• BatteryVoltage When USB is plugged in, the battery voltage cannot be read because the battery voltage is equal to the charging voltage at this time

3️⃣ PlatformIO Quick Start (Recommended)

1. Install Visual Studio Code and Python
2. Search for the PlatformIO plugin in the VisualStudioCode extension and install it.
3. After the installation is complete, you need to restart VisualStudioCode
4. After restarting VisualStudioCode, select File in the upper left corner of VisualStudioCode -> Open Folder -> select the LilyGo T-RGB directory
5. Wait for the installation of third-party dependent libraries to complete
6. Click on the platformio.ini file, and in the platformio column
7. Uncomment one of the lines src_dir = xxxx to make sure only one line works
8. Click the (✔) symbol in the lower left corner to compile
9. Connect the board to the computer USB
10. Click (→) to upload firmware
11. Click (plug symbol) to monitor serial output
12. If it cannot be written, or the USB device keeps flashing, please check the FAQ below

4️⃣ Install from Arduino Library Manager (recommended)

1. Install Arduino IDE

2. Install Arduino ESP32 V 2.0.5 or above and below V3.0

3. Sketch -> Include Library -> Manage Libraries

4. Library Search -> LilyGo T-RGB -> Install -> Install ALL

5. Library Search -> lvgl -> v8.4.0 -> Install

6. File -> Examples -> LilyGo T-RGB -> Any Examples

7. Tools , Make your selection according to the table below

   Arduino IDE Setting	Value
   Board	ESP32S3 Dev Module
   Port	Your port
   USB CDC On Boot	Enable
   CPU Frequency	240MHZ(WiFi)
   Core Debug Level	None
   USB DFU On Boot	Disable
   Erase All Flash Before Sketch Upload	Disable
   Events Run On	Core1
   Flash Mode	QIO 80MHZ
   Flash Size	16MB(128Mb)
   Arduino Runs On	Core1
   USB Firmware MSC On Boot	Disable
   Partition Scheme	16M Flash(3M APP/9.9MB FATFS)
   PSRAM	OPI PSRAM
   Upload Mode	UART0/Hardware CDC
   Upload Speed	921600
   USB Mode	CDC and JTAG

   • The options in bold are required, others are selected according to actual conditions.

8. Select Port ， select you board port

9. Click upload , Wait for compilation and writing to complete

10. If it cannot be written, or the USB device keeps flashing, please check the FAQ below

    Note that T-RGB depends on lvgl v8.4.0 version. Currently lvgl has released lvgl v9.0 version. When compilation error occurs, please check whether lvgl belongs to v8.4.0

5️⃣ Arduino IDE Manual installation

1. Install Arduino IDE
2. Install Arduino ESP32 V 2.0.5 or above and below V3.0
3. Download LilyGo T-RGB
4. Open ArduinoIDE ,Sketch -> Include Library -> Add .ZIP Library -> Select LilyGo T-RGB
5. Install dependent libraries
   • Sketch -> Include Library -> Manage Libraries -> Search for SensorLib, install version greater than v0.1.6
   • Sketch -> Include Library -> Manage Libraries -> Search for lvgl, install version v8.4.0
   • Sketch -> Include Library -> Manage Libraries -> Search for GFX Library for Arduino, install version v1.5.0
   • Sketch -> Include Library -> Manage Libraries -> Search for TFT_eSPI, install version v2.5.43
6. Open ArduinoIDE ,Tools , Make your selection based on the table above
7. File -> Examples -> LilyGo T-RGB -> Any Examples
8. Select Port， select you board port
9. Click upload , Wait for compilation and writing to complete
10. If it cannot be written, or the USB device keeps flashing, please check the FAQ below

6️⃣ ESP32 basic examples

• BLE Examples
• WiFi Examples
• SPIFFS Examples
• FFat Examples
• For more examples of esp32 chip functions, please refer to arduino-esp32-libraries

7️⃣ FAQ

1. The board uses USB as the JTAG upload port. When printing serial port information on USB_CDC_ON_BOOT configuration needs to be turned on. If the port cannot be found when uploading the program or the USB has been used for other functions, the port does not appear. 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, press RST
   3. Release the RST
   4. Release the BOOT button
   5. Upload sketch

2. If the above is invalid, burn the binary file to check whether the hardware is normal

3. If you use external power supply instead of USB-C, please turn off the CDC option. This is because the board will wait for USB access when it starts.

   • For Arduino IDE users, it can be turned off in the options , Please note that turning off USB CDC will turn off Serial redirection to USB-C. At this time, you will not see any Serial message output when opening the port from USB-C, but output from GPIO43 and GPIO44.

   Tools -> USB CDC On Boot -> Disable

   • For Platformio users, you can add the following compilation flags in the ini file

   build_flags =
       ; Enable -DARDUINO_USB_CDC_ON_BOOT will start printing and wait for terminal access during startup
       ; -DARDUINO_USB_CDC_ON_BOOT=1
   
       ; Enable -UARDUINO_USB_CDC_ON_BOOT will turn off printing and will not block when using the battery
       -UARDUINO_USB_CDC_ON_BOOT

4. When USB is plugged in, the battery voltage cannot be read because the battery voltage is equal to the charging voltage at this time

5. Regarding the esp-idf version example, the latest version is not ready, the previous test version can be found here

6. The Grove port has been set to I2C, sharing the bus with the touch and cannot be used for other purposes.

7. T-RGB has no free GPIO and cannot be expanded

8. T-RGB hardware connects to RGB666 screens, but ESP32 currently only supports RGB565

9. Serial.println has no output. Please refer to the third step of the FAQ to set USB CDC On Boot to Enable.

10. Which model of Grove interface cable should be used on T-RGB? Please see issue

8️⃣ Resource

• schematic
• Dimensions
• PCB 3D

T-RGB datasheet

• ST7701S Driver datasheet
• FT3267
• GT911
• ESP32S3-R8

8️⃣ Depends on required libraries

• SensorLib

• lvgl 8.4.0

• When using Arduino_GFX also depends on Arduino_GFX

• When using TFT_eSPI also depends on TFT_eSPI