Merge pull request #360 from espressif/fix/box_obsolesence

chore: Add obsolescence notices
espressif · Aug 8, 2024 · 4dabefc · 4dabefc
2 parents c903e51 + b5cd6ef
commit 4dabefc
Show file tree

Hide file tree

Showing 10 changed files with 48 additions and 40 deletions.
diff --git a/.build-test-rules.yml b/.build-test-rules.yml
@@ -1,5 +1,7 @@
 examples:
   disable:
+    - if: CONFIG_NAME in ["esp-box", "esp-box-lite"]
+      reason: Do not build examples for deprecated BSPs
     - if: IDF_VERSION_MAJOR < 5 and CONFIG_NAME in ["esp32_c3_lcdkit", "esp32_s3_lcd_ev_board", "esp32_s3_usb_otg", "m5stack_core_s3", "m5dial"]
       reason: Example depends on BSP, which is supported only for IDF >= 5.0
     - if: IDF_VERSION_MAJOR < 5 and IDF_TARGET in ["esp32c2", "esp32p4", "esp32c5", "esp32c6"]

diff --git a/bsp/esp-box-lite/README.md b/bsp/esp-box-lite/README.md
@@ -1,12 +1,13 @@
 # BSP: ESP-BOX-Lite
 
 [![Component Registry](https://components.espressif.com/components/espressif/esp-box-lite/badge.svg)](https://components.espressif.com/components/espressif/esp-box-lite)
+![maintenance-status](https://img.shields.io/badge/maintenance-as--is-yellow.svg)
 
-### Overview
+:warning: **ESP-BOX-Lite is deprecated. This BSP is provided as-is with no further development and compatibility maintenance**
 
-ESP32-S3-BOX-Lite is an AI voice development kit that is based on Espressif’s ESP32-S3 Wi-Fi + Bluetooth 5 (LE) SoC, with AI capabilities. In addition to ESP32-S3’s 512KB SRAM,
+### Overview
 
-ESP32-S3-BOX-Lite comes with 16MB of QSPI flash and 8MB of Octal PSRAM. It is also equipped with a variety of peripherals, such as a 2.4-inch display with a 320x240 resolution, a microphone, a speaker, and two Pmod™-compatible headers which allow for the extensibility of the hardware.
+ESP32-S3-BOX-Lite is an AI voice development kit that is based on Espressif’s ESP32-S3 Wi-Fi + Bluetooth 5 (LE) SoC, with AI capabilities. In addition to ESP32-S3’s 512KB SRAM, ESP32-S3-BOX-Lite comes with 16MB of QSPI flash and 8MB of Octal PSRAM. It is also equipped with a variety of peripherals, such as a 2.4-inch display with a 320x240 resolution, a microphone, a speaker, and two Pmod™-compatible headers which allow for the extensibility of the hardware.
 
 ESP32-S3-BOX-Lite also uses a Type-C USB connector that provides 5 V of power input, while also supporting serial and JTAG debugging, as well as a programming interface; all through the same connector.
 
@@ -16,15 +17,15 @@ ESP32-S3-BOX-Lite also uses a Type-C USB connector that provides 5 V of power in
 
 <!-- Autogenerated start: Dependencies -->
 ### Capabilities and dependencies
-|  Capability |     Available    |                                           Component                                          |Version|
-|-------------|------------------|----------------------------------------------------------------------------------------------|-------|
-|   DISPLAY   |:heavy_check_mark:|                                              idf                                             |>=4.4.5|
-|  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    |:heavy_check_mark:|[espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)| ^1.0.3|
-|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                              |       |
-|  AUDIO_MIC  |:heavy_check_mark:|                                                                                              |       |
-|    SDCARD   |        :x:       |                                                                                              |       |
-|     IMU     |        :x:       |                                                                                              |       |
+|  Capability |     Available    |                                           Component                                          |   Version  |
+|-------------|------------------|----------------------------------------------------------------------------------------------|------------|
+|   DISPLAY   |:heavy_check_mark:|                                              idf                                             |>=4.4.5,<6.0|
+|  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    |:heavy_check_mark:|[espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)|    ~1.1    |
+|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                              |            |
+|  AUDIO_MIC  |:heavy_check_mark:|                                                                                              |            |
+|    SDCARD   |        :x:       |                                                                                              |            |
+|     IMU     |        :x:       |                                                                                              |            |
 <!-- Autogenerated end: Dependencies -->
diff --git a/bsp/esp-box-lite/idf_component.yml b/bsp/esp-box-lite/idf_component.yml
@@ -1,4 +1,4 @@
-version: "2.1.0"
+version: "2.1.0~1"
 description: Board Support Package (BSP) for ESP32-S3-BOX-Lite
 url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp-box-lite
 
@@ -9,10 +9,10 @@ tags:
   - bsp
 
 dependencies:
-  idf: ">=4.4.5"
+  idf: ">=4.4.5,<6.0"
 
   button:
-    version: ">=2.4"
+    version: "^2.4"
     public: true
 
   espressif/esp_lvgl_port:
@@ -21,5 +21,5 @@ dependencies:
     override_path: "../../components/esp_lvgl_port"
 
   esp_codec_dev:
-    version: "^1.0.3"
+    version: "~1.1"
     public: true
diff --git a/bsp/esp-box/README.md b/bsp/esp-box/README.md
@@ -1,6 +1,9 @@
 # BSP: ESP-BOX
 
 [![Component Registry](https://components.espressif.com/components/espressif/esp-box/badge.svg)](https://components.espressif.com/components/espressif/esp-box)
+![maintenance-status](https://img.shields.io/badge/maintenance-as--is-yellow.svg)
+
+:warning: **ESP-BOX is deprecated. This BSP is provided as-is with no further development and compatibility maintenance**
 
 ### Overview
 
@@ -16,15 +19,15 @@ ESP32-S3-BOX also uses a Type-C USB connector that provides 5 V of power input,
 
 <!-- Autogenerated start: Dependencies -->
 ### Capabilities and dependencies
-|  Capability |     Available    |                                                   Component                                                  |Version|
-|-------------|------------------|--------------------------------------------------------------------------------------------------------------|-------|
-|   DISPLAY   |:heavy_check_mark:|                                                      idf                                                     |>=4.4.5|
-|  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_tt21100](https://components.espressif.com/components/espressif/esp_lcd_touch_tt21100)|   ^1  |
-|   BUTTONS   |:heavy_check_mark:|               [espressif/button](https://components.espressif.com/components/espressif/button)               | >=2.5 |
-|    AUDIO    |:heavy_check_mark:|        [espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)        | ^1.0.3|
-|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                                              |       |
-|  AUDIO_MIC  |:heavy_check_mark:|                                                                                                              |       |
-|    SDCARD   |        :x:       |                                                                                                              |       |
-|     IMU     |:heavy_check_mark:|             [espressif/icm42670](https://components.espressif.com/components/espressif/icm42670)             |   ^1  |
+|  Capability |     Available    |                                                   Component                                                  |   Version  |
+|-------------|------------------|--------------------------------------------------------------------------------------------------------------|------------|
+|   DISPLAY   |:heavy_check_mark:|                                                      idf                                                     |>=4.4.5,<6.0|
+|  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_tt21100](https://components.espressif.com/components/espressif/esp_lcd_touch_tt21100)|     ^1     |
+|   BUTTONS   |:heavy_check_mark:|               [espressif/button](https://components.espressif.com/components/espressif/button)               |    ^2.5    |
+|    AUDIO    |:heavy_check_mark:|        [espressif/esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)        |    ~1.1    |
+|AUDIO_SPEAKER|:heavy_check_mark:|                                                                                                              |            |
+|  AUDIO_MIC  |:heavy_check_mark:|                                                                                                              |            |
+|    SDCARD   |        :x:       |                                                                                                              |            |
+|     IMU     |:heavy_check_mark:|             [espressif/icm42670](https://components.espressif.com/components/espressif/icm42670)             |     ^1     |
 <!-- Autogenerated end: Dependencies -->
diff --git a/bsp/esp-box/idf_component.yml b/bsp/esp-box/idf_component.yml
@@ -1,5 +1,5 @@
 
-version: "3.1.0"
+version: "3.1.0~1"
 description: Board Support Package (BSP) for ESP-BOX
 url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp-box
 
@@ -10,7 +10,7 @@ tags:
   - bsp
 
 dependencies:
-  idf: ">=4.4.5"
+  idf: ">=4.4.5,<6.0"
   esp_lcd_touch_tt21100: "^1"
 
   espressif/esp_lvgl_port:
@@ -19,11 +19,11 @@ dependencies:
     override_path: "../../components/esp_lvgl_port"
 
   esp_codec_dev:
-    version: "^1.0.3"
+    version: "~1.1"
     public: true
 
   button:
-    version: ">=2.5"
+    version: "^2.5"
     public: true
 
   icm42670:

diff --git a/components/es7210/README.md b/components/es7210/README.md
@@ -1,6 +1,7 @@
 # Component: ES7210
 
 [![Component Registry](https://components.espressif.com/components/espressif/es7210/badge.svg)](https://components.espressif.com/components/espressif/es7210)
+![maintenance-status](https://img.shields.io/badge/maintenance-deprecated-red.svg)
 
 :warning: **This driver is deprecated. Please use codec drivers from [esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)**
 

diff --git a/components/es7210/idf_component.yml b/components/es7210/idf_component.yml
@@ -1,6 +1,6 @@
-version: 1.0.1
+version: "1.0.1~1"
 dependencies:
   idf:
-    version: '>=4.4'
+    version: '>=4.4,<6.0'
 description: ES7210 is a high performance four channels audio ADC
 url: https://github.com/espressif/esp-bsp/tree/master/components/es7210
diff --git a/components/es8311/README.md b/components/es8311/README.md
@@ -1,6 +1,7 @@
 # Component: ES8311
 
 [![Component Registry](https://components.espressif.com/components/espressif/es8311/badge.svg)](https://components.espressif.com/components/espressif/es8311)
+![maintenance-status](https://img.shields.io/badge/maintenance-deprecated-red.svg)
 
 :warning: **This driver is deprecated. Please use codec drivers from [esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)**
 

diff --git a/components/es8311/idf_component.yml b/components/es8311/idf_component.yml
@@ -1,5 +1,5 @@
-version: "1.0.0"
+version: "1.0.0~1"
 description: Low power mono audio codec ES8311
 url: https://github.com/espressif/esp-bsp/tree/master/components/es8311
 dependencies:
-  idf : ">=4.4"
+  idf : ">=4.4,<6.0"
diff --git a/test_app/CMakeLists.txt b/test_app/CMakeLists.txt
@@ -3,11 +3,11 @@
 cmake_minimum_required(VERSION 3.5)
 
 set(EXTRA_COMPONENT_DIRS "../components")
-set(EXCLUDE_COMPONENTS "")
+set(EXCLUDE_COMPONENTS "es8311 es7210") # Deprecated components
 
 include($ENV{IDF_PATH}/tools/cmake/version.cmake) # $ENV{IDF_VERSION} was added after v4.3...
 
-# Components only for IDF5.0 and greater 
+# Components only for IDF5.0 and greater
 if("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_LESS "5.0")
     list(APPEND EXCLUDE_COMPONENTS "esp_lcd_touch_stmpe610" "ds18b20" "esp_lcd_ssd1681")
 elseif("${IDF_VERSION_MAJOR}.${IDF_VERSION_MINOR}" VERSION_LESS "5.3")
@@ -35,6 +35,6 @@ if(NOT "${IDF_TARGET}" STREQUAL "esp32s2" AND NOT "${IDF_TARGET}" STREQUAL "esp3
 endif()
 
 # Set the components to include the tests for.
-set(TEST_COMPONENTS bh1750 mpu6050 mag3110 hts221 fbm320 es7210 icm42670 CACHE STRING "List of components to test")
+set(TEST_COMPONENTS bh1750 mpu6050 mag3110 hts221 fbm320 icm42670 CACHE STRING "List of components to test")
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(esp_bsp_test_app)