Prepare BSP deprecation

Author: PetrESP

.pre-commit-config.yaml

@@ -49,6 +49,9 @@ repos:
         additional_dependencies:
           - idf_component_manager==2.4.1
           - py-markdown-table
+        # TODO: Remove this when removing these BSPs
+        exclude: '^.*/(esp-box|esp-box-lite|esp32_s2_kaluga_kit)/.*$'
+
 
   - repo: local
     hooks:

bsp/esp-box-lite/README.md

@@ -49,11 +49,11 @@ ESP32-S3-BOX-Lite also uses a Type-C USB connector that provides 5 V of power in
 
 | Example | Description | Try with ESP Launchpad |
 | ------- | ----------- | ---------------------- |
-| [Display Example](https://github.com/espressif/esp-bsp/tree/master/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
-| [Display, Audio and Photo Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo-) |
-| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
-| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
-| [Display Rotation Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_rotation) | Rotate screen using buttons or an accelerometer (`BSP_CAPS_IMU`, if available) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_rotation-) |
+| [Display Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
+| [Display, Audio and Photo Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo-) |
+| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
+| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
+| [Display Rotation Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_rotation) | Rotate screen using buttons or an accelerometer (`BSP_CAPS_IMU`, if available) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_rotation-) |
 
 <!-- END_EXAMPLES -->
 </div>

bsp/esp-box-lite/idf_component.yml

@@ -1,6 +1,6 @@
 version: "2.1.0~2"
 description: Board Support Package (BSP) for ESP32-S3-BOX-Lite
-url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp-box-lite
+url: https://github.com/espressif/esp-bsp/tree/deprecated/bsp/esp-box-lite
 
 targets:
   - esp32s3

bsp/esp-box/README.md

@@ -50,11 +50,11 @@ ESP32-S3-BOX also uses a Type-C USB connector that provides 5 V of power input,
 
 | Example | Description | Try with ESP Launchpad |
 | ------- | ----------- | ---------------------- |
-| [Display Example](https://github.com/espressif/esp-bsp/tree/master/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
-| [Display, Audio and Photo Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo-) |
-| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
-| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
-| [Display Rotation Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_rotation) | Rotate screen using buttons or an accelerometer (`BSP_CAPS_IMU`, if available) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_rotation-) |
+| [Display Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
+| [Display, Audio and Photo Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_audio_photo) | Complex demo: browse files from filesystem and play/display JPEG, WAV, or TXT files (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_audio_photo-) |
+| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
+| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
+| [Display Rotation Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_rotation) | Rotate screen using buttons or an accelerometer (`BSP_CAPS_IMU`, if available) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_rotation-) |
 
 <!-- END_EXAMPLES -->
 </div>

bsp/esp-box/idf_component.yml

@@ -1,7 +1,7 @@
 
 version: "3.1.0~2"
 description: Board Support Package (BSP) for ESP-BOX
-url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp-box
+url: https://github.com/espressif/esp-bsp/tree/deprecated/bsp/esp-box
 
 targets:
   - esp32s3

bsp/esp32_azure_iot_kit/idf_component.yml

@@ -1,6 +1,6 @@
 version: "3.0.0~2"
 description: Board Support Package (BSP) for ESP32-Azure-IoT-Kit
-url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp32_azure_iot_kit
+url: https://github.com/espressif/esp-bsp/tree/deprecated/bsp/esp32_azure_iot_kit
 
 targets:
     - esp32

bsp/esp32_s2_kaluga_kit/README.md

@@ -57,11 +57,11 @@ The ESP32-S2-Kaluga-1 kit v1.3 is a development kit by Espressif that is mainly
 
 | Example | Description | Try with ESP Launchpad |
 | ------- | ----------- | ---------------------- |
-| [Audio Example](https://github.com/espressif/esp-bsp/tree/master/examples/audio) | Play and record WAV file | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=audio-) |
-| [Display Example](https://github.com/espressif/esp-bsp/tree/master/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
-| [Camera Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_camera) | Stream camera output to display (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_camera-) |
-| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
-| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/master/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
+| [Audio Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/audio) | Play and record WAV file | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=audio-) |
+| [Display Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display) | Show an image on the screen with a simple startup animation (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display-) |
+| [Camera Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_camera) | Stream camera output to display (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_camera-) |
+| [LVGL Benchmark Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_benchmark) | Run LVGL benchmark tests | - |
+| [LVGL Demos Example](https://github.com/espressif/esp-bsp/tree/deprecated/examples/display_lvgl_demos) | Run the LVGL demo player - all LVGL examples are included (LVGL) | [Flash Example](https://espressif.github.io/esp-launchpad/?flashConfigURL=https://espressif.github.io/esp-bsp/config.toml&app=display_lvgl_demos-) |
 
 <!-- END_EXAMPLES -->
 </div>

bsp/esp32_s2_kaluga_kit/idf_component.yml

@@ -1,6 +1,6 @@
 version: "5.0.1~1"
 description: Board Support Package (BSP) for ESP32-S2-Kaluga kit
-url: https://github.com/espressif/esp-bsp/tree/master/bsp/esp32_s2_kaluga_kit
+url: https://github.com/espressif/esp-bsp/tree/deprecated/bsp/esp32_s2_kaluga_kit
 
 targets:
   - esp32s2