|
6 | 6 |
|
7 | 7 | # ESP Display Panel
|
8 | 8 |
|
9 |
| -* [中文版本](./README_CN.md) |
| 9 | +* [中文版](./README_CN.md) |
10 | 10 |
|
11 |
| -ESP32_Display_Panel is a library designed specifically for ESP SoCs to drive display screens and enable rapid GUI development. Users can develop on multiple [internally supported development boards](#Development-Boards) directly or use simple adaptations for custom boards. Additionally, ESP32_Display_Panel supports various LCD and touch drivers, allowing users to develop with standalone drivers as needed. |
| 11 | +## Overview |
12 | 12 |
|
13 |
| -ESP32_Display_Panel integrates multiple display-related driver components from the [ESP Component Registry](https://components.espressif.com/). It can be obtained directly from the Espressif's server or downloaded from the Arduino IDE, enabling development with either the [Arduino](https://github.com/espressif/arduino-esp32) IDE or the [ESP-IDF](https://github.com/espressif/esp-idf) framework. |
| 13 | +ESP32_Display_Panel is a **display driver** and **GUI porting** library designed by Espressif specifically for ESP32 series SoCs (ESP32, ESP32-S3, ESP32-P4, etc.). It supports multiple development frameworks including [ESP-IDF](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html), [Arduino](https://docs.espressif.com/projects/arduino-esp32/en/latest/getting_started.html), and [Micropython](https://docs.micropython.org/en/v1.23.0/esp32/quickref.html). |
14 | 14 |
|
15 |
| -## Overview |
| 15 | +This library integrates most of Espressif's officially adapted [display-related components](https://components.espressif.com/components?q=esp_lcd), which can be used to drive displays (touch screens) with different interfaces and models. Additionally, the library provides common display features such as `backlight control` and `IO expander`, and integrates these features with `display` and `touch` functionality to form a complete display board driver solution. Developers can perform one-stop GUI application development based on [supported boards](#supported-boards) or `custom boards`. |
16 | 16 |
|
17 |
| -The functional block diagram of ESP32_Display_Panel is shown below and includes the following features: |
| 17 | +ESP32_Display_Panel's main features include: |
18 | 18 |
|
19 |
| -- Supports a variety of **Espressif** official and third-party development boards, including **M5Stack**, **Elecrow**, **Waveshare**,**VIEWE** and others. |
20 |
| -- Supports **custom development board** adaptation. |
21 |
| -- Supports a variety of device drivers, including interface **Bus**, **LCD**, **Touch**, **Backlight** and **IO Expander**. |
22 |
| -- Supports dynamic driver configuration, such as enabling debug logs. |
23 |
| -- Compatible with the **Arduino** IDE and **ESP-IDF** framework for compilation. |
| 19 | +- Support for various display-related drivers, including `interface bus`, `LCD`, `touch`, `backlight`, and `IO expander` |
| 20 | +- Support for multiple Espressif official and third-party display boards, including `M5Stack`, `Elecrow`, `Waveshare`, `VIEWE`, etc. |
| 21 | +- Support for custom board configuration |
| 22 | +- Support for flexible driver configuration and parameters |
| 23 | +- Support for `ESP-IDF`, `Arduino`, and `Micropython` development frameworks |
| 24 | + |
| 25 | +The functional block diagram is shown below: |
24 | 26 |
|
25 | 27 | <div align="center"><img src="docs/_static/block_diagram.png" alt ="Block Diagram" width="600"></div>
|
26 | 28 |
|
| 29 | +## Table of Contents |
| 30 | + |
| 31 | +- [ESP Display Panel](#esp-display-panel) |
| 32 | + - [Overview](#overview) |
| 33 | + - [Table of Contents](#table-of-contents) |
| 34 | + - [How to Use](#how-to-use) |
| 35 | + - [Supported Boards](#supported-boards) |
| 36 | + - [Supported Controllers](#supported-controllers) |
| 37 | + - [LCD Controllers](#lcd-controllers) |
| 38 | + - [Touch Controllers](#touch-controllers) |
| 39 | + - [FAQ](#faq) |
| 40 | + - [Arduino IDE](#arduino-ide) |
| 41 | + - [ESP-IDF](#esp-idf) |
| 42 | + |
27 | 43 | ## How to Use
|
28 | 44 |
|
29 |
| -Please refer to the documentation - [How to Use](./docs/How_To_Use.md). |
| 45 | +📖 Here are the usage guides for ESP32_Display_Panel in different development environments: |
| 46 | + |
| 47 | +* [ESP-IDF](./docs/envs/use_with_idf.md) |
| 48 | +* [Arduino IDE](./docs/envs/use_with_arduino.md) |
| 49 | + |
| 50 | +## Supported Boards |
30 | 51 |
|
31 |
| -## Supported Development Boards and Drivers |
| 52 | +📋 Here is the list of boards supported by ESP32_Display_Panel: |
32 | 53 |
|
33 |
| -### Development Boards |
| 54 | +| **Manufacturer** | **Model** | |
| 55 | +| --------------- | --------- | |
| 56 | +| [Espressif](./docs/board/board_espressif.md) | ESP32-C3-LCDkit, ESP32-S3-BOX, ESP32-S3-BOX-3, ESP32-S3-BOX-3B, ESP32-S3-BOX-3(beta), ESP32-S3-BOX-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG, ESP32-P4-Function-EV-Board | |
| 57 | +| [M5Stack](./docs/board/board_m5stack.md) | M5STACK-M5CORE2, M5STACK-M5DIAL, M5STACK-M5CORES3 | |
| 58 | +| [Elecrow](./docs/board/board_elecrow.md) | CrowPanel 7.0" | |
| 59 | +| [Jingcai](./docs/board/board_jingcai.md) | ESP32-4848S040C_I_Y_3 | |
| 60 | +| [Waveshare](./docs/board/board_waveshare.md) | ESP32-S3-Touch-LCD-1.85, ESP32-S3-Touch-LCD-2.1, ESP32-S3-Touch-LCD-4.3, ESP32-S3-Touch-LCD-4.3B, ESP32-S3-Touch-LCD-5, ESP32-S3-Touch-LCD-5B, ESP32-S3-Touch-LCD-7, ESP32-P4-NANO | |
| 61 | +| [VIEWE](./docs/board/board_viewe.md) | UEDX24320024E-WB-A, UEDX24320028E-WB-A, UEDX24320035E-WB-A, UEDX32480035E-WB-A, UEDX48270043E-WB-A, UEDX48480040E-WB-A, UEDX80480043E-WB-A, UEDX80480050E-WB-A, UEDX80480070E-WB-A | |
34 | 62 |
|
35 |
| -Below is the list of [Supported Development Boards](docs/Board_Instructions.md): |
| 63 | +📌 Click on the manufacturer name for detailed information. |
36 | 64 |
|
37 |
| -| **Manufacturer** | **Board Model** | |
38 |
| -| ---------------- | --------------- | |
39 |
| -| [Espressif](docs/Board_Instructions.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-BOX, ESP32-S3-BOX-3, ESP32-S3-BOX-3B, ESP32-S3-BOX-3(beta), ESP32-S3-BOX-Lite, ESP32-S3-EYE, ESP32-S3-Korvo-2, ESP32-S3-LCD-EV-Board, ESP32-S3-LCD-EV-Board-2, ESP32-S3-USB-OTG, ESP32-P4-Function-EV-Board | |
40 |
| -| [Elecrow](docs/Board_Instructions.md#elecrow) | CrowPanel 7.0" | |
41 |
| -| [M5Stack](docs/Board_Instructions.md#m5stack) | M5STACK-M5CORE2, M5STACK-M5DIAL, M5STACK-M5CORES3 | |
42 |
| -| [Jingcai](docs/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 | |
43 |
| -| [Waveshare](docs/Board_Instructions.md#waveshare) | ESP32-S3-Touch-LCD-1.85, ESP32-S3-Touch-LCD-2.1, ESP32-S3-Touch-LCD-4.3, ESP32-S3-Touch-LCD-4.3B, ESP32-S3-Touch-LCD-5, ESP32-S3-Touch-LCD-5B, ESP32-S3-Touch-LCD-7, ESP32-P4-NANO | |
44 |
| -| [VIEWE](docs/Board_Instructions.md#viewe) | UEDX24320028E-WB-A-2.4, UEDX24320028E-WB-A-2.8, UEDX24320028E-WB-A-3.5-240x320, UEDX24320028E-WB-A-3.5-320x480, DX48480040E-WB-A, UEDX80480043E-WB-A-4.3-800x480, UEDX80480043E-WB-A-4.3-480x272, UEDX80480050E-WB-A, UEDX80480070E-WB-A| |
| 65 | +💡 Developers and manufacturers are welcome to submit PRs to contribute support for more boards. |
45 | 66 |
|
46 |
| -Developers and manufacturers are welcome to contribute PRs to add more boards. For details, please refer to the [Board Contribution Guide](./docs/Board_Contribution_Guide.md). |
| 67 | +## Supported Controllers |
47 | 68 |
|
48 | 69 | ### LCD Controllers
|
49 | 70 |
|
50 |
| -Below is the list of [Supported LCD Controllers](docs/LCD_Controllers.md): |
| 71 | +📋 Here is the list of LCD controllers supported by ESP32_Display_Panel: |
51 | 72 |
|
52 | 73 | | **Manufacturer** | **Model** |
|
53 |
| -| ---------------- | --------- | |
| 74 | +| --------------- | --------- | |
54 | 75 | | Fitipower | EK9716B, EK79007 |
|
55 | 76 | | GalaxyCore | GC9A01, GC9B71, GC9503 |
|
56 | 77 | | Ilitek | ILI9341, ILI9881C |
|
57 | 78 | | JADARD | JD9365 |
|
58 | 79 | | NewVision | NV3022B |
|
59 | 80 | | Sitronix | ST7262, ST7701, ST7789, ST7796, ST77916, ST77922 |
|
60 | 81 |
|
| 82 | +📌 For detailed information, please refer to [Supported LCD Controllers](./docs/drivers/lcd.md). |
| 83 | + |
61 | 84 | ### Touch Controllers
|
62 | 85 |
|
63 |
| -Below is the list of [Supported Touch Controllers](docs/Touch_Controllers.md): |
| 86 | +📋 Here is the list of touch controllers supported by ESP32_Display_Panel: |
64 | 87 |
|
65 | 88 | | **Manufacturer** | **Model** |
|
66 |
| -| ---------------- | --------- | |
| 89 | +| --------------- | --------- | |
67 | 90 | | FocalTech | FT5x06 |
|
68 | 91 | | GOODiX | GT911, GT1151 |
|
69 | 92 | | Hynitron | CST816S |
|
70 | 93 | | Parade | TT21100 |
|
71 | 94 | | Sitronix | ST7123 |
|
72 | 95 | | Xptek | XPT2046 |
|
73 |
| -|Chipsemicorp | CHSC6540 | |
| 96 | +| Chipsemicorp | CHSC6540 | |
| 97 | + |
| 98 | +📌 For detailed information, please refer to [Supported Touch Controllers](./docs/drivers/touch.md). |
74 | 99 |
|
75 | 100 | ## FAQ
|
76 | 101 |
|
77 |
| -Please refer to the documentation - [FAQ](./docs/FAQ.md). |
| 102 | +🔍 Here are common issues in different development environments: |
| 103 | + |
| 104 | +### [Arduino IDE](./docs/envs/use_with_arduino.md#faq) |
| 105 | + |
| 106 | +* [Where is the Arduino library directory?](./docs/envs/use_with_arduino.md#where-is-the-arduino-library-directory) |
| 107 | +* [Where are the arduino-esp32 installation directory and SDK directory?](./docs/envs/use_with_arduino.md#where-are-the-arduino-esp32-installation-directory-and-sdk-directory) |
| 108 | +* [How to install ESP32_Display_Panel in Arduino IDE?](./docs/envs/use_with_arduino.md#how-to-install-esp32_display_panel-in-arduino-ide) |
| 109 | +* [How to select and configure supported boards in Arduino IDE?](./docs/envs/use_with_arduino.md#how-to-select-and-configure-supported-boards-in-arduino-ide) |
| 110 | +* [How to use SquareLine exported UI source files in Arduino IDE?](./docs/envs/use_with_arduino.md#how-to-use-squareline-exported-ui-source-files-in-arduino-ide) |
| 111 | +* [How to debug when the screen doesn't light up using the library in Arduino IDE?](./docs/envs/use_with_arduino.md#how-to-debug-when-the-screen-doesnt-light-up-using-the-library-in-arduino-ide) |
| 112 | +* [Can't see log messages or messages are incomplete in Arduino IDE's Serial Monitor, how to fix?](./docs/envs/use_with_arduino.md#can-t-see-log-messages-or-messages-are-incomplete-in-arduino-ides-serial-monitor-how-to-fix) |
| 113 | +* [Solution for screen drift issue when using ESP32-S3 to drive RGB LCD in Arduino IDE](./docs/envs/use_with_arduino.md#solution-for-screen-drift-issue-when-using-esp32-s3-to-drive-rgb-lcd-in-arduino-ide) |
| 114 | + |
| 115 | +### [ESP-IDF](./docs/envs/use_with_idf.md#faq) |
| 116 | + |
| 117 | +* [Solution for screen drift issue when using ESP32-S3 to drive RGB LCD in ESP-IDF](./docs/envs/use_with_idf.md#solution-for-screen-drift-issue-when-using-esp32-s3-to-drive-rgb-lcd-in-esp-idf) |
0 commit comments