feat(board): add new board M5DIAL

feat(docs): update changelog
esp-arduino-libs · Jun 14, 2024 · 1886c66 · 1886c66
1 parent 13ac358
commit 1886c66
Show file tree

Hide file tree

Showing 14 changed files with 391 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,11 @@
 # ChangeLog
 
-## v0.1.3 - 2024-06-04
+## v0.1.3 - 2024-06-14
 
 ### Enhancements:
 
 * feat(board): add add new board M5CORE2 by @MacChu0315-Espressif (#40)
+* feat(board): add add new board M5DIAL by @MacChu0315-Espressif (#41)
 
 ### Bugfixes:
 

diff --git a/ESP_Panel_Board_Supported.h b/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ Below is a list of [supported development boards](src/board/Board_Instructions.m
 | **Manufacturer** | **Board Model** |
 | --------------- | --------------- |
 | [Espressif](src/board/Board_Instructions.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, 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](https://m5stack.com/) | M5STACK-M5CORE2 |
+| [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2, M5STACK-M5DIAL |
 | [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
 
 Developers and manufacturers are welcomed to contribute PRs to add more development boards. For detailed instructions, please refer to the [`Board Development Guide`](./src/board/Board_Contribution_Guide.md).

diff --git a/README_CN.md b/README_CN.md
@@ -60,7 +60,7 @@ ESP32_Display_Panel 的功能框图如下所示，主要包含以下特性：
 | **厂商** | **开发板型号** |
 | -------- | -------------- |
 | [Espressif](src/board/Board_Instructions.md#espressif) | ESP32-C3-LCDkit, ESP32-S3-Box, ESP32-S3-Box-3, 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](https://m5stack.com/) | M5STACK-M5CORE2 |
+| [M5Stack](https://m5stack.com/) | M5STACK-M5CORE2, M5STACK-M5DIAL |
 | [Jingcai](src/board/Board_Instructions.md#shenzhen-jingcai-intelligent) | ESP32-4848S040C_I_Y_3 |
 
 欢迎开发者和厂商贡献 PR 来添加更多的开发板，详细说明请参考 [`开发板贡献指南`](./src/board/Board_Contribution_Guide_CN.md)。

diff --git a/examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h b/examples/LVGL/v8/Porting/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h b/examples/LVGL/v8/Rotation/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/examples/Panel/PanelTest/ESP_Panel_Board_Supported.h b/examples/Panel/PanelTest/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/examples/SquareLine/v8/Porting/ESP_Panel_Board_Supported.h b/examples/SquareLine/v8/Porting/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Supported.h b/examples/SquareLine/v8/WiFiClock/ESP_Panel_Board_Supported.h
@@ -50,9 +50,11 @@
  * M5Stack (https://m5stack.com/):
  *
  *  - M5STACK_M5CORE2: https://docs.m5stack.com/zh_CN/core/core2
+ *  - M5STACK_M5DIAL: https://docs.m5stack.com/zh_CN/core/M5Dial
  *
  */
 // #define BOARD_M5STACK_M5CORE2
+// #define BOARD_M5STACK_M5DIAL
 
 /*
  * Shenzhen Jingcai Intelligent Supported Boards (https://www.displaysmodule.com/):
@@ -76,7 +78,7 @@
  *
  */
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_FILE_VERSION_PATCH 0
 
 #endif
diff --git a/library.properties b/library.properties
@@ -3,7 +3,7 @@ version=0.1.3
 author=espressif
 maintainer=espressif
 sentence=ESP32_Display_Panel is an Arduino library designed for ESP SoCs to drive display panels and facilitate rapid GUI development.
-paragraph=Currently supported boards:ESP32-C3-LCDkit,ESP32-S3-Box,ESP32-S3-Box-3,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-M5CORE2,ESP32-4848S040C_I_Y_3. Currently supported devices: Bus,LCD,Touch,Backlight,IO expander. Currently supported Bus: I2C,SPI,QSPI,3-wire SPI + RGB. Currently supported LCD controllers: GC9A01,GC9B71,GC9503,ILI9341,NV3022B,ST7262,ST7701,ST7789,ST7796,ST77916,ST77922. Currently supported Touch controllers: CST816S,FT5x06,GT1151,GT911,ST7123,TT21100,XPT2046.
+paragraph=Currently supported boards:ESP32-C3-LCDkit,ESP32-S3-Box,ESP32-S3-Box-3,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-M5CORE2,M5STACK-M5DIAL,ESP32-4848S040C_I_Y_3. Currently supported devices: Bus,LCD,Touch,Backlight,IO expander. Currently supported Bus: I2C,SPI,QSPI,3-wire SPI + RGB. Currently supported LCD controllers: GC9A01,GC9B71,GC9503,ILI9341,NV3022B,ST7262,ST7701,ST7789,ST7796,ST77916,ST77922. Currently supported Touch controllers: CST816S,FT5x06,GT1151,GT911,ST7123,TT21100,XPT2046.
 category=Other
 architectures=esp32
 url=https://github.com/esp-arduino-libs/ESP32_Display_Panel

diff --git a/src/ESP_PanelVersions.h b/src/ESP_PanelVersions.h
@@ -25,7 +25,7 @@
 
 /* File `ESP_Panel_Board_Supported.h` */
 #define ESP_PANEL_BOARD_SUPPORTED_VERSION_MAJOR 0
-#define ESP_PANEL_BOARD_SUPPORTED_VERSION_MINOR 2
+#define ESP_PANEL_BOARD_SUPPORTED_VERSION_MINOR 3
 #define ESP_PANEL_BOARD_SUPPORTED_VERSION_PATCH 0
 
 /* Check if the current configuration file version is compatible with the library version */

diff --git a/src/board/Board_Instructions.md b/src/board/Board_Instructions.md
@@ -22,6 +22,7 @@
 |                                                                                                                                       **Picture**                                                                                                                                       |                                                **Name**                                                 |   **LCD Bus**    | **LCD Controller** | **Touch Bus** | **Touch Controller** |
 | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------: | :--------------: | :----------------: | :-----------: | :------------------: |
 | [<img src="https://static-cdn.m5stack.com/resource/docs/products/core/core2/core2_01.webp" width="150">](https://www.displaysmodule.com/sale-41828962-experience-the-power-of-the-esp32-display-module-sku-esp32-4848s040c-i-y-3.html) | [M5STACK_M5CORE2](https://docs.m5stack.com/zh_CN/core/core2) | SPI |       ILI9342C       |      I2C      |        FT6336U         |
+| [<img src="https://static-cdn.m5stack.com/resource/docs/products/core/M5Dial/img-2afd549e-8af8-47b4-823a-e90e063a0139.webp" width="150">](https://www.displaysmodule.com/sale-41828962-experience-the-power-of-the-esp32-display-module-sku-esp32-4848s040c-i-y-3.html) | [M5STACK_M5DIAL](https://docs.m5stack.com/zh_CN/core/M5Dial) | SPI |       GC9A01       |      I2C      |        FT5x06         |
 
 ### [Shenzhen Jingcai Intelligent](https://www.displaysmodule.com/)
 
@@ -46,6 +47,7 @@ Below are recommended configurations for developing GUI applications on differen
 | ESP32-S3-LCD-EV-Board-2 | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    16MB    | **See Note 1**  |     16M Flash (3MB)     |
 |    ESP32-S3-USB-OTG     |  ESP32-S3-USB-OTG  |    -     |     -      |     -      |        -        |     8M with spiffs      |
 |     M5STACK-M5CORE2     |    M5Stack-Core2   | Enabled  |     -      |     -      |        -        |         Default         |
+|     M5STACK-M5DIAL      | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    8MB     |    Disabled     |         Default         |
 |  ESP32-4848S040C_I_Y_3  | ESP32S3 Dev Module |   OPI    | QIO 80MHz  |    16MB    |    Disabled     |     16M Flash (3MB)     |
 
 **Notes:**

diff --git a/src/board/ESP_PanelBoard.h b/src/board/ESP_PanelBoard.h
@@ -14,7 +14,7 @@
     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_M5STACK_M5CORE2) + defined(BOARD_ESP32_4848S040C_I_Y_3) \
+    defined(BOARD_M5STACK_M5CORE2) + defined(BOARD_M5STACK_M5DIAL) + defined(BOARD_ESP32_4848S040C_I_Y_3) \
     > 1
     #error "Multiple boards enabled! Please check file `ESP_Panel_Board_Supported.h` and make sure only one board is enabled."
 #endif
@@ -48,6 +48,8 @@
 /* M5Stack */
 #elif defined(BOARD_M5STACK_M5CORE2) || CONFIG_BOARD_M5STACK_M5CORE2
     #include "board/m5stack/M5CORE2.h"
+#elif defined(BOARD_M5STACK_M5DIAL) || CONFIG_BOARD_M5STACK_M5DIAL
+    #include "board/m5stack/M5DIAL.h"
 /* 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"