feat(lvgl_port): Update LVGL port for using button v4 (breaking change!)

espzav · espzav · commit 96e5b852235b · 2025-02-17T14:32:05.000+01:00
diff --git a/bsp/esp32_c3_lcdkit/esp32_c3_lcdkit.c b/bsp/esp32_c3_lcdkit/esp32_c3_lcdkit.c
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -23,6 +23,7 @@
 #include "bsp_err_check.h"
 #include "esp_lcd_gc9a01.h"
 #include "iot_knob.h"
+#include "button_gpio.h"
 #include "esp_lvgl_port.h"
 #include "esp_codec_dev_defaults.h"
 
@@ -78,10 +79,9 @@ static const led_strip_rmt_config_t bsp_rmt_config = {
     .flags.with_dma = false,
 };
 
-static const button_config_t bsp_encoder_btn_config = {
-    .type = BUTTON_TYPE_GPIO,
-    .gpio_button_config.active_level = false,
-    .gpio_button_config.gpio_num = BSP_BTN_PRESS,
+static const button_gpio_config_t bsp_encoder_btn_config = {
+    .gpio_num = BSP_BTN_PRESS,
+    .active_level = 0,
 };
 
 static const knob_config_t bsp_encoder_a_b_config = {
@@ -241,10 +241,15 @@ static lv_display_t *bsp_display_lcd_init(const bsp_display_cfg_t *cfg)
 
 static lv_indev_t *bsp_display_indev_init(lv_display_t *disp)
 {
+
+    const button_config_t btn_cfg = {0};
+    button_handle_t encoder_btn = NULL;
+    BSP_ERROR_CHECK_RETURN_NULL(iot_button_new_gpio_device(&btn_cfg, &bsp_encoder_btn_config, &encoder_btn));
+
     const lvgl_port_encoder_cfg_t encoder = {
         .disp = disp,
         .encoder_a_b = &bsp_encoder_a_b_config,
-        .encoder_enter = &bsp_encoder_btn_config
+        .encoder_enter = encoder_btn
     };
 
     return lvgl_port_add_encoder(&encoder);
diff --git a/bsp/esp32_c3_lcdkit/idf_component.yml b/bsp/esp32_c3_lcdkit/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.1.0~1"
+version: "1.2.0"
 description: Board Support Package (BSP) for esp32_c3_lcdkit
 url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp32_c3_lcdkit
 
@@ -26,7 +26,7 @@ dependencies:
 
   button:
     public: true
-    version: ">=2,<4.0"
+    version: ">=4,<5.0"
 
   knob:
     version: "^0.1.3"
diff --git a/bsp/m5dial/README.md b/bsp/m5dial/README.md
@@ -25,7 +25,7 @@ M5Dial provides versatile power supply options to cater to various needs. It acc
 |   DISPLAY   |:heavy_check_mark:|      [espressif/esp_lcd_gc9a01](https://components.espressif.com/components/espressif/esp_lcd_gc9a01)      |   ^1   |
 |  LVGL_PORT  |:heavy_check_mark:|       [espressif/esp_lvgl_port](https://components.espressif.com/components/espressif/esp_lvgl_port)       |   ^2   |
 |    TOUCH    |:heavy_check_mark:|[espressif/esp_lcd_touch_ft5x06](https://components.espressif.com/components/espressif/esp_lcd_touch_ft5x06)|   ^1   |
-|   BUTTONS   |:heavy_check_mark:|              [espressif/button](https://components.espressif.com/components/espressif/button)              |>=2,<4.0|
+|   BUTTONS   |:heavy_check_mark:|              [espressif/button](https://components.espressif.com/components/espressif/button)              |>=4,<5.0|
 |     KNOB    |:heavy_check_mark:|                [espressif/knob](https://components.espressif.com/components/espressif/knob)                | ^0.1.3 |
 |    AUDIO    |        :x:       |                                                                                                            |        |
 |AUDIO_SPEAKER|        :x:       |                                                                                                            |        |
diff --git a/bsp/m5dial/idf_component.yml b/bsp/m5dial/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.0.0"
+version: "1.1.0"
 description: Board Support Package (BSP) for M5Dial
 url: https://github.com/espressif/esp-bsp/tree/master/bsp/m5dial
 
@@ -16,10 +16,11 @@ dependencies:
   espressif/esp_lvgl_port:
     version: "^2"
     public: true
+    override_path: "../../components/esp_lvgl_port"
 
   button:
     public: true
-    version: ">=2,<4.0"
+    version: ">=4,<5.0"
 
   knob:
     version: "^0.1.3"
diff --git a/bsp/m5dial/m5dial.c b/bsp/m5dial/m5dial.c
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -21,6 +21,7 @@
 #include "bsp/display.h"
 #include "bsp/touch.h"
 #include "iot_knob.h"
+#include "button_gpio.h"
 #include "esp_lcd_gc9a01.h"
 #include "esp_lcd_touch_ft5x06.h"
 #include "esp_lvgl_port.h"
@@ -37,10 +38,9 @@ static esp_lcd_touch_handle_t tp;   // LCD touch handle
 static bool i2c_initialized = false;
 static bool spi_initialized = false;
 
-static const button_config_t bsp_encoder_btn_config = {
-    .type = BUTTON_TYPE_GPIO,
-    .gpio_button_config.active_level = false,
-    .gpio_button_config.gpio_num = BSP_BTN_PRESS,
+static const button_gpio_config_t bsp_encoder_btn_config = {
+    .gpio_num = BSP_BTN_PRESS,
+    .active_level = 0,
 };
 
 static const knob_config_t bsp_encoder_a_b_config = {
@@ -307,10 +307,15 @@ static lv_display_t *bsp_display_lcd_init(const bsp_display_cfg_t *cfg)
 
 static lv_indev_t *bsp_display_indev_encoder_init(lv_display_t *disp)
 {
+
+    const button_config_t btn_cfg = {0};
+    button_handle_t encoder_btn = NULL;
+    BSP_ERROR_CHECK_RETURN_NULL(iot_button_new_gpio_device(&btn_cfg, &bsp_encoder_btn_config, &encoder_btn));
+
     const lvgl_port_encoder_cfg_t encoder = {
         .disp = disp,
         .encoder_a_b = &bsp_encoder_a_b_config,
-        .encoder_enter = &bsp_encoder_btn_config
+        .encoder_enter = encoder_btn
     };
 
     return lvgl_port_add_encoder(&encoder);
diff --git a/bsp/m5stack_core/README.md b/bsp/m5stack_core/README.md
@@ -30,15 +30,15 @@ M5Stack Core is a development board based on ESP32 microcontroller. It features:
 
 <!-- Autogenerated start: Dependencies -->
 ### Capabilities and dependencies
-|  Capability |     Available    |                                             Component                                            |Version|
-|-------------|------------------|--------------------------------------------------------------------------------------------------|-------|
-|   DISPLAY   |:heavy_check_mark:|[espressif/esp_lcd_ili9341](https://components.espressif.com/components/espressif/esp_lcd_ili9341)|   ^1  |
-|  LVGL_PORT  |:heavy_check_mark:|  [espressif/esp_lvgl_port](https://components.espressif.com/components/espressif/esp_lvgl_port)  |   ^2  |
-|    TOUCH    |        :x:       |                                                                                                  |       |
-|   BUTTONS   |:heavy_check_mark:|         [espressif/button](https://components.espressif.com/components/espressif/button)         |  ^2.4 |
-|    AUDIO    |        :x:       |                                                                                                  |       |
-|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                                  |       |
-|  AUDIO_MIC  |        :x:       |                                                                                                  |       |
-|    SDCARD   |:heavy_check_mark:|                                                idf                                               | >=5.2 |
-|     IMU     |        :x:       |                                                                                                  |       |
+|  Capability |     Available    |                                             Component                                            | Version|
+|-------------|------------------|--------------------------------------------------------------------------------------------------|--------|
+|   DISPLAY   |:heavy_check_mark:|[espressif/esp_lcd_ili9341](https://components.espressif.com/components/espressif/esp_lcd_ili9341)|   ^1   |
+|  LVGL_PORT  |:heavy_check_mark:|  [espressif/esp_lvgl_port](https://components.espressif.com/components/espressif/esp_lvgl_port)  |   ^2   |
+|    TOUCH    |        :x:       |                                                                                                  |        |
+|   BUTTONS   |:heavy_check_mark:|         [espressif/button](https://components.espressif.com/components/espressif/button)         |>=4,<5.0|
+|    AUDIO    |        :x:       |                                                                                                  |        |
+|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                                  |        |
+|  AUDIO_MIC  |        :x:       |                                                                                                  |        |
+|    SDCARD   |:heavy_check_mark:|                                                idf                                               |  >=5.2 |
+|     IMU     |        :x:       |                                                                                                  |        |
 <!-- Autogenerated end: Dependencies -->
diff --git a/bsp/m5stack_core/idf_component.yml b/bsp/m5stack_core/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.0.0"
+version: "1.1.0"
 description: Board Support Package (BSP) for M5Stack Core
 url: https://github.com/espressif/esp-bsp/tree/master/bsp/m5stack_core
 
@@ -13,9 +13,10 @@ dependencies:
   esp_lcd_ili9341: "^1"
 
   button:
-    version: "^2.4"
+    version: ">=4,<5.0"
     public: true
-  
+
   espressif/esp_lvgl_port:
     version: "^2"
     public: true
+    override_path: "../../components/esp_lvgl_port"
diff --git a/bsp/m5stack_core/m5stack_core.c b/bsp/m5stack_core/m5stack_core.c
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -25,6 +25,7 @@
 #include "bsp/display.h"
 #include "esp_lcd_ili9341.h"
 #include "bsp_err_check.h"
+#include "button_gpio.h"
 
 static const char *TAG = "M5Stack";
 
@@ -363,31 +364,36 @@ static lv_display_t *bsp_display_lcd_init(const bsp_display_cfg_t *cfg)
     return lvgl_port_add_disp(&disp_cfg);
 }
 
-static const button_config_t bsp_button_config[BSP_BUTTON_NUM] = {
+static const button_gpio_config_t bsp_button_config[BSP_BUTTON_NUM] = {
     {
-        .type = BUTTON_TYPE_GPIO,
-        .gpio_button_config.active_level = false,
-        .gpio_button_config.gpio_num = BSP_BUTTON_LEFT,
+        .gpio_num = BSP_BUTTON_LEFT,
+        .active_level = 0,
     },
     {
-        .type = BUTTON_TYPE_GPIO,
-        .gpio_button_config.active_level = false,
-        .gpio_button_config.gpio_num = BSP_BUTTON_MIDDLE,
+        .gpio_num = BSP_BUTTON_MIDDLE,
+        .active_level = 0,
     },
     {
-        .type = BUTTON_TYPE_GPIO,
-        .gpio_button_config.active_level = false,
-        .gpio_button_config.gpio_num = BSP_BUTTON_RIGHT,
+        .gpio_num = BSP_BUTTON_RIGHT,
+        .active_level = 0,
     },
 };
 
 static lv_indev_t *bsp_display_indev_init(lv_display_t *disp)
 {
+    const button_config_t btn_cfg = {0};
+    button_handle_t prev_btn = NULL;
+    button_handle_t next_btn = NULL;
+    button_handle_t enter_btn = NULL;
+    BSP_ERROR_CHECK_RETURN_NULL(iot_button_new_gpio_device(&btn_cfg, &bsp_button_config[BSP_BUTTON_PREV], &prev_btn));
+    BSP_ERROR_CHECK_RETURN_NULL(iot_button_new_gpio_device(&btn_cfg, &bsp_button_config[BSP_BUTTON_NEXT], &next_btn));
+    BSP_ERROR_CHECK_RETURN_NULL(iot_button_new_gpio_device(&btn_cfg, &bsp_button_config[BSP_BUTTON_ENTER], &enter_btn));
+
     const lvgl_port_nav_btns_cfg_t btns = {
         .disp = disp,
-        .button_prev = &bsp_button_config[BSP_BUTTON_PREV],
-        .button_next = &bsp_button_config[BSP_BUTTON_NEXT],
-        .button_enter = &bsp_button_config[BSP_BUTTON_ENTER]
+        .button_prev = prev_btn,
+        .button_next = next_btn,
+        .button_enter = enter_btn
     };
 
     return lvgl_port_add_navigation_buttons(&btns);
@@ -455,8 +461,9 @@ esp_err_t bsp_iot_button_create(button_handle_t btn_array[], int *btn_cnt, int b
     if (btn_cnt) {
         *btn_cnt = 0;
     }
+    const button_config_t btn_cfg = {0};
     for (int i = 0; i < BSP_BUTTON_NUM; i++) {
-        btn_array[i] = iot_button_create(&bsp_button_config[i]);
+        ret |= iot_button_new_gpio_device(&btn_cfg, &bsp_button_config[i], &btn_array[i]);
         if (btn_array[i] == NULL) {
             ret = ESP_FAIL;
             break;
diff --git a/components/esp_lvgl_port/CHANGELOG.md b/components/esp_lvgl_port/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## 2.5.0
 
 ### Features (Functional change for button v4 users)
+>>>>>>> d3e75e7 (feat(lvgl_port): Update LVGL port for using button v4 (breaking change!))
 - Updated LVGL port for using IoT button component v4 (LVGL port not anymore creating button, need to be created in app and included handle to LVGL port)
 
 ### Fixes
diff --git a/components/esp_lvgl_port/idf_component.yml b/components/esp_lvgl_port/idf_component.yml
@@ -1,4 +1,4 @@
-version: "2.4.4"
+version: "2.5.0"
 description: ESP LVGL port
 url: https://github.com/espressif/esp-bsp/tree/master/components/esp_lvgl_port
 dependencies:
diff --git a/examples/display_rotation/sdkconfig.bsp.m5stack_core b/examples/display_rotation/sdkconfig.bsp.m5stack_core
@@ -0,0 +1,25 @@
+# This file was generated using idf.py save-defconfig. It can be edited manually.
+# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
+#
+CONFIG_IDF_TARGET="esp32"
+CONFIG_ESPTOOLPY_FLASHSIZE_4MB=y
+CONFIG_ESP_DEFAULT_CPU_FREQ_240=y
+
+## LVGL8 ##
+CONFIG_LV_USE_PERF_MONITOR=y
+CONFIG_LV_COLOR_16_SWAP=y
+CONFIG_LV_MEM_CUSTOM=y
+CONFIG_LV_MEMCPY_MEMSET_STD=y
+
+## LVGL9 ##
+CONFIG_LV_CONF_SKIP=y
+
+#CLIB default
+CONFIG_LV_USE_CLIB_MALLOC=y
+CONFIG_LV_USE_CLIB_SPRINTF=y
+CONFIG_LV_USE_CLIB_STRING=y
+
+# Performance monitor
+CONFIG_LV_USE_OBSERVER=y
+CONFIG_LV_USE_SYSMON=y
+CONFIG_LV_USE_PERF_MONITOR=y

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "2.4.4"`
	`1`	`+version: "2.5.0"`
`2`	`2`	`description: ESP LVGL port`
`3`	`3`	`url: https://github.com/espressif/esp-bsp/tree/master/components/esp_lvgl_port`
`4`	`4`	`dependencies:`