Skip to content

Commit eb06630

Browse files
martinrogerLzw655
authored andcommitted
feat(docs): udpate Chinese version
1 parent c2e9942 commit eb06630

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# ChangeLog
22

3+
## v1.0.4 - 2025-07-13
4+
5+
### Enhancements:
6+
7+
* feat(board): add support for Waveshare ESP32-S3 Touch LCD 2.8C @martinroger (#226)
8+
* feat(docs): document usage of `esp_panel_board_custom_conf.h` with ESP-IDF @martinroger (#226)
9+
310
## v1.0.3 - 2025-07-07
411

512
### Enhancements:

README_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ ESP32_Display_Panel 的主要特性如下:
5757
| [M5Stack](./docs/board/board_m5stack.md) | M5STACK-M5CORE2、M5STACK-M5DIAL、M5STACK-M5CORES3 |
5858
| [Elecrow](./docs/board/board_elecrow.md) | CrowPanel 7.0" |
5959
| [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 |
60+
| [Waveshare](./docs/board/board_waveshare.md) | ESP32-S3-Touch-LCD-1.85、ESP32-S3-Touch-LCD-2.1、ESP32-S3-Touch-LCD-2.8C、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 |
6161
| [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 |
6262

6363
📌 详细说明请点击制造商名称查看。

docs/envs/use_with_idf_cn.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
- [SDK 及依赖组件](#sdk-及依赖组件)
1010
- [添加到工程](#添加到工程)
1111
- [配置说明](#配置说明)
12+
- [在 ESP-IDF 中使用 `esp_panel_board_custom_conf.h`](#在-esp-idf-中使用-esp_panel_board_custom_confh)
1213
- [示例说明](#示例说明)
1314
- [常见问题及解答](#常见问题及解答)
1415
- [在 ESP-IDF 中使用 ESP32-S3 驱动 RGB LCD 时出现画面漂移问题的解决方案](#在-esp-idf-中使用-esp32-s3-驱动-rgb-lcd-时出现画面漂移问题的解决方案)
@@ -71,6 +72,36 @@ ESP32_Display_Panel 已上传到 [Espressif 组件库](https://components.espres
7172
> * 运行 `idf.py save-defconfig` 即可保存当前工程的 `menuconfig` 配置,并在工程目录下生成 *sdkconfig.defaults* 默认配置文件。
7273
> * 如果想要舍弃当前工程 menuconfig 配置并加载默认配置,请先删除工程目录下的 *sdkconfig* 文件,然后再运行 `idf.py reconfigure` 即可。
7374

75+
## 在 ESP-IDF 中使用 `esp_panel_board_custom_conf.h`
76+
77+
有时我们希望不通过 `menuconfig` 配置自定义开发板,而是直接使用 `esp_panel_board_custom_conf.h` 文件。例如,这样可以方便地定义一些宏,在各个板级组件初始化步骤之间执行,或者便于调试和尝试高级厂商命令。
78+
79+
由于 ESP-IDF 的组件化设计,不能像 Arduino 或 PlatformIO 那样,直接把配置文件放在 `main` 目录下并在主程序中包含即可生效。
80+
81+
需要按照如下步骤操作:
82+
83+
1. 运行 `idf.py menuconfig`,确保 *Enable to skip `esp_panel_board_*.h`* 选项**未勾选**。如果没有看到该选项,请先确保已经将本库作为组件添加到工程中!
84+
2. 将你的 `esp_panel_board_custom_conf.h` 文件复制到**工程目录下的某个文件夹**。本例假设你已正确配置好该文件,并将其放在 `/main/conf/` 目录下,结构如下:
85+
```
86+
工程目录 - |
87+
| - CMakeLists.txt
88+
| - main - |
89+
| | - main.c
90+
| | - conf - |
91+
| | | - esp_panel_board_custom_conf.h
92+
| | | ...
93+
| | ...
94+
| ...
95+
```
96+
3. 编辑 **项目** `CMakeLists.txt`,在 `project` 指令之前添加以下行:
97+
```
98+
...
99+
include_directories(${CMAKE_CURRENT_LIST_DIR}/main/conf)
100+
project(...
101+
```
102+
103+
这样,宏会在编译之前加载,使用方法与在 PlatformIO 或 Arduino 框架中类似。
104+
74105
## 示例说明
75106
76107
* [lvgl_v8_port](../../examples/esp_idf/lvgl_v8_port/): 该示例演示了如何移植 `LVGL v8`,并且运行了 LVGL 的内部 Demos,包括 `Music Player`、`Widgets`、`Stress` 和 `Benchmark`。

0 commit comments

Comments
 (0)