feat: update

Author: Lzw655

.pre-commit-config.yaml

@@ -94,15 +94,15 @@ repos:
         name: Update when configuration files change
         entry: python3 tools/sync_conf_files.py ./
         language: system
-        files: '.*esp_panel_(board_custom|board_supported|drivers_conf)\.h'
+        files: '.*esp_panel_(board_custom|board_supported|drivers)_conf\.h'
 
   - repo: local
     hooks:
       - id: check-file-versions
         name: Update when versions change
         entry: python3 tools/check_file_version.py ./
         language: system
-        files: '(.*esp_panel_(board_custom|board_supported|drivers_conf)\.h|library.properties|.*esp_panel_versions.h)'
+        files: '(.*esp_panel_(board_custom|board_supported|drivers)_conf\.h|library.properties|.*esp_panel_versions.h)'
 
   - repo: local
     hooks:

docs/FAQ.md

@@ -44,7 +44,7 @@ When encountering screen drift issue when driving RGB LCD with ESP32-S3, you can
 
    - **Step 2**: If you are using supported development boards, usually there's no need to modify the code as they set `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` to `(ESP_PANEL_BOARD_WIDTH * 10)` by default. If the issue persists, refer to the example code below to increase the size of the `Bounce Buffer`.
 
-   - **Step 3**: If you are using a custom board, confirm in the `esp_panel_board_custom.h` file whether `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` is set to non-zero. If the issue persists, increase the size of the `Bounce Buffer`.
+   - **Step 3**: If you are using a custom board, confirm in the `esp_panel_board_custom_conf.h` file whether `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` is set to non-zero. If the issue persists, increase the size of the `Bounce Buffer`.
 
    - **Step 4**: If you are using an independent driver, refer to the example code below to set the size of the `Bounce Buffer`.
 
@@ -86,13 +86,13 @@ You can refer to the example [PlatformIO](../examples/PlatformIO/) to use the ES
 
 ## How to add an LVGL library and how to configure?
 * How to use it normally
-  
+
   1.Download the LVGL library in Arduino, it is best to choose the `V8.4.0` version.
-  
+
   2.Find the downloaded LVGL library, copy and paste the `lv_conf_template.h` file into the same directory as the LVGL library.
-  
+
   3.Change the `lv_conf_template.h` file name to `lv_conf.h`.
-  
+
   4.Open `lv_conf.h` to modify the macro definition and save: `#if 0`--> `#if 1`
   ```c
   ...
@@ -113,33 +113,33 @@ You can refer to the example [PlatformIO](../examples/PlatformIO/) to use the ES
   /*==================
   * EXAMPLES
   *==================*/
-  
+
   /*Enable the examples to be built with the library*/
   #define LV_BUILD_EXAMPLES 1
-  
+
   /*===================
    * DEMO USAGE
    ====================*/
-  
+
   /*Show some widget. It might be required to increase `LV_MEM_SIZE` */
   #define LV_USE_DEMO_WIDGETS 1
   #if LV_USE_DEMO_WIDGETS
   #define LV_DEMO_WIDGETS_SLIDESHOW 0
   #endif
-  
+
   /*Demonstrate the usage of encoder and keyboard*/
   #define LV_USE_DEMO_KEYPAD_AND_ENCODER 0
-  
+
   /*Benchmark your system*/
   #define LV_USE_DEMO_BENCHMARK 0
   #if LV_USE_DEMO_BENCHMARK
   /*Use RGB565A8 images with 16 bit color depth instead of ARGB8565*/
   #define LV_DEMO_BENCHMARK_RGB565A8 0
   #endif
-  
+
   /*Stress test for LVGL*/
   #define LV_USE_DEMO_STRESS 0
-  
+
   /*Music player demo*/
   #define LV_USE_DEMO_MUSIC 0
   #if LV_USE_DEMO_MUSIC

docs/FAQ_CN.md

@@ -43,7 +43,7 @@ arduino-esp32 v3.x.x 版本的 SDK 位于默认安装路径下的 `tools > esp32
 
    - **Step2**：如果您使用的是支持的开发板，则通常无需修改代码，因为它们默认设置了 `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` 为 `(ESP_PANEL_BOARD_WIDTH * 10)`。如果问题仍然存在，请参考下面的示例代码来增大 `Bounce Buffer` 的大小。
 
-   - **Step3**：如果您使用的是自定义的开发板，请在 `esp_panel_board_custom.h` 文件中确认 `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` 是否设置为非 0。如果问题仍然存在，请增大 `Bounce Buffer` 的大小。
+   - **Step3**：如果您使用的是自定义的开发板，请在 `esp_panel_board_custom_conf.h` 文件中确认 `ESP_PANEL_BOARD_LCD_RGB_BOUNCE_BUF_SIZE` 是否设置为非 0。如果问题仍然存在，请增大 `Bounce Buffer` 的大小。
 
    - **Step4**：如果您使用的是独立的驱动，请参考下面的示例代码来设置 `Bounce Buffer` 的大小。
 

docs/How_To_Use.md

@@ -78,7 +78,7 @@ Below are detailed instructions on how to configure ESP32_Display_Panel, mainly
 4. If multiple projects need to use the same configuration, users can place the configuration files in the [Arduino Library Directory](./FAQ.md#where-is-the-directory-for-arduino-libraries), so that all projects can share the same configuration.
 
 > [!WARNING]
-> * The same directory can simultaneously contain both `esp_panel_board_supported.h` and `esp_panel_board_custom.h` configuration files, but they cannot be enabled at the same time, meaning `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` and `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` can only have one set to `1`.
+> * The same directory can simultaneously contain both `esp_panel_board_supported_conf.h` and `esp_panel_board_custom_conf.h` configuration files, but they cannot be enabled at the same time, meaning `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` and `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` can only have one set to `1`.
 > * If neither of the above two configuration files is enabled, users cannot use the `ESP_Panel` driver and can only use other standalone device drivers, such as `ESP_PanelBus`, `ESP_PanelLcd`, etc.
 > * Since the configurations within these files might change, such as adding, deleting, or renaming, to ensure the compatibility of the program, the library manages the versions of these files independently and checks whether the configuration files currently used by the user are compatible with the library during compilation. Detailed version information and checking rules can be found at the end of the file.
 
@@ -95,12 +95,12 @@ ESP32_Display_Panel configures driver functionality and parameters based on the
 
 #### Using Supported Development Boards
 
-ESP32_Display_Panel configures `ESP_Panel` as the driver for the target development board based on the [esp_panel_board_supported.h](../esp_panel_board_supported.h) file. Users can select supported development boards by modifying macro definitions in this file. For example, to use the *ESP32-S3-BOX-3* development board, follow these steps:
+ESP32_Display_Panel configures `ESP_Panel` as the driver for the target development board based on the [esp_panel_board_supported_conf.h](../esp_panel_board_supported_conf.h) file. Users can select supported development boards by modifying macro definitions in this file. For example, to use the *ESP32-S3-BOX-3* development board, follow these steps:
 
-1. Set the `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` macro definition in the `esp_panel_board_supported.h` file to `1`.
+1. Set the `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` macro definition in the `esp_panel_board_supported_conf.h` file to `1`.
 2. Uncomment the corresponding macro definition for the target development board model.
 
-Here is a snippet of the modified `esp_panel_board_supported.h` file:
+Here is a snippet of the modified `esp_panel_board_supported_conf.h` file:
 
 ```c
 ...
@@ -109,19 +109,19 @@ Here is a snippet of the modified `esp_panel_board_supported.h` file:
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED
 ...
-// #define BOARD_ESP32_C3_LCDKIT
-// #define BOARD_ESP32_S3_BOX
-#define BOARD_ESP32_S3_BOX_3
-// #define BOARD_ESP32_S3_BOX_3_BETA
+// #define BOARD_ESPRESSIF_ESP32_C3_LCDKIT
+// #define BOARD_ESPRESSIF_ESP32_S3_BOX
+#define BOARD_ESPRESSIF_ESP32_S3_BOX_3
+// #define BOARD_ESPRESSIF_ESP32_S3_BOX_3_BETA
 ...
 #endif /* ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED */
 ```
 
 #### Using Custom Development Boards
 
-ESP32_Display_Panel configures `ESP_Panel` as the driver for custom development boards based on the [esp_panel_board_custom.h](../esp_panel_board_custom.h) file. Users need to modify this file according to the actual parameters of the custom development board. For example, to use a custom development board with a *480x480 RGB ST7701 LCD + I2C GT911 Touch*, follow these steps:
+ESP32_Display_Panel configures `ESP_Panel` as the driver for custom development boards based on the [esp_panel_board_custom_conf.h](../esp_panel_board_custom_conf.h) file. Users need to modify this file according to the actual parameters of the custom development board. For example, to use a custom development board with a *480x480 RGB ST7701 LCD + I2C GT911 Touch*, follow these steps:
 
-1. Set the `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` macro definition in the `esp_panel_board_custom.h` file to `1`.
+1. Set the `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` macro definition in the `esp_panel_board_custom_conf.h` file to `1`.
 2. Set the LCD-related macro definitions:
    a. Set `ESP_PANEL_BOARD_DEFAULT_USE_LCD` to `1`.
    b. Set `ESP_PANEL_BOARD_WIDTH` and `ESP_PANEL_BOARD_HEIGHT` to `480`.
@@ -135,7 +135,7 @@ ESP32_Display_Panel configures `ESP_Panel` as the driver for custom development
    c. Modify other Touch configurations as needed.
 4. Enable other driver macro definitions as needed, such as `ESP_PANEL_BOARD_DEFAULT_USE_BACKLIGHT`, `ESP_PANEL_BOARD_DEFAULT_USE_EXPANDER`, etc.
 
-Here is a snippet of the modified `esp_panel_board_custom.h` file:
+Here is a snippet of the modified `esp_panel_board_custom_conf.h` file:
 
 ```c
 ...

docs/How_To_Use_CN.md

@@ -78,7 +78,7 @@ idf.py add-dependency "espressif/esp32_display_panel"
 4. 如果有多个工程需要使用相同的配置，用户可以将配置文件放在 [Arduino 库目录](./FAQ_CN.md#arduino-库的目录在哪儿)中，这样所有的工程都可以共享相同的配置。
 
 > [!WARNING]
-> * 同一个目录下可以同时包含 `esp_panel_board_supported.h` 和 `esp_panel_board_custom.h` 两种配置文件，但是它们不能同时被使能，即 `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` 和 `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` 最多只能有一个为 `1`。
+> * 同一个目录下可以同时包含 `esp_panel_board_supported_conf.h` 和 `esp_panel_board_custom_conf.h` 两种配置文件，但是它们不能同时被使能，即 `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` 和 `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` 最多只能有一个为 `1`。
 > * 如果以上两个配置文件都被没有被使能，那么用户就无法使用 `ESP_Panel` 驱动，只能使用其他独立的设备驱动，如 `ESP_PanelBus`, `ESP_PanelLcd` 等。
 > * 由于这些文件内的配置可能会发生变化，比如新增、删除或重命名，为了保证程序的兼容性，库对它们分别进行了独立的版本管理，并在编译时检查用户当前使用的配置文件与库是否兼容。详细的版本信息以及检查规则可以在文件的末尾处找到。
 
@@ -95,12 +95,12 @@ ESP32_Display_Panel 会根据 [esp_panel_drivers_conf.h](../esp_panel_drivers_co
 
 #### 使用支持的开发板
 
-ESP32_Display_Panel 会根据 [esp_panel_board_supported.h](../esp_panel_board_supported.h) 文件来配置 `ESP_Panel` 成为目标开发板的驱动，用户可以通过修改此文件中的宏定义来选择支持的开发板。以使用 *ESP32-S3-BOX-3* 开发板为例，修改步骤如下：
+ESP32_Display_Panel 会根据 [esp_panel_board_supported_conf.h](../esp_panel_board_supported_conf.h) 文件来配置 `ESP_Panel` 成为目标开发板的驱动，用户可以通过修改此文件中的宏定义来选择支持的开发板。以使用 *ESP32-S3-BOX-3* 开发板为例，修改步骤如下：
 
-1. 设置 `esp_panel_board_supported.h` 文件中的 `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` 宏定义为 `1`。
+1. 设置 `esp_panel_board_supported_conf.h` 文件中的 `ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED` 宏定义为 `1`。
 2. 根据目标开发板的型号，取消对应的宏定义的注释。
 
-下面是修改后的 `esp_panel_board_supported.h` 文件的部分内容：
+下面是修改后的 `esp_panel_board_supported_conf.h` 文件的部分内容：
 
 ```c
 ...
@@ -109,19 +109,19 @@ ESP32_Display_Panel 会根据 [esp_panel_board_supported.h](../esp_panel_board_s
 
 #if ESP_PANEL_BOARD_DEFAULT_USE_SUPPORTED
 ...
-// #define BOARD_ESP32_C3_LCDKIT
-// #define BOARD_ESP32_S3_BOX
-#define BOARD_ESP32_S3_BOX_3
-// #define BOARD_ESP32_S3_BOX_3_BETA
+// #define BOARD_ESPRESSIF_ESP32_C3_LCDKIT
+// #define BOARD_ESPRESSIF_ESP32_S3_BOX
+#define BOARD_ESPRESSIF_ESP32_S3_BOX_3
+// #define BOARD_ESPRESSIF_ESP32_S3_BOX_3_BETA
 ...
 #endif
 ```
 
 #### 使用自定义开发板
 
-ESP32_Display_Panel 会根据 [esp_panel_board_custom.h](../esp_panel_board_custom.h) 文件来配置 `ESP_Panel` 成为自定义开发板的驱动，用户需要根据自定义开发板的实际参数对此文件进行修改。以使用 *480x480 RGB ST7701 LCD + I2C GT911 Touch* 的自定义开发板为例，修改步骤如下：
+ESP32_Display_Panel 会根据 [esp_panel_board_custom_conf.h](../esp_panel_board_custom_conf.h) 文件来配置 `ESP_Panel` 成为自定义开发板的驱动，用户需要根据自定义开发板的实际参数对此文件进行修改。以使用 *480x480 RGB ST7701 LCD + I2C GT911 Touch* 的自定义开发板为例，修改步骤如下：
 
-1. 设置 `esp_panel_board_custom.h` 文件中的 `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` 宏定义为 `1`。
+1. 设置 `esp_panel_board_custom_conf.h` 文件中的 `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` 宏定义为 `1`。
 2. 设置 LCD 相关宏定义：
   a. 设置 `ESP_PANEL_BOARD_DEFAULT_USE_LCD` 为 `1`
   b. 设置 `ESP_PANEL_BOARD_WIDTH` 和 `ESP_PANEL_BOARD_HEIGHT` 为 `480`
@@ -135,7 +135,7 @@ ESP32_Display_Panel 会根据 [esp_panel_board_custom.h](../esp_panel_board_cust
   c. 根据需要修改其他 Touch 配置
 3. 根据需要使能其他驱动的宏定义，如 `ESP_PANEL_BOARD_DEFAULT_USE_BACKLIGHT`, `ESP_PANEL_BOARD_DEFAULT_USE_EXPANDER` 等。
 
-下面是修改后的 `esp_panel_board_custom.h` 文件的部分内容：
+下面是修改后的 `esp_panel_board_custom_conf.h` 文件的部分内容：
 
 ```c
 ...

esp_panel_board_custom.h renamed to esp_panel_board_custom_conf.h

@@ -4,7 +4,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 /**
- * @file   esp_panel_board_custom.h
+ * @file   esp_panel_board_custom_conf.h
  * @brief  Configuration file for custom ESP development boards
  * @author
  * @link
@@ -347,6 +347,7 @@
  *
  * Supported controllers:
  * - `AXS15231B`
+ * - `CHSC6540`
  * - `CST816S`
  * - `FT5x06`
  * - `GT911`, `GT1151`
@@ -566,7 +567,7 @@
 /*
 #define ESP_PANEL_BOARD_PRE_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -580,7 +581,7 @@
 /*
 #define ESP_PANEL_BOARD_POST_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -594,7 +595,7 @@
 /*
 #define ESP_PANEL_BOARD_PRE_DEL_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -608,7 +609,7 @@
 /*
 #define ESP_PANEL_BOARD_POST_DEL_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -622,7 +623,7 @@
 /*
 #define ESP_PANEL_BOARD_EXPANDER_PRE_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -636,7 +637,7 @@
 /*
 #define ESP_PANEL_BOARD_EXPANDER_POST_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -650,7 +651,7 @@
 /*
 #define ESP_PANEL_BOARD_LCD_PRE_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -664,7 +665,7 @@
 /*
 #define ESP_PANEL_BOARD_LCD_POST_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -678,7 +679,7 @@
 /*
 #define ESP_PANEL_BOARD_TOUCH_PRE_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -692,7 +693,7 @@
 /*
 #define ESP_PANEL_BOARD_TOUCH_POST_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -706,7 +707,7 @@
 /*
 #define ESP_PANEL_BOARD_BACKLIGHT_PRE_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */
@@ -720,7 +721,7 @@
 /*
 #define ESP_PANEL_BOARD_BACKLIGHT_POST_BEGIN_FUNCTION(p) \
     {  \
-        auto board = static_cast<esp_panel::Board *>(p);  \
+        auto board = static_cast<Board *>(p);  \
         return true;    \
     }
 */