Merge branch 'feat/refactor_and_support_micropython' into 'master'

feat(repo): release v1.0.0

Closes #137

See merge request ae_group/ESP32_Display_Panel!10

Author: Lzw655

.build-rules.yml

@@ -4,49 +4,71 @@
 #    *  (A == 1 and B == 2) or (C not in ["3", "4", 5])
 
 # Test apps
-test_apps/lcd/3wire_spi_rgb:
+# Board
+test_apps/board/common:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/elecrow:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/espressif:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/jingcai:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/m5stack:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/viewe:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+test_apps/board/waveshare:
+  enable:
+    - if: INCLUDE_DEFAULT == 1
+
+# Drivers
+test_apps/drivers/lcd/3wire_spi_rgb:
   disable:
     - if: SOC_LCD_RGB_SUPPORTED != 1
     - if: IDF_TARGET == "esp32p4"
       temporary: true
       reason: not ready
 
-test_apps/lcd/qspi:
+test_apps/drivers/lcd/qspi:
   disable:
     - if: SOC_GPSPI_SUPPORTED != 1
 
-test_apps/lcd/mipi_dsi:
+test_apps/drivers/lcd/mipi_dsi:
   disable:
     - if: SOC_MIPI_DSI_SUPPORTED != 1
 
-test_apps/lcd/rgb:
+test_apps/drivers/lcd/rgb:
   disable:
     - if: SOC_LCD_RGB_SUPPORTED != 1
     - if: IDF_TARGET == "esp32p4"
       temporary: true
       reason: not ready
 
-test_apps/lcd/spi:
+test_apps/drivers/lcd/spi:
   disable:
     - if: SOC_GPSPI_SUPPORTED != 1
 
-test_apps/lvgl_port:
-  enable:
-    - if: INCLUDE_DEFAULT == 1
-
-test_apps/panel:
-  enable:
-    - if: INCLUDE_DEFAULT == 1
-
-test_apps/touch/i2c:
+test_apps/drivers/touch/i2c:
   disable:
     - if: SOC_I2C_SUPPORTED != 1
 
-test_apps/touch/spi:
+test_apps/drivers/touch/spi:
   disable:
     - if: SOC_GPSPI_SUPPORTED != 1
 
 # Examples
-# examples/esp_idf/esp_brookesia_phone_m5stace_core_s3:
-#   enable:
-#     - if: IDF_TARGET in ["esp32s3"]
+test_apps/gui/lvgl_v8_port:
+  enable:
+    - if: INCLUDE_DEFAULT == 1

.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/build.yml

@@ -43,7 +43,7 @@
     - python .gitlab/tools/build_apps.py ${EXAMPLE_DIR} --config ${EXAMPLE_CONFIG} -t all -vv
 
 #  Images for different target ESP-IDF
-.build_idf_active_release_image:
+.build_general_idf_release_image:
   parallel:
     matrix:
       - IMAGE: espressif/idf:release-v5.1
@@ -57,170 +57,118 @@
       - IMAGE: espressif/idf:release-v5.3
       - IMAGE: espressif/idf:release-v5.4
 
-# Test apps common
-build_test_apps_common:
-  extends:
-    - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_common
-  variables:
-    EXAMPLE_DIR: test_apps/common
-
 # Test apps lcd
-build_test_apps_lcd_3wire_spi_rgb:
+build_test_apps_drivers_lcd_3wire_spi_rgb:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lcd_3wire_spi_rgb
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_lcd_3wire_spi_rgb
   variables:
-    EXAMPLE_DIR: test_apps/lcd/3wire_spi_rgb
+    EXAMPLE_DIR: test_apps/drivers/lcd/3wire_spi_rgb
 
-build_test_apps_lcd_mipi_dsi:
+build_test_apps_drivers_lcd_mipi_dsi:
   extends:
     - .build_examples_template
     - .build_esp32_p4_idf_release_image
-    - .rules:build:test_apps_lcd_mipi_dsi
+    - .rules:build:test_apps_drivers_lcd_mipi_dsi
   variables:
-    EXAMPLE_DIR: test_apps/lcd/mipi_dsi
+    EXAMPLE_DIR: test_apps/drivers/lcd/mipi_dsi
 
-build_test_apps_lcd_qspi:
+build_test_apps_drivers_lcd_qspi:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lcd_qspi
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_lcd_qspi
   variables:
-    EXAMPLE_DIR: test_apps/lcd/qspi
+    EXAMPLE_DIR: test_apps/drivers/lcd/qspi
 
-build_test_apps_lcd_rgb:
+build_test_apps_drivers_lcd_rgb:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lcd_rgb
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_lcd_rgb
   variables:
-    EXAMPLE_DIR: test_apps/lcd/rgb
+    EXAMPLE_DIR: test_apps/drivers/lcd/rgb
 
-build_test_apps_lcd_spi:
+build_test_apps_drivers_lcd_spi:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lcd_spi
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_lcd_spi
   variables:
-    EXAMPLE_DIR: test_apps/lcd/spi
+    EXAMPLE_DIR: test_apps/drivers/lcd/spi
 
-# Test apps lvgl_port
-build_test_apps_lvgl_port_elecrow:
-  extends:
-    - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lvgl_port_board_elecrow
-  variables:
-    EXAMPLE_DIR: test_apps/lvgl_port
-    EXAMPLE_CONFIG: sdkconfig.elecrow.*
-
-build_test_apps_lvgl_port_espressif:
-  extends:
-    - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lvgl_port_board_espressif
-  variables:
-    EXAMPLE_DIR: test_apps/lvgl_port
-    EXAMPLE_CONFIG: sdkconfig.espressif.*
-
-build_test_apps_lvgl_port_jingcai:
+# Test apps touch
+build_test_apps_drivers_touch_i2c:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lvgl_port_board_jingcai
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_touch_i2c
   variables:
-    EXAMPLE_DIR: test_apps/lvgl_port
-    EXAMPLE_CONFIG: sdkconfig.jingcai.*
+    EXAMPLE_DIR: test_apps/drivers/touch/i2c
 
-build_test_apps_lvgl_port_m5stack:
+build_test_apps_drivers_touch_spi:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lvgl_port_board_m5stack
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_drivers_touch_spi
   variables:
-    EXAMPLE_DIR: test_apps/lvgl_port
-    EXAMPLE_CONFIG: sdkconfig.m5stack.*
+    EXAMPLE_DIR: test_apps/drivers/touch/spi
 
-build_test_apps_lvgl_port_waveshare:
+# Test apps board
+build_test_apps_board_common:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_lvgl_port_board_waveshare
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_common
   variables:
-    EXAMPLE_DIR: test_apps/lvgl_port
-    EXAMPLE_CONFIG: sdkconfig.waveshare.*
+    EXAMPLE_DIR: test_apps/board/common
 
-# Test apps panel
-build_test_apps_panel_elecrow:
+build_test_apps_board_elecrow:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_panel_board_elecrow
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_elecrow
   variables:
-    EXAMPLE_DIR: test_apps/panel
-    EXAMPLE_CONFIG: sdkconfig.elecrow.*
+    EXAMPLE_DIR: test_apps/board/elecrow
 
-build_test_apps_panel_espressif:
+build_test_apps_board_espressif:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_panel_board_espressif
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_espressif
   variables:
-    EXAMPLE_DIR: test_apps/panel
-    EXAMPLE_CONFIG: sdkconfig.espressif.*
+    EXAMPLE_DIR: test_apps/board/espressif
 
-build_test_apps_panel_jingcai:
+build_test_apps_board_jingcai:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_panel_board_jingcai
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_jingcai
   variables:
-    EXAMPLE_DIR: test_apps/panel
-    EXAMPLE_CONFIG: sdkconfig.jingcai.*
+    EXAMPLE_DIR: test_apps/board/jingcai
 
-build_test_apps_panel_m5stack:
+build_test_apps_board_m5stack:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_panel_board_m5stack
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_m5stack
   variables:
-    EXAMPLE_DIR: test_apps/panel
-    EXAMPLE_CONFIG: sdkconfig.m5stack.*
+    EXAMPLE_DIR: test_apps/board/m5stack
 
-build_test_apps_panel_waveshare:
+build_test_apps_board_waveshare:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_panel_board_waveshare
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_board_waveshare
   variables:
-    EXAMPLE_DIR: test_apps/panel
-    EXAMPLE_CONFIG: sdkconfig.waveshare.*
+    EXAMPLE_DIR: test_apps/board/waveshare
 
-# Test apps touch
-build_test_apps_touch_i2c:
+# Test apps examples
+build_test_apps_gui_lvgl_v8_port:
   extends:
     - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_touch_i2c
+    - .build_general_idf_release_image
+    - .rules:build:test_apps_gui_lvgl_v8_port
   variables:
-    EXAMPLE_DIR: test_apps/touch/i2c
-
-build_test_apps_touch_spi:
-  extends:
-    - .build_examples_template
-    - .build_idf_active_release_image
-    - .rules:build:test_apps_touch_spi
-  variables:
-    EXAMPLE_DIR: test_apps/touch/spi
-
-# Examples
-# build_example_esp_brookesia_phone_m5stace_core_s3:
-#   extends:
-#     - .build_examples_template
-#     - .build_esp32_s3_idf_release_image
-#     - .rules:build:example_esp_brookesia_phone_m5stace_core_s3
-#   variables:
-#     EXAMPLE_DIR: examples/esp_idf/esp_brookesia_phone_m5stace_core_s3
+    EXAMPLE_DIR: test_apps/gui/lvgl_v8_port