Skip to content

Commit b1fb5bc

Browse files
Lzw655Lzw655
authored
feat(example): add support for PlatformIO (#42)
Closes #37
2 parents 8131565 + f117509 commit b1fb5bc

14 files changed

+1603
-23
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
* feat(board): add add new board M5CORE2 by @MacChu0315-Espressif (#40)
88
* feat(board): add add new board M5DIAL by @MacChu0315-Espressif (#41)
99
* feat(board): add add new board M5CORES3 by @MacChu0315-Espressif (#45)
10+
* feat(example): add support for PlatformIO by @isthaison (#37)
1011

1112
### Bugfixes:
1213

‎README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@ ESP32_Display_Panel encapsulates various components from the [Espressif Componen
2424
- [Using Supported Development Boards](#using-supported-development-boards)
2525
- [Using Custom Development Boards](#using-custom-development-boards)
2626
- [Usage Examples](#usage-examples)
27-
- [LCD](#lcd)
28-
- [Touch](#touch)
29-
- [Panel](#panel)
30-
- [LVGL v8](#lvgl-v8)
31-
- [SquareLine](#squareline)
27+
- [Arduino IDE](#arduino-ide)
28+
- [LCD](#lcd)
29+
- [Touch](#touch)
30+
- [Panel](#panel)
31+
- [LVGL v8](#lvgl-v8)
32+
- [SquareLine](#squareline)
33+
- [PlatformIO](#platformio)
3234
- [Other Relevant Instructions](#other-relevant-instructions)
3335
- [Configuring Supported Development Boards](#configuring-supported-development-boards)
3436
- [Configuring LVGL](#configuring-lvgl)
@@ -38,6 +40,7 @@ ESP32_Display_Panel encapsulates various components from the [Espressif Componen
3840
- [How to Install ESP32\_Display\_Panel in Arduino IDE?](#how-to-install-esp32_display_panel-in-arduino-ide)
3941
- [Where are the installation directory for arduino-esp32 and the SDK located?](#where-are-the-installation-directory-for-arduino-esp32-and-the-sdk-located)
4042
- [How to fix screen drift issue when driving RGB LCD with ESP32-S3?](#how-to-fix-screen-drift-issue-when-driving-rgb-lcd-with-esp32-s3)
43+
- [How to Use ESP32\_Display\_Panel on PlatformIO?](#how-to-use-esp32_display_panel-on-platformio)
4144

4245
## Overview
4346

@@ -256,9 +259,13 @@ Here is a snippet of the modified `ESP_Panel_Board_Custom.h` file:
256259

257260
### Usage Examples
258261

259-
Below are some examples of using ESP32_Display_Panel. You can access them in the Arduino IDE by navigating to `File` > `Examples` > `ESP32_Display_Panel`. If you cannot find the `ESP32_Display_Panel` option, please check if the library has been installed correctly and ensure that an ESP development board is selected.
262+
The following are some examples of using ESP32_Display_Panel on different development platforms.
260263

261-
#### LCD
264+
#### Arduino IDE
265+
266+
You can access them in the Arduino IDE by navigating to `File` > `Examples` > `ESP32_Display_Panel`. If you cannot find the `ESP32_Display_Panel` option, please check if the library has been installed correctly and ensure that an ESP development board is selected.
267+
268+
##### LCD
262269

263270
The following examples demonstrate how to develop different interface and model LCDs using standalone drivers and test them by displaying color bars:
264271

@@ -267,33 +274,37 @@ The following examples demonstrate how to develop different interface and model
267274
* [Single RGB](examples/LCD/RGB/)
268275
* [3-wire SPI + RGB](examples/LCD/3wireSPI_RGB/)
269276

270-
#### Touch
277+
##### Touch
271278

272279
The following example demonstrates how to develop touch screens of different interfaces and models using standalone drivers and test them by printing touch point coordinates:
273280

274281
* [I2C](examples/Touch/I2C/)
275282
* [SPI](examples/Touch/SPI/)
276283

277-
#### Panel
284+
##### Panel
278285

279286
The following example demonstrates how to develop built-in or custom development boards using the `ESP_Panel` driver:
280287

281288
* [Panel Test](examples/Panel/PanelTest/): This example tests by displaying color bars and printing touch point coordinates.
282289

283-
#### LVGL v8
290+
##### LVGL v8
284291

285292
For configuring LVGL (v8.3.x), please refer to [here](#configuring-lvgl) for more detailed information.
286293

287294
* [Porting](examples/LVGL/v8/Porting/): This example demonstrates how to port LVGL (v8.3.x). And for RGB LCD, it can enable the avoid tearing fucntion.
288295
* [Rotation](examples/LVGL/v8/Rotation/): This example demonstrates how to use LVGL to rotate the display.
289296

290-
#### SquareLine
297+
##### SquareLine
291298

292299
To port the SquareLine project (v1.3.x), please refer to [here](#porting-squareline-project) for more detailed information.
293300

294301
- [Porting](examples/SquareLine/v8/Porting/): This example demonstrates how to port the SquareLine project.
295302
- [WiFiClock](examples/SquareLine/v8/WiFiClock/): This example implements a simple Wi-Fi clock and can display weather information.
296303

304+
#### PlatformIO
305+
306+
- [PlatformIO](examples/PlatformIO/): This example demonstrates how to use ESP32_Display_Panel in PlatformIO. By default, it is suitable for the **ESP32-S3-LCD-EV-Board** and **ESP32-S3-LCD-EV-Board-2** development boards. Users need to modify the [boards/ESP-LCD.json](examples/PlatformIO/boards/ESP-LCD.json) file according to the actual situation.
307+
297308
## Other Relevant Instructions
298309

299310
### Configuring Supported Development Boards
@@ -446,3 +457,7 @@ When encountering screen drift issue when driving RGB LCD with ESP32-S3, you can
446457
lcd_bus->begin();
447458
...
448459
```
460+
461+
### How to Use ESP32_Display_Panel on PlatformIO?
462+
463+
You can refer to the example [PlatformIO](examples/PlatformIO/) to use the ESP32_Display_Panel library in PlatformIO. By default, it is suitable for the **ESP32-S3-LCD-EV-Board** and **ESP32-S3-LCD-EV-Board-2** development boards. You need to modify the [boards/ESP-LCD.json](examples/PlatformIO/boards/ESP-LCD.json) file according to the actual situation.

‎README_CN.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,13 @@ ESP32_Display_Panel 封装了多种[乐鑫组件库](https://components.espressi
2424
- [使用支持的开发板](#使用支持的开发板)
2525
- [使用自定义开发板](#使用自定义开发板)
2626
- [示例说明](#示例说明)
27-
- [LCD](#lcd)
28-
- [Touch](#touch)
29-
- [Panel](#panel)
30-
- [LVGL v8](#lvgl-v8)
31-
- [SquareLine](#squareline)
27+
- [Arduino IDE](#arduino-ide)
28+
- [LCD](#lcd)
29+
- [Touch](#touch)
30+
- [Panel](#panel)
31+
- [LVGL v8](#lvgl-v8)
32+
- [SquareLine](#squareline)
33+
- [PlatformIO](#platformio)
3234
- [其他相关说明](#其他相关说明)
3335
- [配置支持的开发板](#配置支持的开发板)
3436
- [配置 LVGL](#配置-lvgl)
@@ -38,6 +40,7 @@ ESP32_Display_Panel 封装了多种[乐鑫组件库](https://components.espressi
3840
- [如何在 Arduino IDE 中安装 ESP32\_Display\_Panel？](#如何在-arduino-ide-中安装-esp32_display_panel)
3941
- [arduino-eps32 的安装目录以及 SDK 的目录在哪儿？](#arduino-eps32-的安装目录以及-sdk-的目录在哪儿)
4042
- [使用 ESP32-S3 驱动 RGB LCD 时出现画面漂移问题的解决方案](#使用-esp32-s3-驱动-rgb-lcd-时出现画面漂移问题的解决方案)
43+
- [如何在 PlatformIO 上使用 ESP32\_Display\_Panel？](#如何在-platformio-上使用-esp32_display_panel)
4144

4245
## 概述
4346

@@ -256,9 +259,13 @@ ESP32_Display_Panel 会根据 [ESP_Panel_Board_Custom.h](./ESP_Panel_Board_Custo
256259

257260
### 示例说明
258261

259-
以下是使用 ESP32_Display_Panel 的一些示例，你可以在 Arduino IDE 中导航到 `File` > `Examples` > `ESP32_Display_Panel` 来访问它们。如果你找不到 `ESP32_Display_Panel` 选项，请检查库是否已正确安装，并确认选择了一个 ESP 开发板。
262+
以下是在不同开发平台下使用 ESP32_Display_Panel 的一些示例。
260263

261-
#### LCD
264+
#### Arduino IDE
265+
266+
你可以在 Arduino IDE 中导航到 `File` > `Examples` > `ESP32_Display_Panel` 来访问它们。如果你找不到 `ESP32_Display_Panel` 选项，请检查库是否已正确安装，并确认选择了一个 ESP 开发板。
267+
268+
##### LCD
262269

263270
以下示例演示了如何使用独立的驱动开发不同接口和不同型号的 LCD，并通过显示彩条进行测试：
264271

@@ -267,33 +274,37 @@ ESP32_Display_Panel 会根据 [ESP_Panel_Board_Custom.h](./ESP_Panel_Board_Custo
267274
* [Single RGB](examples/LCD/RGB/)
268275
* [3-wire SPI + RGB](examples/LCD/3wireSPI_RGB/)
269276

270-
#### Touch
277+
##### Touch
271278

272279
以下示例演示了如何使用独立的驱动开发不同接口和不同型号的触摸屏，并通过打印触摸点坐标进行测试：
273280

274281
* [I2C](examples/Touch/I2C/)
275282
* [SPI](examples/Touch/SPI/)
276283

277-
#### Panel
284+
##### Panel
278285

279286
以下示例演示了如何使用 `ESP_Panel` 驱动开发内置或自定义的开发板：
280287

281288
* [Panel Test](examples/Panel/PanelTest/)：此示例通过显示彩条和打印触摸点坐标进行测试。
282289

283-
#### LVGL v8
290+
##### LVGL v8
284291

285292
关于如何配置 LVGL（v8.3.x），请参阅[此处](#配置-lvgl)以获取更多详细信息。
286293

287294
* [Porting](examples/LVGL/v8/Porting/): 此示例演示了如何移植 LVGL（v8.3.x）。对于 RGB LCD，它还可以启用防撕裂功能。
288295
* [Rotation](examples/LVGL/v8/Rotation/): 此示例演示了如何使用 LVGL 来旋转显示屏。
289296

290-
#### SquareLine
297+
##### SquareLine
291298

292299
​ 要移植 Squarelina 项目（v1.3.x），请参阅[此处](#移植-SquareLine-工程)获取更多详细信息。
293300

294301
- [Porting](examples/SquareLine/v8/Porting): 此示例演示了如何移植 SquareLine 项目。
295302
- [WiFiClock](examples/SquareLine/v8/WiFiClock): 此示例实现了一个简单的 Wi-Fi 时钟，并且可以显示天气信息。
296303

304+
#### PlatformIO
305+
306+
- [PlatformIO](examples/PlatformIO/): 此示例演示了如何在 PlatformIO 中使用 ESP32_Display_Panel。它默认情况下适用于 **ESP32-S3-LCD-EV-Board** and **ESP32-S3-LCD-EV-Board-2** 开发板，用户需要根据实际情况修改 [boards/ESP-LCD.json](examples/PlatformIO/boards/ESP-LCD.json) 文件。
307+
297308
## 其他相关说明
298309

299310
### 配置支持的开发板
@@ -446,3 +457,7 @@ arduino-esp32 v3.x.x 版本的 SDK 位于默认安装路径下的 `tools > esp32
446457
lcd_bus->begin();
447458
...
448459
```
460+
461+
### 如何在 PlatformIO 上使用 ESP32_Display_Panel？
462+
463+
您可以参考示例 [PlatformIO](examples/PlatformIO/) 在 PlatformIO 中使用 ESP32_Display_Panel 库，它默认情况下适用于 **ESP32-S3-LCD-EV-Board** and **ESP32-S3-LCD-EV-Board-2** 开发板，您需要根据实际情况修改 [boards/ESP-LCD.json](examples/PlatformIO/boards/ESP-LCD.json) 文件。

‎examples/PlatformIO/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.pio
2+
.vscode/.browse.c_cpp.db*
3+
.vscode/c_cpp_properties.json
4+
.vscode/launch.json
5+
.vscode/ipch

‎examples/PlatformIO/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# PlatformIO Example
2+
3+
The example is used to guide how to use this library in PlatformIO. It also demonstrates how to port LVGL (v8.3.x). And for RGB LCD, it can enable the avoid tearing fucntion.
4+
5+
It is by default suitable for **ESP32-S3-LCD-EV-Board** and **ESP32-S3-LCD-EV-Board-2** boards. Users should modify the [boards/ESP-LCD.json](boards/ESP-LCD.json) file as needed.
6+
7+
## How to Use
8+
9+
Follow the steps below to configure:
10+
11+
1. For **ESP32_Display_Panel**:
12+
13+
- Follow the [steps](../../README.md#configuring-drivers) to configure drivers if needed.
14+
- If using a supported development board, follow the [steps](../../README.md#using-supported-development-boards) to configure it.
15+
- If using a custom board, follow the [steps](../../README.md#using-custom-development-boards) to configure it.
16+
17+
2. For **lvgl**:
18+
19+
- Follow the [steps](../../README.md#configuring-lvgl) to add *lv_conf.h* file and change the configurations.
20+
- Modify the macros in the [lvgl_port_v8.h](./lvgl_port_v8.h) file to configure the LVGL porting parameters.
21+
22+
3. Navigate to the `Tools` menu in the Arduino IDE to choose a ESP board and configure its parameters. For supported boards, please refter to [Configuring Supported Development Boards](../../README.md#configuring-supported-development-boards)
23+
4. Verify and upload the example to your ESP board.
24+
25+
## Serial Output
26+
27+
```bash
28+
...
29+
LVGL porting example start
30+
Initialize panel device
31+
Initialize LVGL
32+
Create UI
33+
LVGL porting example end
34+
IDLE loop
35+
IDLE loop
36+
...
37+
```
38+
39+
## Troubleshooting
40+
41+
Please check the [FAQ](../../README.md#faq) first to see if the same question exists. If not, please create a [Github issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues). We will get back to you as soon as possible.

‎examples/PlatformIO/boards/ESP-LCD.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"build": {
3+
"arduino": {
4+
"ldscript": "esp32s3_out.ld",
5+
"partitions": "default_16MB.csv",
6+
"memory_type": "qio_opi"
7+
},
8+
"core": "esp32",
9+
"extra_flags": [
10+
"-DBOARD_HAS_PSRAM",
11+
"-DARDUINO_USB_MODE=1",
12+
"-DARDUINO_RUNNING_CORE=1",
13+
"-DARDUINO_EVENT_RUNNING_CORE=1"
14+
],
15+
"f_cpu": "240000000L",
16+
"f_flash": "80000000L",
17+
"flash_mode": "qio",
18+
"hwids": [["0x303A", "0x1001"]],
19+
"mcu": "esp32s3",
20+
"variant": "esp32s3"
21+
},
22+
"connectivity": ["wifi"],
23+
"debug": {
24+
"default_tool": "esp-builtin",
25+
"onboard_tools": ["esp-builtin"],
26+
"openocd_target": "esp32s3.cfg"
27+
},
28+
"frameworks": ["arduino", "espidf"],
29+
"name": "ESP-LCD (16M QIO Flash & OPI PSRAM)",
30+
"upload": {
31+
"flash_size": "16MB",
32+
"maximum_ram_size": 327680,
33+
"maximum_size": 16777216,
34+
"require_upload_port": true,
35+
"speed": 921600
36+
},
37+
"url": "https://www.espressif.com",
38+
"vendor": "ESP-LCD"
39+
}

‎examples/PlatformIO/platformio.ini

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[env:ESP-LCD]
2+
platform = espressif32
3+
board = ESP-LCD
4+
framework = arduino
5+
platform_packages =
6+
platformio/framework-arduinoespressif32@https://github.com/espressif/arduino-esp32.git
7+
platformio/framework-arduinoespressif32-libs@https://github.com/espressif/esp32-arduino-libs.git#idf-release/v5.1
8+
upload_speed = 921600
9+
monitor_speed = 115200
10+
build_flags =
11+
-DBOARD_HAS_PSRAM
12+
-DLV_CONF_INCLUDE_SIMPLE
13+
-DDISABLE_ALL_LIBRARY_WARNINGS
14+
-DARDUINO_USB_CDC_ON_BOOT=1
15+
-DCORE_DEBUG_LEVEL=1
16+
-DLV_LVGL_H_INCLUDE_SIMPLE
17+
-I src
18+
lib_deps =
19+
https://github.com/esp-arduino-libs/ESP32_Display_Panel.git
20+
https://github.com/esp-arduino-libs/ESP32_IO_Expander.git
21+
https://github.com/lvgl/lvgl.git#release/v8.3
22+

0 commit comments

Comments
 (0)