feat(example): add docs for PlatformIO

Author: Lzw655

examples/platformio/src/ESP_Panel_Board_Custom.h

@@ -214,7 +214,7 @@
  *      - CST816S
  *      - FT5x06
  *      - GT911, GT1151
- *      - ST7123
+ *      - ST1633, ST7123
  *      - TT21100
  *      - XPT2046
  */
@@ -362,7 +362,7 @@
  */
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MAJOR 0
 #define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_MINOR 1
-#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 0
+#define ESP_PANEL_BOARD_CUSTOM_FILE_VERSION_PATCH 1
 
 #endif /* ESP_PANEL_USE_CUSTOM_BOARD */
 

examples/platformio/src/ESP_Panel_Conf.h

@@ -1,25 +1,32 @@
-/**
- * Debug configurations
+/*
+ * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
  *
+ * SPDX-License-Identifier: Apache-2.0
  */
+
+#pragma once
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////////// Debug Configurations /////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Set to 1 if assert on error. Otherwise print error message */
 #define ESP_PANEL_CHECK_RESULT_ASSERT       (0)         // 0/1
 
 /* Set to 1 if print log message for debug */
 #define ESP_PANEL_ENABLE_LOG                (0)         // 0/1
 
-/**
- * Touch driver configurations
- *
- */
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+///////////////////////////////////////////// Touch Driver Configurations //////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 /* Maximum point number */
-#define ESP_PANEL_TOUCH_MAX_POINTS          (3)
-
+#define ESP_PANEL_TOUCH_MAX_POINTS          (5)
 /* Maximum button number */
 #define ESP_PANEL_TOUCH_MAX_BUTTONS         (1)
 
-/* Model configurations */
-// XPT2046
+/**
+ * XPT2046 related
+ *
+ */
 #define ESP_PANEL_TOUCH_XPT2046_Z_THRESHOLD             (400)   // Minimum Z pressure threshold
 /**
  * Enable Interrupt (PENIRQ) output, also called Full Power Mode.
@@ -50,3 +57,21 @@
  *
  */
 #define ESP_PANEL_TOUCH_XPT2046_ENABLE_LOCKING          (0)     // 0/1
+
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
+////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+/**
+ * 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_Custom.h` in the library. The detailed rules are as follows:
+ *
+ *   1. If the major version is not consistent, then the configurations in this file are incompatible with the library
+ *      and must be replaced with the file from the library.
+ *   2. If the minor version is not consistent, this file might be missing some new configurations, which will be set to
+ *      default values. It is recommended to replace it with the file from the library.
+ *   3. Even if the patch version is not consistent, it will not affect normal functionality.
+ *
+ */
+#define ESP_PANEL_CONF_FILE_VERSION_MAJOR 0
+#define ESP_PANEL_CONF_FILE_VERSION_MINOR 1
+#define ESP_PANEL_CONF_FILE_VERSION_PATCH 1

examples/platformio/src/app.cpp

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: CC0-1.0
+ */
 
 #include <Arduino.h>
 #include <ESP_Panel_Library.h>
@@ -67,4 +72,4 @@ void loop()
 {
     Serial.println("IDLE loop");
     delay(1000);
-}
+}

examples/platformio/src/lv_conf.h

@@ -1,3 +1,8 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: CC0-1.0
+ */
 /**
  * @file lv_conf.h
  * Configuration file for v8.3.3
@@ -757,8 +762,3 @@ e.g. "stm32f769xx.h" or "stm32f429xx.h"*/
 #endif /*LV_CONF_H*/
 
 #endif /*End of "Content enable"*/
-
-
-
-
-

library.properties

@@ -1,5 +1,5 @@
 name=ESP32_Display_Panel
-version=0.1.2
+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.

src/ESP_PanelVersions.h

@@ -11,7 +11,7 @@
 /* Library Version */
 #define ESP_PANEL_VERSION_MAJOR 0
 #define ESP_PANEL_VERSION_MINOR 1
-#define ESP_PANEL_VERSION_PATCH 2
+#define ESP_PANEL_VERSION_PATCH 3
 
 /* File `ESP_Panel_Conf.h` */
 #define ESP_PANEL_CONF_VERSION_MAJOR 0