Added recipe and script to create Insights package

Author: sanketwadekar

platform.txt

@@ -24,6 +24,9 @@ tools.esp_ota.cmd.windows="{runtime.platform.path}/tools/espota.exe" -r
 tools.gen_esp32part.cmd=python3 "{runtime.platform.path}/tools/gen_esp32part.py"
 tools.gen_esp32part.cmd.windows="{runtime.platform.path}/tools/gen_esp32part.exe"
 
+tools.gen_insights_pkg.cmd = python3 {runtime.platform.path}/tools/gen_insights_package.py
+tools.gen_insights_pkg.cmd.windows = {runtime.platform.path}/tools/gen_insights_package.exe
+
 compiler.path={runtime.tools.{build.tarch}-{build.target}-elf-gcc.path}/bin/
 compiler.sdk.path={runtime.platform.path}/tools/sdk/{build.mcu}
 compiler.prefix={build.tarch}-{build.target}-elf-
@@ -211,10 +214,15 @@ recipe.c.combine.pattern="{compiler.path}{compiler.c.elf.cmd}" "-Wl,--Map={build
 recipe.objcopy.partitions.bin.pattern={tools.gen_esp32part.cmd} -q "{build.path}/partitions.csv" "{build.path}/{build.project_name}.partitions.bin"
 
 ## Create bin
-recipe.objcopy.bin.pattern_args=--chip {build.mcu} elf2image --flash_mode "{build.flash_mode}" --flash_freq "{build.flash_freq}" --flash_size "{build.flash_size}" -o "{build.path}/{build.project_name}.bin" "{build.path}/{build.project_name}.elf"
+recipe.objcopy.bin.pattern_args=--chip {build.mcu} elf2image --flash_mode "{build.flash_mode}" --flash_freq "{build.flash_freq}" --flash_size "{build.flash_size}" --elf-sha256-offset 0xb0 -o "{build.path}/{build.project_name}.bin" "{build.path}/{build.project_name}.elf"
 recipe.objcopy.bin.pattern="{tools.esptool_py.path}/{tools.esptool_py.cmd}" {recipe.objcopy.bin.pattern_args}
 recipe.objcopy.bin.pattern.linux=python3 "{tools.esptool_py.path}/{tools.esptool_py.cmd}" {recipe.objcopy.bin.pattern_args}
 
+## Create Insights Firmware Package
+recipe.hooks.objcopy.postobjcopy.1.pattern_args={build.path} {build.project_name} {build.path}
+recipe.hooks.objcopy.postobjcopy.1.pattern=bash -c "[ -d {build.path}/libraries/Insights ] && {tools.gen_insights_pkg.cmd} {recipe.hooks.objcopy.postobjcopy.1.pattern_args}"
+recipe.hooks.objcopy.postobjcopy.1.pattern.windows=cmd /c if exist "{build.path}\libraries\Insights" ({tools.gen_insights_pkg.cmd} {recipe.hooks.objcopy.postobjcopy.1.pattern_args})
+
 ## Save bin
 recipe.output.tmp_file={build.project_name}.bin
 recipe.output.save_file={build.project_name}.{build.variant}.bin

tools/gen_insights_package.exe

@@ -0,0 +1,55 @@
+import os
+import sys
+import shutil
+import json
+
+APP_HEADER_SIZE = 32
+VERSION_NAME_OFFSET = APP_HEADER_SIZE + 16
+VERSION_NAME_SIZE = 32
+PROJECT_NAME_OFFSET = VERSION_NAME_OFFSET + VERSION_NAME_SIZE
+PROJECT_NAME_SIZE = 32
+
+# Input path of temporary build directory created by Arduino
+BUILD_DIR=sys.argv[1]
+# Input project name
+PROJ_NAME=sys.argv[2]
+# Input path to create output package
+TARGET_PATH=sys.argv[3]
+
+def main():
+    print("Creating ESP Insights Firmware Package.")
+    archive_path = os.path.join(TARGET_PATH, PROJ_NAME)
+    
+    # Create target archive directories
+    os.makedirs(archive_path, exist_ok = True)
+    os.makedirs(os.path.join(archive_path, "partition_table"), exist_ok = True)
+    os.makedirs(os.path.join(archive_path, "bootloader"), exist_ok = True)
+    
+    # Copy files from build directory to archive directory
+    shutil.copy2(os.path.join(BUILD_DIR, PROJ_NAME + ".bin"), archive_path)
+    shutil.copy2(os.path.join(BUILD_DIR, PROJ_NAME + ".elf"), archive_path)
+    shutil.copy2(os.path.join(BUILD_DIR, PROJ_NAME + ".map"), archive_path)
+    shutil.copy2(os.path.join(BUILD_DIR, "partitions.csv"), archive_path)
+    shutil.copy2(os.path.join(BUILD_DIR, PROJ_NAME + ".bootloader.bin"), os.path.join(archive_path, "bootloader"))
+    shutil.copy2(os.path.join(BUILD_DIR, PROJ_NAME + ".partitions.bin"), os.path.join(archive_path, "partition_table"))
+    
+    with open(os.path.join(BUILD_DIR, PROJ_NAME + ".bin"), 'rb') as bin_file:
+        bin_file.seek(VERSION_NAME_OFFSET)
+        version_name = (bin_file.read(VERSION_NAME_SIZE).decode('utf-8')).split('\x00', 1)[0]
+        bin_file.seek(PROJECT_NAME_OFFSET)
+        project_name = (bin_file.read(PROJECT_NAME_SIZE).decode('utf-8')).split('\x00', 1)[0]
+        project_build_config_obj = {
+            "project" : {
+                "name" : project_name,
+                "version": version_name
+            }
+        }
+        with open(os.path.join(archive_path, "project_build_config.json"), "w") as json_file:
+            json_file.write(json.dumps(project_build_config_obj))
+    
+    shutil.make_archive(archive_path, "zip", TARGET_PATH, PROJ_NAME)
+    print("Archive created at {}".format(archive_path + ".zip"))
+    return
+
+if __name__ == '__main__':
+    main()