From 4c313bc1982c2eabc3ccfe54b84008323c8fc5ad Mon Sep 17 00:00:00 2001
From: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
Date: Tue, 18 Jun 2024 14:12:55 +1200
Subject: [PATCH] Rename legacy/modern to ota/factory (#6922)

* Rename legacy/modern to ota/factory

* Add modern/legacy in brackets
---
 esphome/components/esp32/__init__.py          | 14 +++++------
 esphome/components/esp32/post_build.py.script | 13 ++++++++++-
 .../components/esp8266/post_build.py.script   | 10 +++++++-
 esphome/components/rp2040/__init__.py         | 18 +++++++++++++--
 .../components/rp2040/post_build.py.script    | 23 +++++++++++++++++++
 5 files changed, 67 insertions(+), 11 deletions(-)
 create mode 100644 esphome/components/rp2040/post_build.py.script

diff --git a/esphome/components/esp32/__init__.py b/esphome/components/esp32/__init__.py
index 8f46567266..1effea708f 100644
--- a/esphome/components/esp32/__init__.py
+++ b/esphome/components/esp32/__init__.py
@@ -96,16 +96,16 @@ def get_board(core_obj=None):
 def get_download_types(storage_json):
     return [
         {
-            "title": "Modern format",
+            "title": "Factory format (Previously Modern)",
             "description": "For use with ESPHome Web and other tools.",
-            "file": "firmware-factory.bin",
-            "download": f"{storage_json.name}-factory.bin",
+            "file": "firmware.factory.bin",
+            "download": f"{storage_json.name}.factory.bin",
         },
         {
-            "title": "Legacy format",
-            "description": "For use with ESPHome Flasher.",
-            "file": "firmware.bin",
-            "download": f"{storage_json.name}.bin",
+            "title": "OTA format (Previously Legacy)",
+            "description": "For OTA updating a device.",
+            "file": "firmware.ota.bin",
+            "download": f"{storage_json.name}.ota.bin",
         },
     ]
 
diff --git a/esphome/components/esp32/post_build.py.script b/esphome/components/esp32/post_build.py.script
index c941bdb386..c181cf30b1 100644
--- a/esphome/components/esp32/post_build.py.script
+++ b/esphome/components/esp32/post_build.py.script
@@ -17,17 +17,19 @@ from SCons.Script import ARGUMENTS
 
 # Copy over the default sdkconfig.
 from os import path
+
 if path.exists("./sdkconfig.defaults"):
     os.makedirs(".temp", exist_ok=True)
     shutil.copy("./sdkconfig.defaults", "./.temp/sdkconfig-esp32-idf")
 
+
 def esp32_create_combined_bin(source, target, env):
     verbose = bool(int(ARGUMENTS.get("PIOVERBOSE", "0")))
     if verbose:
         print("Generating combined binary for serial flashing")
     app_offset = 0x10000
 
-    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}-factory.bin")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.factory.bin")
     sections = env.subst(env.get("FLASH_EXTRA_IMAGES"))
     firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
     chip = env.get("BOARD_MCU")
@@ -62,5 +64,14 @@ def esp32_create_combined_bin(source, target, env):
     else:
         subprocess.run(["esptool.py", *cmd])
 
+
+def esp32_copy_ota_bin(source, target, env):
+    firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.ota.bin")
+
+    shutil.copyfile(firmware_name, new_file_name)
+
+
 # pylint: disable=E0602
 env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", esp32_create_combined_bin)  # noqa
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", esp32_copy_ota_bin)  # noqa
diff --git a/esphome/components/esp8266/post_build.py.script b/esphome/components/esp8266/post_build.py.script
index 4dab1cbd27..0a854d7599 100644
--- a/esphome/components/esp8266/post_build.py.script
+++ b/esphome/components/esp8266/post_build.py.script
@@ -6,10 +6,18 @@ Import("env")  # noqa
 
 def esp8266_copy_factory_bin(source, target, env):
     firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
-    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}-factory.bin")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.factory.bin")
+
+    shutil.copyfile(firmware_name, new_file_name)
+
+
+def esp8266_copy_ota_bin(source, target, env):
+    firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.ota.bin")
 
     shutil.copyfile(firmware_name, new_file_name)
 
 
 # pylint: disable=E0602
 env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", esp8266_copy_factory_bin)  # noqa
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", esp8266_copy_ota_bin)  # noqa
diff --git a/esphome/components/rp2040/__init__.py b/esphome/components/rp2040/__init__.py
index ace455add7..f5c3b8bda2 100644
--- a/esphome/components/rp2040/__init__.py
+++ b/esphome/components/rp2040/__init__.py
@@ -47,10 +47,16 @@ def set_core_data(config):
 def get_download_types(storage_json):
     return [
         {
-            "title": "UF2 format",
+            "title": "UF2 factory format",
             "description": "For copying to RP2040 over USB.",
             "file": "firmware.uf2",
-            "download": f"{storage_json.name}.uf2",
+            "download": f"{storage_json.name}.factory.uf2",
+        },
+        {
+            "title": "OTA format",
+            "description": "For OTA updating a device.",
+            "file": "firmware.ota.bin",
+            "download": f"{storage_json.name}.ota.bin",
         },
     ]
 
@@ -160,6 +166,8 @@ async def to_code(config):
     cg.add_define("ESPHOME_BOARD", config[CONF_BOARD])
     cg.add_define("ESPHOME_VARIANT", "RP2040")
 
+    cg.add_platformio_option("extra_scripts", ["post:post_build.py"])
+
     conf = config[CONF_FRAMEWORK]
     cg.add_platformio_option("framework", "arduino")
     cg.add_build_flag("-DUSE_ARDUINO")
@@ -225,4 +233,10 @@ def generate_pio_files() -> bool:
 
 # Called by writer.py
 def copy_files() -> bool:
+    dir = os.path.dirname(__file__)
+    post_build_file = os.path.join(dir, "post_build.py.script")
+    copy_file_if_changed(
+        post_build_file,
+        CORE.relative_build_path("post_build.py"),
+    )
     return generate_pio_files()
diff --git a/esphome/components/rp2040/post_build.py.script b/esphome/components/rp2040/post_build.py.script
new file mode 100644
index 0000000000..7dcd7e52a6
--- /dev/null
+++ b/esphome/components/rp2040/post_build.py.script
@@ -0,0 +1,23 @@
+import shutil
+
+# pylint: disable=E0602
+Import("env")  # noqa
+
+
+def rp2040_copy_factory_uf2(source, target, env):
+    firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.uf2")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.factory.uf2")
+
+    shutil.copyfile(firmware_name, new_file_name)
+
+
+def rp2040_copy_ota_bin(source, target, env):
+    firmware_name = env.subst("$BUILD_DIR/${PROGNAME}.bin")
+    new_file_name = env.subst("$BUILD_DIR/${PROGNAME}.ota.bin")
+
+    shutil.copyfile(firmware_name, new_file_name)
+
+
+# pylint: disable=E0602
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", rp2040_copy_factory_uf2)  # noqa
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", rp2040_copy_ota_bin)  # noqa