feat(repo): refactor with using esp-lib-utils

Author: Lzw655

.codespellrc

@@ -1,2 +1,2 @@
 [codespell]
-skip = ./src/touch/base/esp_lcd_touch_xpt2046.c
+skip = ./src/touch/port/esp_lcd_touch_xpt2046.c,

.github/workflows/upload_component.yml

@@ -15,6 +15,6 @@ jobs:
       - name: Upload components to component service
         uses: espressif/upload-components-ci-action@v1
         with:
-          name: "ESP32_Display_Panel"
+          name: "esp32_display_panel"
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

.gitlab/ci/rules.yml

@@ -11,7 +11,7 @@
 # component common files
 .patterns-component_common: &patterns-component_common
   - "CMakeLists.txt"
-  - "ESP_Panel_Conf.h"
+  - "esp_panel_conf.h"
   - "idf_component.yml"
   - "Kconfig"
   - "src/*"
@@ -42,8 +42,8 @@
 
 .patterns-component_bus_3wire_spi_rgb: &patterns-component_bus_3wire_spi_rgb
   - .patterns-component_bus_rgb
-  - "src/bus/base/esp_lcd_panel_io_3wire_spi.c"
-  - "src/bus/base/esp_lcd_panel_io_additions.h"
+  - "src/bus/port/esp_lcd_panel_io_3wire_spi.c"
+  - "src/bus/port/esp_lcd_panel_io_additions.h"
 
 .patterns-component_bus_spi: &patterns-component_bus_spi
   - .patterns-component_bus_common
@@ -55,31 +55,31 @@
 
 # component lcd files
 .patterns-component_lcd_common: &patterns-component_lcd_common
-  - "src/lcd/base/esp_lcd_vendor_types.h"
+  - "src/lcd/port/esp_panel_lcd_vendor_types.h"
   - "src/lcd/ESP_PanelLcd.*"
 
 .patterns-component_lcd_mipi_dsi: &patterns-component_lcd_mipi_dsi
   - .patterns-component_bus_mipi_dsi
   - .patterns-component_lcd_common
-  - "src/lcd/base/esp_lcd_ek79007.*"
+  - "src/lcd/port/esp_lcd_ek79007.*"
   - "src/lcd/EK79007.*"
-  - "src/lcd/base/esp_lcd_ili9881c.*"
+  - "src/lcd/port/esp_lcd_ili9881c.*"
   - "src/lcd/ILI9881C.*"
-  - "src/lcd/base/esp_lcd_jd9365.*"
+  - "src/lcd/port/esp_lcd_jd9365.*"
   - "src/lcd/JD9365.*"
 
 .patterns-component_lcd_qspi: &patterns-component_lcd_qspi
   - .patterns-component_bus_qspi
   - .patterns-component_lcd_common
-  - "src/lcd/base/esp_lcd_gc9b71.*"
+  - "src/lcd/port/esp_lcd_gc9b71.*"
   - "src/lcd/GC9B71.*"
-  - "src/lcd/base/esp_lcd_sh8601.*"
+  - "src/lcd/port/esp_lcd_sh8601.*"
   - "src/lcd/SH8601.*"
-  - "src/lcd/base/esp_lcd_spd2010.*"
+  - "src/lcd/port/esp_lcd_spd2010.*"
   - "src/lcd/SPD2010.*"
-  - "src/lcd/base/esp_lcd_st77916.*"
+  - "src/lcd/port/esp_lcd_st77916.*"
   - "src/lcd/ST77916.*"
-  - "src/lcd/base/esp_lcd_st77922.*"
+  - "src/lcd/port/esp_lcd_st77922.*"
   - "src/lcd/ST77922.*"
 
 .patterns-component_lcd_rgb: &patterns-component_lcd_rgb
@@ -91,56 +91,56 @@
 .patterns-component_lcd_3wire_spi_rgb: &patterns-component_lcd_3wire_spi_rgb
   - .patterns-component_bus_3wire_spi_rgb
   - .patterns-component_lcd_common
-  - "src/lcd/base/esp_lcd_gc9503.*"
+  - "src/lcd/port/esp_lcd_gc9503.*"
   - "src/lcd/GC9503.*"
-  - "src/lcd/base/esp_lcd_st7701.*"
+  - "src/lcd/port/esp_lcd_st7701.*"
   - "src/lcd/ST7701.*"
 
 .patterns-component_lcd_spi: &patterns-component_lcd_spi
   - .patterns-component_bus_spi
   - .patterns-component_lcd_common
-  - "src/lcd/base/esp_lcd_gc9a01.*"
+  - "src/lcd/port/esp_lcd_gc9a01.*"
   - "src/lcd/GC9A01.*"
-  - "src/lcd/base/esp_lcd_gc9b71.*"
+  - "src/lcd/port/esp_lcd_gc9b71.*"
   - "src/lcd/GC9B71.*"
-  - "src/lcd/base/esp_lcd_ILI9341.*"
+  - "src/lcd/port/esp_lcd_ILI9341.*"
   - "src/lcd/ILI9341.*"
-  - "src/lcd/base/esp_lcd_nv3022b.*"
+  - "src/lcd/port/esp_lcd_nv3022b.*"
   - "src/lcd/NV3022B.*"
-  - "src/lcd/base/esp_lcd_sh8601.*"
+  - "src/lcd/port/esp_lcd_sh8601.*"
   - "src/lcd/SH8601.*"
-  - "src/lcd/base/esp_lcd_spd2010.*"
+  - "src/lcd/port/esp_lcd_spd2010.*"
   - "src/lcd/SPD2010.*"
-  - "src/lcd/base/esp_lcd_st7789.*"
+  - "src/lcd/port/esp_lcd_st7789.*"
   - "src/lcd/ST7789.*"
-  - "src/lcd/base/esp_lcd_st77916.*"
+  - "src/lcd/port/esp_lcd_st77916.*"
   - "src/lcd/ST77916.*"
-  - "src/lcd/base/esp_lcd_st77922.*"
+  - "src/lcd/port/esp_lcd_st77922.*"
   - "src/lcd/ST77922.*"
 
 # component touch files
 .patterns-component_touch_common: &patterns-component_touch_common
-  - "src/touch/base/esp_lcd_touch.*"
+  - "src/touch/port/esp_lcd_touch.*"
   - "src/touch/ESP_PanelTouch.*"
 
 .patterns-component_touch_spi: &patterns-component_touch_spi
   - .patterns-component_bus_spi
-  - "src/touch/base/esp_lcd_touch_xpt2046.*"
+  - "src/touch/port/esp_lcd_touch_xpt2046.*"
   - "src/touch/XPT2046.*"
 
 .patterns-component_touch_i2c: &patterns-component_touch_i2c
   - .patterns-component_bus_i2c
-  - "src/touch/base/esp_lcd_touch_cst816s.*"
+  - "src/touch/port/esp_lcd_touch_cst816s.*"
   - "src/touch/CST816S.*"
-  - "src/touch/base/esp_lcd_touch_ft5x06.*"
+  - "src/touch/port/esp_lcd_touch_ft5x06.*"
   - "src/touch/FT5x06.*"
-  - "src/touch/base/esp_lcd_touch_gt911.*"
+  - "src/touch/port/esp_lcd_touch_gt911.*"
   - "src/touch/GT911.*"
-  - "src/touch/base/esp_lcd_touch_gt1151.*"
+  - "src/touch/port/esp_lcd_touch_gt1151.*"
   - "src/touch/GT1151.*"
-  - "src/touch/base/esp_lcd_touch_st7123.*"
+  - "src/touch/port/esp_lcd_touch_st7123.*"
   - "src/touch/ST7123.*"
-  - "src/touch/base/esp_lcd_touch_tt21100.*"
+  - "src/touch/port/esp_lcd_touch_tt21100.*"
   - "src/touch/TT21100.*"
 
 # component panel files

.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|Conf)\.h'
+        files: '.*esp_panel_(board_custom|board_supported|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|Conf)\.h|library.properties|.*ESP_PanelVersions.h)'
+        files: '(.*esp_panel_(board_custom|board_supported|conf)\.h|library.properties|.*esp_panel_versions.h)'
 
   - repo: local
     hooks:

CHANGELOG.md

@@ -63,7 +63,7 @@
 * fix(examples): fix WiFiClock log HTTP error code to serial console by @lboue (#97)
 * fix(examples): fix WiFiClock description
 * fix(gt911): allow to set the GT911 touch device address by @lboue (#86)
-* fix(conf): fix the issue that the `ESP_PANEL_EXPANDER_HOST_ID` flag is not working properly
+* fix(conf): fix the issue that the `ESP_PANEL_BOARD_EXPANDER_HOST_ID` flag is not working properly
 * fix(conf): fix `LCD Venbdor` typo (#92)
 
 ## v0.1.5 - 2024-07-09
@@ -74,12 +74,12 @@
 * feat(lvgl_port): set the lvgl task to run on the same core as the Arduino task by default
 * feat(board): increase the RGB pclk frequency to 26MHz for `ESP32_4848S040C_I_Y_3`
 * feat(board): add new board `elecrow: CROWPANEL_7_0` by @lboue (#71)
-* feat(conf): add connection comments for the RGB pins in *ESP_Panel_Board_Custom.h* (#58, #68)
+* feat(conf): add connection comments for the RGB pins in *esp_panel_board_custom.h* (#58, #68)
 
 ### Bugfixes:
 
 * fix(panel): init expander host with correct macro (#65)
-* fix(panel): don't reset the LCD if the bus is RGB bus and the `ESP_PANEL_LCD_FLAGS_AUTO_DEL_PANEL_IO` is enabled
+* fix(panel): don't reset the LCD if the bus is RGB bus and the `ESP_PANEL_BOARD_LCD_FLAGS_ENABLE_IO_MULTIPLEX` is enabled
 * fix(examples): fix lvgl port rotation issue when enabling avoid tearing by @NecroMancer05
 * fix(pre-commit): switch to Python 3 for pre-commit @lboue (#70)
 * fix(docs): specify lvgl version >= v8.3.9 and < 9

CMakeLists.txt

@@ -4,12 +4,9 @@ file(GLOB_RECURSE CPP_SRCS "${SRCS_DIR}/*.cpp")
 file(GLOB_RECURSE C_SRCS "${SRCS_DIR}/*.c")
 
 idf_component_register(
-    SRCS
-        ${C_SRCS} ${CPP_SRCS}
-    INCLUDE_DIRS
-        ${SRCS_DIR}
-    REQUIRES
-        driver esp_lcd
+    SRCS ${C_SRCS} ${CPP_SRCS}
+    INCLUDE_DIRS ${SRCS_DIR}
+    REQUIRES driver esp_lcd
 )
 
-target_compile_options(${COMPONENT_LIB} PRIVATE -Wno-missing-field-initializers -Wno-narrowing)
+target_compile_options(${COMPONENT_LIB} PUBLIC -Wno-missing-field-initializers)