From 28c328f5547d5f7e0eb906bf005e5a8fa10cb9e9 Mon Sep 17 00:00:00 2001
From: Edward Firmo <94725493+edwardtfn@users.noreply.github.com>
Date: Fri, 6 Dec 2024 12:17:00 +0100
Subject: [PATCH] Use ESP-IDF v5.1.5

---
 ReleaseNotes.md                              | 35 ++++++++++++++++++--
 docs/version_compatibility.md                |  2 +-
 esphome/nspanel_esphome_core_base.yaml       |  1 -
 esphome/nspanel_esphome_core_versioning.yaml | 13 ++++++--
 4 files changed, 44 insertions(+), 7 deletions(-)

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
index 5204165e..893dbf98 100644
--- a/ReleaseNotes.md
+++ b/ReleaseNotes.md
@@ -1,15 +1,44 @@
 # v4.4 - Dynamic QR Codes, Improved Usability, and More
 
 ## General
-Version 4.4 focuses on enhancing the usability and functionality of your NSPanel. The device page has been  
+Version 4.4 focuses on enhancing the usability and functionality of your NSPanel. The device page has been
 refined for a cleaner, more user-friendly experience, now allowing you to control the panel as a light.
 
-In addition to improved performance, this release introduces dynamic QR codes, automatic TFT updates, and  
+In addition to improved performance, this release introduces dynamic QR codes, automatic TFT updates, and
 new features like buzzer volume control and configurable wake-up settings, making your panel more versatile.
 
+## ESPHome Adopts ESP-IDF v5.1.5 (Starting in ESPHome v2024.12.0)
+With ESPHome v2024.12.0, the standard framework version has been updated from ESP-IDF v4.4.8 to v5.1.5.
+This update introduces significant improvements but also comes with considerations for memory usage.
+
+### Advantages of ESP-IDF v5.1.5
+- **Bug Fixes and Stability:**
+  The new version includes a wide range of bug fixes, enhancing system reliability and performance.
+- **Improved Features and Compatibility:**
+  Upgrades to the framework ensure better support for modern hardware and streamlined development processes.
+- **Enhanced Developer Experience:**
+  New debugging tools and improvements in the framework simplify the development and troubleshooting process.
+
+### Concerns and Impact
+- **Increased Memory Usage:**
+  ESP-IDF v5.1.5 requires slightly more memory, reducing the space available for additional features.
+  This may limit the scope of customizations or add-ons for users with resource-intensive setups.
+
+### NSPanel Preparedness
+We have fully tested the NSPanel setup with ESP-IDF v5.1.5 under ESPHome v2024.12.0 to ensure compatibility and smooth operation.
+While the increased memory footprint may impose some limitations, the improvements in stability and performance
+make this a beneficial upgrade for most users.
+
+### Recommendations
+- **Advanced Users:**
+  If you have a heavily customized configuration or multiple add-ons, consider reviewing your setup to ensure
+  it remains within the available memory constraints.
+- **All Users:**
+  Stay updated with ESPHome releases and monitor their compatibility notes to make the most of these enhancements.
+
 ## Breaking Changes and Guidance
 
-### Home Assistant v2024.11.0 and ESPHome v2024.11.0 are required
+### Home Assistant v2024.11.0 and ESPHome v2024.12.0 are required
 Refer to our  
 [Version Compatibility Matrix](https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/version_compatibility.md).
 
diff --git a/docs/version_compatibility.md b/docs/version_compatibility.md
index bedb349c..581892c7 100644
--- a/docs/version_compatibility.md
+++ b/docs/version_compatibility.md
@@ -3,7 +3,7 @@
 <!-- markdownlint-disable MD013 MD033 -->
 | NSPanel_HA_Blueprint<br><sub><sup>Version</sup></sub> | Home Assistant<br><sub><sup>Min version</sup></sub> | ESPHome<br><sub><sup>Min version</sup></sub> |
 | :--: | :--: | :--: |
-| v4.4.0 | 2024.11.0 | 2024.11.0 |
+| v4.4.0 | 2024.11.0 | 2024.12.0 |
 | v4.3.12<br>v4.3.11<br>v4.3.10<br>v4.3.9 | 2024.6.0 | 2024.6.0 |
 | v4.3.8 | 2024.6.0 | 2024.5.0 |
 | v4.3.7<br>v4.3.6<br>v4.3.5<br>v4.3.4<br>v4.3.3 | 2024.3.0 | 2023.12.0 |
diff --git a/esphome/nspanel_esphome_core_base.yaml b/esphome/nspanel_esphome_core_base.yaml
index dacb8c8c..2327bd70 100644
--- a/esphome/nspanel_esphome_core_base.yaml
+++ b/esphome/nspanel_esphome_core_base.yaml
@@ -40,7 +40,6 @@ esphome:
   name: ${name}
   friendly_name: ${friendly_name}
   comment: NSPanel HA Blueprint
-  min_version: 2024.8.0
   project:
     name: esphome.NSPanel_HA_Blueprint
   platformio_options:
diff --git a/esphome/nspanel_esphome_core_versioning.yaml b/esphome/nspanel_esphome_core_versioning.yaml
index 16d466b0..98f82d6f 100644
--- a/esphome/nspanel_esphome_core_versioning.yaml
+++ b/esphome/nspanel_esphome_core_versioning.yaml
@@ -11,12 +11,21 @@ substitutions:
   ##############################
   BOOT_STEP_VERSIONING: '26'
 
+#### REMOVE THIS FRAMEWORK SPECIFICATION WHEN ESPHOME 2024.12.0 IS RELEASED
+esp32:
+  framework:
+    type: esp-idf
+    version: 5.1.5
+    source: https://github.com/pioarduino/esp-idf/releases/download/v5.1.5/esp-idf-v5.1.5.zip
+    platform_version: https://github.com/pioarduino/platform-espressif32/releases/download/51.03.07/platform-espressif32.zip
+
 esphome:
+  min_version: 2024.11.0  ##### UPDATE THIS TO 2024.12.0 WHEN v2024.12.0 IS RELEASED AND FRAMEWORK ABOVE IS REMOVED
+  project:
+    version: "${version}"
   platformio_options:
     build_flags:
       - -D NSPANEL_HA_BLUEPRINT_CORE_VERSIONING
-  project:
-    version: "${version}"
 
 globals:
   - id: version_blueprint