Merge pull request #2164 from Blackymas/beta

v4.3.9 - Ensuring Compatibility with ESPHome v2024.6.0
Blackymas · Jun 19, 2024 · 969ff58 · 969ff58
2 parents a152e9a + de8cdb4
commit 969ff58
Show file tree

Hide file tree

Showing 39 changed files with 203 additions and 215 deletions.
diff --git a/.github/workflows/validate_esphome.yml b/.github/workflows/validate_esphome.yml
@@ -123,7 +123,7 @@ jobs:
 
       - name: Firmware
         if: steps.matrix.outputs.cache-hit != 'true'
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -149,7 +149,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Advanced Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -172,7 +172,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build BLE Tracker Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -195,7 +195,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Bluetooth Proxy Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -221,7 +221,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Cool Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -247,7 +247,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Heat Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -273,7 +273,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Dual Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -298,7 +298,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Customizations Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -320,7 +320,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Customizations Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -347,7 +347,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Cover Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
 
@@ -360,33 +360,33 @@ jobs:
       - uses: actions/checkout@main
 
       - name: Build ESPHome Prebuilt Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: prebuilt/nspanel_esphome_prebuilt.yaml
 
       - name: Move and Rename Firmware File - nspanel_esphome_prebuilt
         run: |
           mkdir -p prebuilt
           cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware.bin prebuilt/nspanel_esphome_prebuilt.bin || true
-          cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware-factory.bin prebuilt/nspanel_esphome_prebuilt-factory.bin || true
+          cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware.factory.bin prebuilt/nspanel_esphome_prebuilt.factory.bin || true
 
       - name: Build ESPHome Prebuilt Wall Display Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: prebuilt/wall_display.yaml
 
       - name: Move and Rename Firmware File - wall_display
         run: |
           mkdir -p prebuilt
           cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware.bin prebuilt/wall_display.bin || true
-          cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware-factory.bin prebuilt/wall_display-factory.bin || true
+          cp prebuilt/.esphome/build/nspanel/.pioenvs/nspanel/firmware.factory.bin prebuilt/wall_display.factory.bin || true
 
       - name: Generate checksum for Firmware Files
         run: |
           md5sum prebuilt/nspanel_esphome_prebuilt.bin > prebuilt/nspanel_esphome_prebuilt.bin.md5
-          md5sum prebuilt/nspanel_esphome_prebuilt-factory.bin > prebuilt/nspanel_esphome_prebuilt-factory.bin.md5
+          md5sum prebuilt/nspanel_esphome_prebuilt.factory.bin > prebuilt/nspanel_esphome_prebuilt.factory.bin.md5
           md5sum prebuilt/wall_display.bin > prebuilt/wall_display.bin.md5
-          md5sum prebuilt/wall_display-factory.bin > prebuilt/wall_display-factory.bin.md5
+          md5sum prebuilt/wall_display.factory.bin > prebuilt/wall_display.factory.bin.md5
 
       - name: Commit and Push Firmware Files
         run: |

diff --git a/.github/workflows/validate_esphome_beta.yml b/.github/workflows/validate_esphome_beta.yml
@@ -101,7 +101,7 @@ jobs:
 
       - name: Firmware
         if: steps.matrix.outputs.cache-hit != 'true'
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -128,7 +128,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Advanced Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -152,7 +152,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build BLE Tracker Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -176,7 +176,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Bluetooth Proxy Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -203,7 +203,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Cool Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -230,7 +230,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Heat Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -257,7 +257,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Climate Dial Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -283,7 +283,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Customizations Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -306,7 +306,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Customizations Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -334,7 +334,7 @@ jobs:
         uses: actions/checkout@main
 
       - name: Build Cover Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: ${{ matrix.yaml_file }}
           version: beta
@@ -348,13 +348,13 @@ jobs:
       - uses: actions/checkout@main
 
       - name: Build ESPHome Prebuilt Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: prebuilt/nspanel_esphome_prebuilt.yaml
           version: beta
 
       - name: Build ESPHome Prebuilt Wall Display Firmware
-        uses: barndawgie/build-action@v1.9.0
+        uses: esphome/build-action@v2.0.0
         with:
           yaml_file: prebuilt/wall_display.yaml
           version: beta

diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -881,6 +881,23 @@ ensuring improved performance and user experience.
 These updates address critical issues and enhance the overall functionality and user experience of the NSPanel.
 We appreciate the community's feedback and contributions, which help us continually improve this project.
 
+## v4.3.9 - Ensuring Compatibility with ESPHome v2024.6.0
+This patch addresses a critical compatibility issue introduced by the release of ESPHome v2024.6.0.
+The OTA format has changed, necessitating updates to ensure seamless firmware updates and system stability for NSPanel users.
+
+> [!WARNING]
+> Home Assistant v2024.6.0 and ESPHome v2024.6.0 are required.
+> Please take a look at our [Version compatibility matrix](https://github.com/Blackymas/NSPanel_HA_Blueprint/blob/main/docs/version_compatibility.md) for a full list.
+
+### OTA Format Compatibility Update
+- **Criticality:** Critical
+- **Affected Components:** ESPHome
+- **Description:** Updated the NSPanel firmware to be compatible with the new OTA format introduced in ESPHome v2024.6.0.
+  This change is essential for maintaining the ability to perform over-the-air updates, ensuring continuous system functionality and stability.
+
+Please ensure you are using Home Assistant v2024.6.0 or later, along with the latest ESPHome version,
+to benefit from these updates and maintain optimal performance.
+
 ## Support
 For support or more information about this update,
 visit our [GitHub repository](https://github.com/Blackymas/NSPanel_HA_Blueprint)

diff --git a/components/nspanel_ha_blueprint/__init__.py b/components/nspanel_ha_blueprint/__init__.py
@@ -18,6 +18,8 @@
 
 @coroutine_with_priority(1.0)
 async def to_code(config):
+    cg.add_build_flag("-Wno-missing-field-initializers")
+
     if CORE.using_arduino:
         cg.add_build_flag("-DCONFIG_D0WD_PSRAM_CLK_IO=5")
         cg.add_build_flag("-DCONFIG_D0WD_PSRAM_CS_IO=18")

diff --git a/components/nspanel_ha_blueprint/upload_tft.cpp b/components/nspanel_ha_blueprint/upload_tft.cpp
@@ -1,6 +1,6 @@
 // upload_tft.cpp
 
-#ifdef NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
+// #ifdef NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
 
 #include "upload_tft.h"
 
@@ -29,4 +29,4 @@ namespace nspanel_ha_blueprint {
 
 }  // namespace nspanel_ha_blueprint
 
-#endif  // NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
+// #endif  // NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
diff --git a/components/nspanel_ha_blueprint/upload_tft.h b/components/nspanel_ha_blueprint/upload_tft.h
@@ -2,7 +2,7 @@
 
 #pragma once
 
-#ifdef NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
+// #ifdef NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
 
 #include <string>
 
@@ -31,4 +31,4 @@ namespace nspanel_ha_blueprint {
 
 }  // namespace nspanel_ha_blueprint
 
-#endif  // NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
+// #endif  // NSPANEL_HA_BLUEPRINT_ADDON_UPLOAD_TFT
diff --git a/docs/addon_bluetooth_proxy.md b/docs/addon_bluetooth_proxy.md
@@ -11,8 +11,14 @@ along with the [ESPHome Bluetooth Proxy component](https://esphome.io/components
 - Ensure the `esp-idf` framework is utilized for the [ESP32 Platform](customization.md#framework-esp-idf) when enabling Bluetooth features.
 Avoid switching to the `arduino` framework as it significantly increases memory usage, potentially causing installation failures on your panel.
 
+<!-- markdownlint-disable MD028 -->
+> [!IMPORTANT]
+> This add-on includes the BLE Tracker add-on as well.
+> Do not include that package in your configuration (or otherwise include `esp32_ble_tracker` in your configuration) otherwise  you may experience build errors.
+
 > [!WARNING]
 > The `arduino` framework, while compatible, should not be used for Bluetooth-intensive applications on the NSPanel due to its higher memory consumption.
+<!-- markdownlint-enable MD028 -->
 
 ### Configuration Steps
 1. **Edit Your ESPHome YAML File**: Add the Bluetooth Proxy add-on to your configuration by including the `remote_package` entry under the `packages` section as illustrated below:

diff --git a/docs/version_compatibility.md b/docs/version_compatibility.md
@@ -3,6 +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.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 |
 | v4.3.2<br>v4.3.1 | 2024.3.0 | 2024.3.0 |

diff --git a/esphome/nspanel_esphome_addon_ble_tracker.yaml b/esphome/nspanel_esphome_addon_ble_tracker.yaml
@@ -8,10 +8,10 @@
 #####################################################################################################
 ---
 
-esphome:
-  platformio_options:
-    build_flags:
-      - -D NSPANEL_HA_BLUEPRINT_ADDON_BLE_TRACKER
+substitutions:
+  ##### DON'T CHANGE THIS ######
+  NSPANEL_HA_BLUEPRINT_ADDON_BLE_TRACKER: "true"
+  ##############################
 
 esp32_ble:
   id: ble_component

diff --git a/esphome/nspanel_esphome_addon_bluetooth_proxy.yaml b/esphome/nspanel_esphome_addon_bluetooth_proxy.yaml
@@ -8,14 +8,14 @@
 #####################################################################################################
 ---
 
+substitutions:
+  ##### DON'T CHANGE THIS ######
+  NSPANEL_HA_BLUEPRINT_ADDON_BLUETOOTH_PROXY: "true"
+  ##############################
+
 bluetooth_proxy:
   id: ble_proxy
 
-esphome:
-  platformio_options:
-    build_flags:
-      - -D NSPANEL_HA_BLUEPRINT_ADDON_BLUETOOTH_PROXY
-
 packages:
   climate_base_package: !include nspanel_esphome_addon_ble_tracker.yaml