From efee7e2fcc49f4452fb7cc22c4c217955d7c2f5a Mon Sep 17 00:00:00 2001 From: Liu Zhongwei Date: Wed, 19 Feb 2025 11:02:07 +0800 Subject: [PATCH 1/2] fix(touch): avoid reading the button state when disabled (#162) Closes https://github.com/esp-arduino-libs/ESP32_Display_Panel/issues/162 --- src/drivers/touch/esp_panel_touch.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/drivers/touch/esp_panel_touch.cpp b/src/drivers/touch/esp_panel_touch.cpp index 6e07a68a..a4b59efb 100644 --- a/src/drivers/touch/esp_panel_touch.cpp +++ b/src/drivers/touch/esp_panel_touch.cpp @@ -304,8 +304,10 @@ bool Touch::readRawData(int points_num, int buttons_num, int timeout_ms) // Get the points ESP_UTILS_CHECK_FALSE_RETURN(readRawDataPoints(points_num), false, "Read points failed"); +#if CONFIG_ESP_LCD_TOUCH_MAX_BUTTONS > 0 // Get the buttons ESP_UTILS_CHECK_FALSE_RETURN(readRawDataButtons(buttons_num), false, "Read buttons failed"); +#endif ESP_UTILS_LOG_TRACE_EXIT_WITH_THIS(); @@ -610,10 +612,10 @@ bool Touch::readRawDataButtons(int buttons_num) } // Limit the max buttons number if (buttons_num > BUTTONS_MAX_NUM) { - buttons_num = BUTTONS_MAX_NUM; ESP_UTILS_LOGW( "The target buttons number(%d) out of range, use the max number(%d) instead", buttons_num, BUTTONS_MAX_NUM ); + buttons_num = BUTTONS_MAX_NUM; } if (buttons_num <= 0) { ESP_UTILS_LOGD("Ignore to read buttons"); @@ -627,13 +629,14 @@ bool Touch::readRawDataButtons(int buttons_num) for (int i = 0; i < buttons_num; i++) { button_state = 0; +#if CONFIG_ESP_LCD_TOUCH_MAX_BUTTONS > 0 auto ret = esp_lcd_touch_get_button_state(touch_panel, i, &button_state); if (ret == ESP_ERR_INVALID_ARG) { ESP_UTILS_LOGD("Button(%d) is not supported", i); break; } ESP_UTILS_CHECK_ERROR_RETURN(ret, false, "Get button(%d) state failed", i); - +#endif buttons.emplace_back(i, button_state); } From 691382b3f28738266dbc17ee892d0f101ebc8436 Mon Sep 17 00:00:00 2001 From: Liu Zhongwei Date: Wed, 19 Feb 2025 11:22:55 +0800 Subject: [PATCH 2/2] fix(docs): correct and add descriptions --- .gitlab/ci/rules.yml | 233 +++++++++++------- CHANGELOG.md | 7 + docs/envs/use_with_arduino.md | 12 +- docs/envs/use_with_arduino_cn.md | 12 +- .../lcd/lcd_single_rgb/lcd_single_rgb.ino | 2 +- examples/platformio/lvgl_v8_port/README.md | 3 +- idf_component.yml | 2 +- library.properties | 2 +- src/esp_panel_versions.h | 2 +- 9 files changed, 168 insertions(+), 107 deletions(-) diff --git a/.gitlab/ci/rules.yml b/.gitlab/ci/rules.yml index bc8fcba8..8368c163 100644 --- a/.gitlab/ci/rules.yml +++ b/.gitlab/ci/rules.yml @@ -10,110 +10,79 @@ # component general files .patterns-component_general: &patterns-component_general + - "src/esp_panel_conf_internal.h" + - "src/esp_panel_types.h" + - "src/esp_panel_versions.h" - "CMakeLists.txt" - "idf_component.yml" - "Kconfig" # component utils files -.patterns-component_utils: &patterns-component_utils - - .patterns-component_general +.patterns-component_utils_all: &patterns-component_utils_all - "src/utils/**/*" # component drivers-general files .patterns-component_drivers_general: &patterns-component_drivers_general - - .patterns-component_general - - .patterns-component_utils - "esp_panel_drivers_conf.h" - "src/drivers/esp_panel_drivers_conf_internal.h" - "src/drivers/Kconfig.drivers" # component drivers-backlight files -.patterns-component_drivers_backlight: &patterns-component_drivers_backlight - - .patterns-component_drivers_general +.patterns-component_drivers_backlight_all: &patterns-component_drivers_backlight_all - "src/drivers/backlight/**/*" # component drivers-host files .patterns-component_drivers_host_general: &patterns-component_drivers_host_general - - .patterns-component_drivers_general - "src/drivers/host/esp_panel_host.*" .patterns-component_drivers_host_dsi: &patterns-component_drivers_host_dsi - - .patterns-component_drivers_host_general - "src/drivers/host/port/esp_panel_host_dsi.*" .patterns-component_drivers_host_i2c: &patterns-component_drivers_host_i2c - - .patterns-component_drivers_host_general - "src/drivers/host/port/esp_panel_host_i2c.*" .patterns-component_drivers_host_spi: &patterns-component_drivers_host_spi - - .patterns-component_drivers_host_general - "src/drivers/host/port/esp_panel_host_spi.*" .patterns-component_drivers_host_all: &patterns-component_drivers_host_all - - .patterns-component_drivers_host_dsi - - .patterns-component_drivers_host_i2c - - .patterns-component_drivers_host_spi + - "src/drivers/host/**/*" # component drivers-bus files .patterns-component_drivers_bus_general: &patterns-component_drivers_bus_general - - .patterns-component_drivers_general - "src/drivers/bus/esp_panel_bus_conf_internal.h" - "src/drivers/bus/esp_panel_bus.*" - "src/drivers/bus/Kconfig.bus" .patterns-component_drivers_bus_dsi: &patterns-component_drivers_bus_dsi - - .patterns-component_drivers_bus_general - - .patterns-component_drivers_host_dsi - "src/drivers/bus/port/esp_panel_bus_dsi.*" .patterns-component_drivers_bus_i2c: &patterns-component_drivers_bus_i2c - - .patterns-component_drivers_bus_general - - .patterns-component_drivers_host_i2c - "src/drivers/bus/port/esp_panel_bus_i2c.*" .patterns-component_drivers_bus_qspi: &patterns-component_drivers_bus_qspi - - .patterns-component_drivers_bus_general - - .patterns-component_drivers_host_spi - "src/drivers/bus/port/esp_panel_bus_qspi.*" .patterns-component_drivers_bus_rgb: &patterns-component_drivers_bus_rgb - - .patterns-component_drivers_bus_general - "src/drivers/bus/port/esp_panel_bus_rgb.*" .patterns-component_drivers_bus_3wire_spi_rgb: &patterns-component_drivers_bus_3wire_spi_rgb - - .patterns-component_drivers_bus_rgb - "src/drivers/bus/port/esp_lcd_panel_io_3wire_spi.c" - "src/drivers/bus/port/esp_lcd_panel_io_additions.h" .patterns-component_drivers_bus_spi: &patterns-component_drivers_bus_spi - - .patterns-component_drivers_bus_general - - .patterns-component_drivers_host_spi - "src/drivers/bus/port/esp_panel_bus_spi.*" .patterns-component_drivers_bus_all: &patterns-component_drivers_bus_all - - .patterns-component_drivers_bus_dsi - - .patterns-component_drivers_bus_i2c - - .patterns-component_drivers_bus_qspi - - .patterns-component_drivers_bus_rgb - - .patterns-component_drivers_bus_3wire_spi_rgb - - .patterns-component_drivers_bus_spi - -# component dirvers-io_expander files -.patterns-component_drivers_io_expander_all: &patterns-component_drivers_io_expander_all - - .patterns-component_drivers_general - - "src/drivers/io_expander/**/*" + - "src/drivers/bus/**/*" # component drivers-lcd files .patterns-component_drivers_lcd_general: &patterns-component_drivers_lcd_general - - .patterns-component_drivers_general - "src/drivers/lcd/port/esp_panel_lcd_vendor_types.h" - "src/drivers/lcd/esp_panel_lcd_conf_internal.h" - "src/drivers/lcd/esp_panel_lcd.*" - "src/drivers/lcd/Kconfig.lcd" .patterns-component_drivers_lcd_mipi_dsi: &patterns-component_drivers_lcd_mipi_dsi - - .patterns-component_drivers_lcd_general - - .patterns-component_drivers_bus_dsi - "src/drivers/lcd/**/*ek79007*" - "src/drivers/lcd/**/*hx8399*" - "src/drivers/lcd/**/*ili9881c*" @@ -125,8 +94,7 @@ - "src/drivers/lcd/**/*st77922*" .patterns-component_drivers_lcd_qspi: &patterns-component_drivers_lcd_qspi - - .patterns-component_drivers_lcd_general - - .patterns-component_drivers_bus_qspi + - "src/drivers/lcd/**/*axs15231b*" - "src/drivers/lcd/**/*gc9b71*" - "src/drivers/lcd/**/*sh8601*" - "src/drivers/lcd/**/*spd2010*" @@ -134,22 +102,16 @@ - "src/drivers/lcd/**/*st77922*" .patterns-component_drivers_lcd_rgb: &patterns-component_drivers_lcd_rgb - - .patterns-component_drivers_lcd_general - - .patterns-component_drivers_bus_rgb - "src/drivers/lcd/**/*ek9716b*" - "src/drivers/lcd/**/*st7262*" .patterns-component_drivers_lcd_3wire_spi_rgb: &patterns-component_drivers_lcd_3wire_spi_rgb - - .patterns-component_drivers_lcd_general - - .patterns-component_drivers_bus_3wire_spi_rgb - "src/drivers/lcd/**/*gc9503*" - "src/drivers/lcd/**/*st7701*" - "src/drivers/lcd/**/*st77903*" - "src/drivers/lcd/**/*st77922*" .patterns-component_drivers_lcd_spi: &patterns-component_drivers_lcd_spi - - .patterns-component_drivers_lcd_general - - .patterns-component_drivers_bus_spi - "src/drivers/lcd/**/*gc9a01*" - "src/drivers/lcd/**/*gc9b71*" - "src/drivers/lcd/**/*ili9341*" @@ -161,23 +123,23 @@ - "src/drivers/lcd/**/*st77916*" - "src/drivers/lcd/**/*st77922*" +.patterns-component_drivers_lcd_all: &patterns-component_drivers_lcd_all + - "src/drivers/lcd/**/*" + # component drivers-touch files .patterns-component_drivers_touch_general: &patterns-component_drivers_touch_general - - .patterns-component_drivers_general - "src/drivers/touch/port/esp_lcd_touch.*" - "src/drivers/touch/esp_panel_touch_conf_internal.h" - "src/drivers/touch/esp_panel_touch.*" - "src/drivers/touch/Kconfig.touch" .patterns-component_drivers_touch_spi: &patterns-component_drivers_touch_spi - - .patterns-component_drivers_touch_general - - .patterns-component_drivers_bus_spi - "src/drivers/touch/**/*stmpe610*" - "src/drivers/touch/**/*xpt2046*" .patterns-component_drivers_touch_i2c: &patterns-component_drivers_touch_i2c - - .patterns-component_drivers_touch_general - - .patterns-component_drivers_bus_i2c + - "src/drivers/touch/**/*axs15231b*" + - "src/drivers/touch/**/*chsc6540*" - "src/drivers/touch/**/*cst816s*" - "src/drivers/touch/**/*ft5x06*" - "src/drivers/touch/**/*gt911*" @@ -187,56 +149,40 @@ - "src/drivers/touch/**/*st7123*" - "src/drivers/touch/**/*tt21100*" -# component drivers-all files -.patterns-component_drivers_all: &patterns-component_drivers_all - - .patterns-component_drivers_backlight - - .patterns-component_drivers_bus - - .patterns-component_drivers_host - - .patterns-component_drivers_io_expander - - .patterns-component_drivers_lcd - - .patterns-component_drivers_touch - - "src/drivers/**/*" +.patterns-component_drivers_touch_all: &patterns-component_drivers_touch_all + - "src/drivers/touch/**/*" # component board files .patterns-component_board_general: &patterns-component_board_general - - .patterns-component_drivers_all - - .patterns-component_utils - "src/board/*.*" - - "src/board/Kconfig.*" .patterns-component_board_custom: &patterns-component_board_custom - - .patterns-component_board_general - "src/board/custom/**/*" .patterns-component_board_supported_elecrow: &patterns-component_board_supported_elecrow - - .patterns-component_board_general - "src/board/supported/elecrow/**/*" .patterns-component_board_supported_espressif: &patterns-component_board_supported_espressif - - .patterns-component_board_general - "src/board/supported/espressif/**/*" .patterns-component_board_supported_jingcai: &patterns-component_board_supported_jingcai - - .patterns-component_board_general - "src/board/supported/jingcai/**/*" .patterns-component_board_supported_m5stack: &patterns-component_board_supported_m5stack - - .patterns-component_board_general - "src/board/supported/m5stack/**/*" .patterns-component_board_supported_viewe: &patterns-component_board_supported_viewe - - .patterns-component_board_general - "src/board/supported/viewe/**/*" .patterns-component_board_supported_waveshare: &patterns-component_board_supported_waveshare - - .patterns-component_board_general - "src/board/supported/waveshare/**/*" +.patterns-component_board_supported_all: &patterns-component_board_supported_all + - "src/board/supported/**/*" + # component all files .patterns-component_all: &patterns-component_all - - .patterns-component_utils - - .patterns-component_drivers_all - - .patterns-component_board_all + - "src/**/*" # docs files .patterns-docs_md: &patterns-docs_md @@ -247,23 +193,18 @@ - "test_apps/common_components/lcd_general_test/**/*" .patterns-test_apps_drivers_lcd_3wire_spi_rgb: &patterns-test_apps_drivers_lcd_3wire_spi_rgb - - .patterns-test_apps_drivers_lcd_general - "test_apps/drivers/lcd/3wire_spi_rgb/**/*" .patterns-test_apps_drivers_lcd_mipi_dsi: &patterns-test_apps_drivers_lcd_mipi_dsi - - .patterns-test_apps_drivers_lcd_general - "test_apps/drivers/lcd/mipi_dsi/**/*" .patterns-test_apps_drivers_lcd_qspi: &patterns-test_apps_drivers_lcd_qspi - - .patterns-test_apps_drivers_lcd_general - "test_apps/drivers/lcd/qspi/**/*" .patterns-test_apps_drivers_lcd_rgb: &patterns-test_apps_drivers_lcd_rgb - - .patterns-test_apps_drivers_lcd_general - "test_apps/drivers/lcd/rgb/**/*" .patterns-test_apps_drivers_lcd_spi: &patterns-test_apps_drivers_lcd_spi - - .patterns-test_apps_drivers_lcd_general - "test_apps/drivers/lcd/spi/**/*" # test_apps touch files @@ -271,49 +212,35 @@ - "test_apps/common_components/touch_general_test/**/*" .patterns-test_apps_drivers_touch_i2c: &patterns-test_apps_drivers_touch_i2c - - .patterns-test_apps_drivers_touch_general - "test_apps/drivers/touch/i2c/**/*" .patterns-test_apps_drivers_touch_spi: &patterns-test_apps_drivers_touch_spi - - .patterns-test_apps_drivers_touch_general - "test_apps/drivers/touch/spi/**/*" # test_apps board files -.patterns-test_apps_board_general: &patterns-test_apps_board_general - - .patterns-test_apps_drivers_lcd_general - - .patterns-test_apps_drivers_touch_general - .patterns-test_apps_board_common: &patterns-test_apps_board_common - - .patterns-test_apps_board_general - "test_apps/board/common/**/*" .patterns-test_apps_board_elecrow: &patterns-test_apps_board_elecrow - - .patterns-test_apps_board_general - "test_apps/board/elecrow/**/*" .patterns-test_apps_board_espressif: &patterns-test_apps_board_espressif - - .patterns-test_apps_board_general - "test_apps/board/espressif/**/*" .patterns-test_apps_board_jingcai: &patterns-test_apps_board_jingcai - - .patterns-test_apps_board_general - "test_apps/board/jingcai/**/*" .patterns-test_apps_board_m5stack: &patterns-test_apps_board_m5stack - - .patterns-test_apps_board_general - "test_apps/board/m5stack/**/*" .patterns-test_apps_board_viewe: &patterns-test_apps_board_viewe - - .patterns-test_apps_board_general - "test_apps/board/viewe/**/*" .patterns-test_apps_board_waveshare: &patterns-test_apps_board_waveshare - - .patterns-test_apps_board_general - "test_apps/board/waveshare/**/*" # test_apps gui files .patterns-test_apps_gui_lvgl_v8_port: &patterns-test_apps_gui_lvgl_v8_port - - .patterns-test_apps_board_general - "test_apps/gui/lvgl_v8_port/**/*" ############## @@ -363,8 +290,22 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_3wire_spi_rgb + - <<: *if-dev-push + changes: *patterns-component_drivers_lcd_general - <<: *if-dev-push changes: *patterns-component_drivers_lcd_3wire_spi_rgb + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_lcd_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_lcd_3wire_spi_rgb @@ -376,8 +317,26 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_dsi + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_dsi + - <<: *if-dev-push + changes: *patterns-component_drivers_lcd_general - <<: *if-dev-push changes: *patterns-component_drivers_lcd_mipi_dsi + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_lcd_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_lcd_mipi_dsi @@ -389,8 +348,26 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_spi + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_qspi + - <<: *if-dev-push + changes: *patterns-component_drivers_lcd_general - <<: *if-dev-push changes: *patterns-component_drivers_lcd_qspi + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_lcd_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_lcd_qspi @@ -402,8 +379,22 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_rgb + - <<: *if-dev-push + changes: *patterns-component_drivers_lcd_general - <<: *if-dev-push changes: *patterns-component_drivers_lcd_rgb + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_lcd_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_lcd_rgb @@ -415,8 +406,26 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_spi + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_spi + - <<: *if-dev-push + changes: *patterns-component_drivers_lcd_general - <<: *if-dev-push changes: *patterns-component_drivers_lcd_spi + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_lcd_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_lcd_spi @@ -429,8 +438,26 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_i2c + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_i2c + - <<: *if-dev-push + changes: *patterns-component_drivers_touch_general - <<: *if-dev-push changes: *patterns-component_drivers_touch_i2c + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_touch_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_touch_i2c @@ -442,8 +469,26 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_general + - <<: *if-dev-push + changes: *patterns-component_utils_all + - <<: *if-dev-push + changes: *patterns-component_drivers_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_general + - <<: *if-dev-push + changes: *patterns-component_drivers_host_spi + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_general + - <<: *if-dev-push + changes: *patterns-component_drivers_bus_spi + - <<: *if-dev-push + changes: *patterns-component_drivers_touch_general - <<: *if-dev-push changes: *patterns-component_drivers_touch_spi + - <<: *if-dev-push + changes: *patterns-test_apps_drivers_touch_general - <<: *if-dev-push changes: *patterns-test_apps_drivers_touch_spi @@ -458,6 +503,8 @@ changes: *patterns-build_system - <<: *if-dev-push changes: *patterns-component_all + - <<: *if-dev-push + changes: *patterns-component_board_general - <<: *if-dev-push changes: *patterns-test_apps_board_common @@ -549,6 +596,8 @@ - <<: *if-trigger-job - <<: *if-dev-push changes: *patterns-build_system + - <<: *if-dev-push + changes: *patterns-component_all - <<: *if-dev-push changes: *patterns-component_board_general - <<: *if-dev-push diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e20554f..44ee4c1b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # ChangeLog +## v1.0.1 - 2025-02-19 + +### Bugfixes: + +* fix(touch): avoid reading the button state when disabled (#162) +* fix(docs): correct and add descriptions + ## v1.0.0 - 2025-02-17 ### Breaking changes: diff --git a/docs/envs/use_with_arduino.md b/docs/envs/use_with_arduino.md index e87086dd..dae5ab7d 100644 --- a/docs/envs/use_with_arduino.md +++ b/docs/envs/use_with_arduino.md @@ -49,9 +49,11 @@ - Open Arduino IDE - Navigate to `File` > `Preferences` - Add to `Additional boards manager URLs`: - ``` - https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json - ``` + + ``` + https://espressif.github.io/arduino-esp32/package_esp32_index.json + ``` + - Navigate to `Tools` > `Board` > `Boards Manager` - Search for `esp32` by `Espressif Systems` and install the required version (see [SDK & Dependencies](#sdk--dependencies)) @@ -65,7 +67,7 @@ 1. **Select and Configure Board** -- Navigate to `Tools` > `Board` > `ESP32` +- Navigate to `Tools` > `Board` > `esp32` - Select your board model. If you can't find a matching model, refer to: - If using a [supported board](../../README.md#supported-boards), see [Configuring Arduino IDE](#configuring-arduino-ide) @@ -74,7 +76,7 @@ 2. **Open Example** - Navigate to `File` > `Examples` > `ESP32_Display_Panel` -- Select `Board` > [`board_static_config`](../../examples/arduino/board/board_static_config/) +- Select `Arduino` > `board` > [`board_static_config`](../../examples/arduino/board/board_static_config/) 3. **Modify Code** diff --git a/docs/envs/use_with_arduino_cn.md b/docs/envs/use_with_arduino_cn.md index 9a55b32d..f51c1453 100644 --- a/docs/envs/use_with_arduino_cn.md +++ b/docs/envs/use_with_arduino_cn.md @@ -49,9 +49,11 @@ - 打开 Arduino IDE - 导航到 `File` > `Preferences` - 在 `Additional boards manager URLs` 中添加: - ``` - https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json - ``` + + ``` + https://espressif.github.io/arduino-esp32/package_esp32_index.json + ``` + - 导航到 `Tools` > `Board` > `Boards Manager` - 搜索 `esp32` by `Espressif Systems` 并安装符合要求的版本（参阅 [SDK 及依赖库](#sdk-及依赖库)） @@ -65,7 +67,7 @@ 1. **选择和配置开发板** -- 导航到 `Tools` > `Board` > `ESP32` +- 导航到 `Tools` > `Board` > `esp32` - 选择您的开发板型号。如果未找到匹配的型号，请参考以下信息： * 如果您正在使用 [支持的开发板](../../README_CN.md#支持的开发板)，可以参阅 [配置 Arduino IDE](#配置-arduino-ide) @@ -74,7 +76,7 @@ 2. **打开示例** - 导航到 `File` > `Examples` > `ESP32_Display_Panel` -- 选择 `Board` > [`board_static_config`](../../examples/arduino/board/board_static_config/) +- 选择 `Arduino` > `board` > [`board_static_config`](../../examples/arduino/board/board_static_config/) 3. **修改代码** diff --git a/examples/arduino/drivers/lcd/lcd_single_rgb/lcd_single_rgb.ino b/examples/arduino/drivers/lcd/lcd_single_rgb/lcd_single_rgb.ino index c530ee1e..f1af1b3d 100644 --- a/examples/arduino/drivers/lcd/lcd_single_rgb/lcd_single_rgb.ino +++ b/examples/arduino/drivers/lcd/lcd_single_rgb/lcd_single_rgb.ino @@ -13,8 +13,8 @@ using namespace esp_panel::drivers; //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// /** * Currently, the library supports the following RGB (without 3-wire SPI) LCDs: - * - ST7262 * - EK9716B + * - ST7262 */ #define EXAMPLE_LCD_NAME ST7262 #define EXAMPLE_LCD_WIDTH (800) diff --git a/examples/platformio/lvgl_v8_port/README.md b/examples/platformio/lvgl_v8_port/README.md index f70a2f4e..b3e25b6a 100644 --- a/examples/platformio/lvgl_v8_port/README.md +++ b/examples/platformio/lvgl_v8_port/README.md @@ -13,7 +13,7 @@ This example demonstrates how to port `LVGL v8`. And for `RGB/MIPI-DSI` interfac - [Optional] `ESP32_Display_Panel`: - - This example already has the [esp_panel_drivers_conf.h](./src/esp_panel_drivers_conf.h) configuration file in the project directory. Edit this file as needed + - This example already has the [esp_panel_board_custom_conf.h](./src/esp_panel_board_custom_conf.h) and [esp_panel_drivers_conf.h](./src/esp_panel_drivers_conf.h) configuration files in the project directory. Edit these files as needed - see [Board Configuration Guide](../../../docs/envs/use_with_arduino.md#configuration-guide) for more information - [Optional] `esp-lib-utils` : @@ -65,6 +65,7 @@ This example demonstrates how to port `LVGL v8`. And for `RGB/MIPI-DSI` interfac - Modify the [BOARD_CUSTOM.json](./boards/BOARD_CUSTOM.json) board file by referring to a supported board file which has the same chip as your board. - Modify the `[env:BOARD_CUSTOM]` board env in the *platformio.ini* file as needed + - Modify the *esp_panel_board_custom_conf.h* file and set `ESP_PANEL_BOARD_DEFAULT_USE_CUSTOM` to `1`. Then change other configurations as needed in the file - See [PlatformIO Docs](https://docs.platformio.org/en/latest/projectconf/index.html) for more information diff --git a/idf_component.yml b/idf_component.yml index 44dd6619..2b04706c 100644 --- a/idf_component.yml +++ b/idf_component.yml @@ -1,4 +1,4 @@ -version: "1.0.0" +version: "1.0.1" description: ESP32_Display_Panel is a display driver and GUI porting library designed by Espressif specifically for ESP series SoCs (ESP32, ESP32-S3, ESP32-P4, etc.) url: https://github.com/esp-arduino-libs/ESP32_Display_Panel repository: https://github.com/esp-arduino-libs/ESP32_Display_Panel.git diff --git a/library.properties b/library.properties index 823a9220..2733fd27 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=ESP32_Display_Panel -version=1.0.0 +version=1.0.1 author=espressif maintainer=espressif sentence=ESP32_Display_Panel is a display driver and GUI porting library designed by Espressif specifically for ESP series SoCs (ESP32, ESP32-S3, ESP32-P4, etc.) diff --git a/src/esp_panel_versions.h b/src/esp_panel_versions.h index 65ba696c..9dabc7ea 100644 --- a/src/esp_panel_versions.h +++ b/src/esp_panel_versions.h @@ -8,7 +8,7 @@ /* Library Version */ #define ESP_PANEL_VERSION_MAJOR 1 #define ESP_PANEL_VERSION_MINOR 0 -#define ESP_PANEL_VERSION_PATCH 0 +#define ESP_PANEL_VERSION_PATCH 1 /* File `esp_panel_drivers_conf.h` */ #define ESP_PANEL_DRIVERS_CONF_VERSION_MAJOR 1