PlatformIO：将基于 Git 的固件版本注入 ESP32 固件的脚本

#!/usr/bin/env python3
import subprocess
from datetime import datetime
import argparse
import sys


if __name__ == "__main__":
    parser = argparse.ArgumentParser()
    parser.add_argument("-e", "--environment", help="要使用的构建环境")
    parser.add_argument("--chip", default="esp32", help="要使用的芯片（用于 esptool.py elf2image）")
    parser.add_argument("--flash_freq", default="40m", help="Flash 频率（用于 esptool.py elf2image）")
    parser.add_argument("--flash_mode", default="dio", help="Flash 模式（用于 esptool.py elf2image）")
    args = parser.parse_args()

    # 确定 git 版本和构建日期
    version = subprocess.check_output("git describe --long --tags --dirty", shell=True).strip().decode("utf-8")
    date = datetime.utcnow().isoformat()

    # 拼接版本和日期
    full_version_string = f"{version}@{date}".encode("utf-8")
    firmware_version_template = b"================================================================================"

    # 如果未指定环境，只打印版本并退出
    if not args.environment:
        print(f"Version: {version}")
        print("No --environment specified, exiting...")
        sys.exit(1)

    with open(f".pio/build/{args.environment}/firmware.elf", "rb") as infile:
        firmware_binary = infile.read()
        # 替换字符串必须具有完全正确的长度！
        version_replacement = full_version_string.ljust(len(firmware_version_template), b'\0')
        # 替换！
        firmware_binary = firmware_binary.replace(firmware_version_template, version_replacement, 1)

    # 写回文件
    with open(f".pio/build/{args.environment}/firmware-versioned.elf", "wb") as outfile:
        outfile.write(firmware_binary)

    # 将版本写入文件
    with open(f".pio/build/{args.environment}/version.txt", "w", encoding="utf-8") as outfile:
        outfile.write(version)

    # 转换为 ELF
    subprocess.check_output(f"esptool.py --chip {args.chip} elf2image --flash_freq {args.flash_freq} --flash_mode {args.flash_mode} .pio/build/{args.environment}/firmware-versioned.elf", shell=True)