Merge branch 'bugfix/compile_error_with_spi_touch' into 'master'

Closes #170

See merge request ae_group/ESP32_Display_Panel!12

Author: Lzw655

CHANGELOG.md

@@ -1,11 +1,17 @@
 # ChangeLog
 
-## v1.0.1 - 2025-02-19
+## v1.0.1 - 2025-03-13
+
+### Enhancements:
+
+* feat(docs): add new FAQs
 
 ### Bugfixes:
 
 * fix(touch): avoid reading the button state when disabled (#162)
 * fix(docs): correct and add descriptions
+* fix(board): resolve compilation error for SPI touch screens @tilordleo (#169)
+* fix(conf): correct comments in `esp_panel_board_custom_conf.h`
 
 ## v1.0.0 - 2025-02-17
 

README.md

@@ -124,3 +124,7 @@ The functional block diagram is shown below:
   * [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)
   * [How to reduce Flash usage and speed up compilation when using ESP32_Display_Panel in ESP-IDF?](./docs/envs/use_with_idf.md#how-to-reduce-flash-usage-and-speed-up-compilation-when-using-esp32_display_panel-in-esp-idf)
   * [Other LCD issues in ESP-IDF](./docs/envs/use_with_idf.md#other-lcd-issues-in-esp-idf)
+
+* [Other FAQs](./docs/faq_others.md)
+
+  * [Can't find drivers for the same model of LCD/Touch device?](./docs/faq_others.md#can-t-find-drivers-for-the-same-model-of-lcd/touch-device)

README_CN.md

@@ -124,3 +124,7 @@ ESP32_Display_Panel 的主要特性如下：
   * [在 ESP-IDF 中使用 ESP32-S3 驱动 RGB LCD 时出现画面漂移问题的解决方案](./docs/envs/use_with_idf_cn.md#在-esp-idf-中使用-esp32-s3-驱动-rgb-lcd-时出现画面漂移问题的解决方案)
   * [在 ESP-IDF 中使用 ESP32_Display_Panel 时，如何降低其 Flash 占用及加快编译速度？](./docs/envs/use_with_idf_cn.md#在-esp-idf-中使用-esp32_display_panel-时如何降低其-flash-占用及加快编译速度)
   * [在 ESP-IDF 中驱动 LCD 遇到其他问题](./docs/envs/use_with_idf_cn.md#在-esp-idf-中驱动-lcd-遇到其他问题)
+
+* [其他问题](./docs/faq_others_cn.md)
+
+  * [找不到相同型号的 LCD/Touch 设备驱动？](./docs/faq_others_cn.md#找不到相同型号的-lcd/touch-设备驱动)

docs/envs/use_with_arduino.md

@@ -35,6 +35,7 @@
     - [Can't see log messages or messages are incomplete in Arduino IDE's Serial Monitor, how to fix?](#cant-see-log-messages-or-messages-are-incomplete-in-arduino-ides-serial-monitor-how-to-fix)
     - [Solution for screen drift issue when using ESP32-S3 to drive RGB LCD in Arduino IDE](#solution-for-screen-drift-issue-when-using-esp32-s3-to-drive-rgb-lcd-in-arduino-ide)
     - [How to reduce Flash usage and speed up compilation when using ESP32\_Display\_Panel in Arduino IDE?](#how-to-reduce-flash-usage-and-speed-up-compilation-when-using-esp32_display_panel-in-arduino-ide)
+    - [How to avoid I2C re-initialization when using ESP32\_Display\_Panel in Arduino IDE (e.g., when using Wire library)?](#how-to-avoid-i2c-re-initialization-when-using-esp32_display_panel-in-arduino-ide-eg-when-using-wire-library)
 
 ## Quick Start
 
@@ -617,3 +618,44 @@ Please follow these steps:
     ```
 
 - For detailed configuration, please refer to [Configuring esp-lib-utils](#configuring-esp-lib-utils)
+
+### How to avoid I2C re-initialization when using ESP32_Display_Panel in Arduino IDE (e.g., when using Wire library)?
+
+If you need to use ESP32_Display_Panel's I2C bus functionality, such as `I2C IO_Expander` or `I2C Touch` drivers, while your project is already using the `Wire` library, errors may occur due to I2C bus re-initialization. To avoid this, initialize `Wire` before creating the `Board` object, then follow these steps to configure ESP32_Display_Panel to skip I2C initialization:
+
+1. By modifying the *esp_panel_board_custom_conf.h* configuration file (only applicable for [custom boards](#loading-of-custom-boards)):
+
+- For `I2C Touch` driver:
+
+    ```c
+    ...
+    #define ESP_PANEL_BOARD_LCD_BUS_SKIP_INIT_HOST    (1)     // 0/1
+    ...
+    ```
+
+- For `I2C IO_Expander` driver:
+
+    ```c
+    ...
+    #define ESP_PANEL_BOARD_EXPANDER_SKIP_INIT_HOST     (1)     // 0/1
+    ...
+    ```
+
+2. By using code (applicable for both [supported boards](#loading-of-supported-boards) and [custom boards](#loading-of-custom-boards)):
+
+    ```c
+    ...
+    esp_panel::board::Board *board = new esp_panel::board::Board();
+    board->init();
+    ...
+    /**
+     * Should be called after `board->init()` and before `board->begin()`
+     */
+    // For I2C Touch
+    static_cast<esp_panel::drivers::BusI2C *>(board->getTouch()->getBus())->configI2C_HostSkipInit();
+    // For I2C IO_Expander
+    board->getIO_Expander()->skipInitHost();
+    ...
+    board->begin();
+    ...
+    ```

docs/envs/use_with_arduino_cn.md

@@ -35,6 +35,7 @@
     - [在 Arduino IDE 中打开串口调试器看不到日志信息或日志信息显示不全，如何解决？](#在-arduino-ide-中打开串口调试器看不到日志信息或日志信息显示不全如何解决)
     - [在 Arduino IDE 中使用 ESP32-S3 驱动 RGB LCD 时出现画面漂移问题的解决方案](#在-arduino-ide-中使用-esp32-s3-驱动-rgb-lcd-时出现画面漂移问题的解决方案)
     - [在 Arduino IDE 中使用 ESP32\_Display\_Panel 时，如何降低其 Flash 占用及加快编译速度？](#在-arduino-ide-中使用-esp32_display_panel-时如何降低其-flash-占用及加快编译速度)
+    - [在 Arduino IDE 中使用 ESP32\_Display\_Panel 时，如何避免 I2C 重复初始化（如使用 Wire 库）？](#在-arduino-ide-中使用-esp32_display_panel-时如何避免-i2c-重复初始化如使用-wire-库)
 
 ## 快速入门
 
@@ -617,3 +618,44 @@ arduino-esp32 v3.x 版本的 SDK 位于默认安装路径下的 `tools > esp32-a
     ```
 
 - 详细配置方法请参阅 [配置 esp-lib-utils](#配置-esp-lib-utils)
+
+### 在 Arduino IDE 中使用 ESP32_Display_Panel 时，如何避免 I2C 重复初始化（如使用 Wire 库）？
+
+如果您需要使用 ESP32_Display_Panel 的 I2C 总线功能，如使用 `I2C IO_Expander` 或 `I2C Touch` 等驱动，而您的项目中已经使用了 `Wire` 库，可能会因为 I2C 总线重复初始化导致错误。为了避免这种情况，请在创建 `Board` 对象之前初始化 `Wire`，然后参考以下步骤设置 ESP32_Display_Panel 跳过初始化 I2C：
+
+1. 通过修改 *esp_panel_board_custom_conf.h* 配置文件的方法（仅适用于 [自定义开发板](#加载自定义开发板)）：
+
+- 对于 `I2C Touch` 驱动：
+
+    ```c
+    ...
+    #define ESP_PANEL_BOARD_LCD_BUS_SKIP_INIT_HOST    (1)     // 0/1
+    ...
+    ```
+
+- 对于 `I2C IO_Expander` 驱动：
+
+    ```c
+    ...
+    #define ESP_PANEL_BOARD_EXPANDER_SKIP_INIT_HOST     (1)     // 0/1
+    ...
+    ```
+
+2. 通过代码的方法（适用于 [支持的开发板](#加载支持的开发板) 以及 [自定义开发板](#加载自定义开发板)）：
+
+    ```c
+    ...
+    esp_panel::board::Board *board = new esp_panel::board::Board();
+    board->init();
+    ...
+    /**
+     * Should be called after `board->init()` and before `board->begin()`
+     */
+    // For I2C Touch
+    static_cast<esp_panel::drivers::BusI2C *>(board->getTouch()->getBus())->configI2C_HostSkipInit();
+    // For I2C IO_Expander
+    board->getIO_Expander()->skipInitHost();
+    ...
+    board->begin();
+    ...
+    ```

docs/faq_others.md

@@ -0,0 +1,9 @@
+# Other FAQs
+
+## Can't find drivers for the same model of LCD/Touch device?
+
+For **LCD**, devices with the same interface type (SPI, QSPI, etc.) have similar or even identical driving methods. For example, ILI9341 and GC9A01 have almost identical driver code when using the SPI interface. Therefore, you can try using drivers for other devices with the same interface type.
+
+For **Touch**, drivers for some devices in the same series are compatible, such as CST816S, CST816D, and CST820 having compatible driver code. Therefore, you can check the technical manuals of devices in the same series to determine if there is compatibility (devices with the same I2C address are usually compatible).
+
+If the above methods cannot solve your problem, you can create a [Github Issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues) to request adding a driver.

docs/faq_others_cn.md

@@ -0,0 +1,9 @@
+# 其他 FAQ
+
+## 找不到相同型号的 LCD/Touch 设备驱动？
+
+对于 **LCD**，具有相同接口类型（SPI、QSPI 等）的设备的驱动方式是类似的，甚至是相同的,例如 ILI9341 和 GC9A01 在使用 SPI 接口时，驱动代码几乎相同。因此,您可以尝试使用其他相同接口类型的设备驱动。
+
+对于 **Touch**，部分相同系列设备的驱动是兼容的，如 CST816S 和 CST816D 以及 CST820 的驱动代码是兼容的。因此，您可以查阅相同系列设备的技术手册判断是否存在兼容性（如具有相同的 I2C 地址的设备通常是兼容的）。
+
+如果上述方法无法解决问题，您可以创建 [Github Issue](https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues) 请求添加驱动。

esp_panel_board_custom_conf.h

@@ -162,8 +162,8 @@
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SCL_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SDA_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_MODE                (0) // 0-3, typically set to 0
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 8
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 8
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 1
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 1
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_USE_DC_BIT          (1) // 0/1. Typically set to 1
 #endif // ESP_PANEL_BOARD_LCD_RGB_USE_CONTROL_PANEL
     /* For refresh panel (RGB) */
@@ -736,7 +736,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 1
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 0
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif // ESP_PANEL_BOARD_USE_CUSTOM
 

examples/arduino/board/board_static_config/esp_panel_board_custom_conf.h

@@ -162,8 +162,8 @@
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SCL_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SDA_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_MODE                (0) // 0-3, typically set to 0
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 8
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 8
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 1
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 1
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_USE_DC_BIT          (1) // 0/1. Typically set to 1
 #endif // ESP_PANEL_BOARD_LCD_RGB_USE_CONTROL_PANEL
     /* For refresh panel (RGB) */
@@ -736,7 +736,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 1
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 0
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif // ESP_PANEL_BOARD_USE_CUSTOM
 

examples/arduino/gui/lvgl_v8/simple_port/esp_panel_board_custom_conf.h

@@ -162,8 +162,8 @@
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SCL_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_SDA_USE_EXPNADER    (0) // Set to 1 if the signal is controlled by an IO expander
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_MODE                (0) // 0-3, typically set to 0
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 8
-    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 8
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_CMD_BYTES           (1) // Typically set to 1
+    #define ESP_PANEL_BOARD_LCD_RGB_SPI_PARAM_BYTES         (1) // Typically set to 1
     #define ESP_PANEL_BOARD_LCD_RGB_SPI_USE_DC_BIT          (1) // 0/1. Typically set to 1
 #endif // ESP_PANEL_BOARD_LCD_RGB_USE_CONTROL_PANEL
     /* For refresh panel (RGB) */
@@ -736,7 +736,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 1
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 0
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif // ESP_PANEL_BOARD_USE_CUSTOM