feat(board): add support for Waveshare ESP32-S3-Touch-LCD-4.3 board by @lboue (#99)

lboue · web-flow · web-flow · commit 1f8d12aab083 · 2024-07-31T14:20:02.000+08:00
* Waveshare ESP32-S3-Touch-LCD-4.3 board

* Waveshare ESP32-S3-Touch-LCD-4.3 board

* Update Board_Instructions.md

* Update README.md

* Update README_CN.md

* Update Board_Instructions.md

* Update library.properties

* Update ESP_PanelVersions.h

* BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3

* Update ESP32_S3_Touch_LCD_4.3.h

* Update Board_Instructions.md

* Update ESP32_S3_Touch_LCD_4.3.h

The RGB interface is used without the 3-wire SPI interface

* Update ESP32_S3_Touch_LCD_4.3.h

* Update ESP32_S3_Touch_LCD_4.3.h

* Update ESP32_S3_Touch_LCD_4.3.h

* Fix pre-commit CI check

* ChangeLog v0.1.6

* Update ESP_PanelBoard.h

* Bump minor version for `ESP_Panel_Board_Custom.h` &amp; `ESP_Panel_Board_Supported.h`

---------

Co-authored-by: Ludovic BOUÉ &lt;noreply@github.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,7 @@
 ### Enhancements:
 
 * feat(board): add support for Fitipower EK9716B LCD controller for CrowPanel 7.0" board by @lboue (#78)
+* feat(board): add support for Waveshare ESP32-S3-Touch-LCD-4.3 by @lboue (#99)
 
 ### Bugfixes:
 
diff --git a/ESP_Panel_Board_Supported.h b/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/README.md b/README.md
@@ -65,6 +65,7 @@ Below is a list of [supported development boards](docs/Board_Instructions.md):
 | [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 |
 | [M5Stack](docs/Board_Instructions.md#m5stack) | M5STACK-M5CORE2, M5STACK-M5DIAL, M5STACK-M5CORES3 |
 | [Jingcai](docs/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
+| [Waveshare](docs/Board_Instructions.md#waveshare) | ESP32-S3-Touch-LCD-4.3 |
 
 Developers and manufacturers are welcomed to contribute PRs to add more development boards. For detailed instructions, please refer to the [`Board Development Guide`](./docs/Board_Contribution_Guide.md).
 
diff --git a/README_CN.md b/README_CN.md
@@ -65,6 +65,7 @@ ESP32_Display_Panel 的功能框图如下所示，主要包含以下特性：
 | [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 |
 | [M5Stack](docs/Board_Instructions.md#m5stack) | M5STACK-M5CORE2, M5STACK-M5DIAL, M5STACK-M5CORES3 |
 | [Jingcai](docs/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
+| [Waveshare](docs/Board_Instructions.md#waveshare) | ESP32-S3-Touch-LCD-4.3 |
 
 欢迎开发者和厂商贡献 PR 来添加更多的开发板，详细说明请参考 [`开发板贡献指南`](./docs/Board_Contribution_Guide_CN.md)。
 
diff --git a/docs/Board_Instructions.md b/docs/Board_Instructions.md
@@ -38,6 +38,12 @@
 | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :--------------: | :----------------: | :----------------: | :-----------: | :------------------: |
 | [<img src="https://www.displaysmodule.com/photo/ps162171631-experience_the_power_of_the_esp32_display_module_sku_esp32_4848s040c_i_y_3.jpg" width="150">](https://www.displaysmodule.com/sale-41828962-experience-the-power-of-the-esp32-display-module-sku-esp32-4848s040c-i-y-3.html) | [ESP32-4848S040C_I_Y_3](http://pan.jczn1688.com/directlink/1/ESP32%20module/4.0inch_ESP32-4848S040.zip) | 3-wire SPI + RGB |       ST7701       |      480x480       |      I2C      |        GT911         |
 
+## [Waveshare](https://www.waveshare.com/)
+
+|                                                                                                                                       **Picture**                                                                                                                                       |                                                **Name**                                                 |   **LCD Bus**    | **LCD Controller** | **LCD resolution** | **Touch Bus** | **Touch Controller** |
+| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :--------------: | :----------------: | ------------------ | :-----------: | :------------------: |
+| <img src="https://www.waveshare.com/media/catalog/product/cache/1/small_image/171x171/9df78eab33525d08d6e5fb8d27136e95/e/s/esp32-s3-touch-lcd-4.3-1.jpg" width="150"> | [ESP32-S3-Touch-LCD-4.3](https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm) | RGB |       ST7262       |      800x480       |      I2C      |        GT911         |
+
 ## Recommended Configurations in the Arduino IDE
 
 Below are recommended configurations for developing GUI applications on different development boards. These settings can be adjusted according to specific requirements, and users can navigate to the `Tools` menu in the Arduino IDE to configure the following settings.
@@ -59,6 +65,7 @@ Below are recommended configurations for developing GUI applications on differen
 |         M5STACK-M5CORES3         | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    16MB    |     Enabled     | Default 4MB with spiffs |
 |      ESP32-4848S040C_I_Y_3       | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    16MB    |    Disabled     |     16M Flash (3MB)     |
 |      ElecrowCrowPanel 7.0"       | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    4MB     |    Disabled     |     Huge App (3MB)      |
+| Waveshare-ESP32-S3-Touch-LCD-4.3 | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    8MB     |    Disabled     |     8M with spiffs      |
 
 **Notes:**
 
diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h b/examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/examples/Panel/PanelTest/ESP_Panel_Board_Supported.h b/examples/Panel/PanelTest/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/examples/PlatformIO/src/ESP_Panel_Board_Supported.h b/examples/PlatformIO/src/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/examples/SquareLine/v8/Porting/ESP_Panel_Board_Supported.h b/examples/SquareLine/v8/Porting/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Supported.h b/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Supported.h
@@ -74,6 +74,15 @@
  */
 // #define BOARD_ESP32_4848S040C_I_Y_3
 
+/*
+ * Waveshare Supported Boards (https://www.waveshare.com/):
+ *
+ *  - ESP32_S3_Touch_LCD_4_3:
+ *      - https://www.waveshare.com/esp32-s3-touch-lcd-4.3.htm
+ *
+ */
+// #define BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+
 /**
  * Do not change the following versions, they are used to check if the configurations in this file are compatible with
  * the current version of `ESP_Panel_Board_Supported.h` in the library. The detailed rules are as follows:
diff --git a/src/ESP_PanelVersions.h b/src/ESP_PanelVersions.h
@@ -56,7 +56,7 @@
     !defined(ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR) && \
     !defined(ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH)
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 1
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 #endif
 // Check if the current configuration file version is compatible with the library version
diff --git a/src/board/ESP_PanelBoard.h b/src/board/ESP_PanelBoard.h
@@ -13,9 +13,9 @@
     defined(BOARD_ESP32_S3_BOX_3_BETA) + defined(BOARD_ESP32_S3_BOX_LITE) + defined(BOARD_ESP32_S3_EYE) + \
     defined(BOARD_ESP32_S3_KORVO_2) + defined(BOARD_ESP32_S3_LCD_EV_BOARD) + \
     defined(BOARD_ESP32_S3_LCD_EV_BOARD_V1_5) +  defined(BOARD_ESP32_S3_LCD_EV_BOARD_2) + \
-    defined(BOARD_ESP32_S3_LCD_EV_BOARD_2_V1_5) + defined(BOARD_ESP32_S3_USB_OTG) + \
+    defined(BOARD_ESP32_S3_LCD_EV_BOARD_2_V1_5) + defined(BOARD_ESP32_S3_USB_OTG) +  defined(BOARD_ELECROW_CROWPANEL_7_0) \
     defined(BOARD_M5STACK_M5CORE2) + defined(BOARD_M5STACK_M5DIAL) + defined(BOARD_M5STACK_M5CORES3) + \
-    defined(BOARD_ESP32_4848S040C_I_Y_3) \
+    defined(BOARD_ESP32_4848S040C_I_Y_3) + defined(BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3) \
     > 1
     #error "Multiple boards enabled! Please check file `ESP_Panel_Board_Supported.h` and make sure only one board is enabled."
 #endif
@@ -59,6 +59,9 @@
 /* Jingcai */
 #elif defined(BOARD_ESP32_4848S040C_I_Y_3) || CONFIG_BOARD_ESP32_4848S040C_I_Y_3
     #include "board/jingcai/ESP32_4848S040C_I_Y_3.h"
+/* Waveshare */
+#elif defined(BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3) || CONFIG_BOARD_WAVESHARE_ESP32_S3_Touch_LCD_4_3
+    #include "board/waveshare/ESP32_S3_Touch_LCD_4.3.h"
 #else
     #error "Unkonw board selected! Please check file `ESP_Panel_Board_Supported.h` and make sure only one board is enabled."
 #endif
diff --git a/src/board/waveshare/ESP32_S3_Touch_LCD_4.3.h b/src/board/waveshare/ESP32_S3_Touch_LCD_4.3.h
