Meshtastic build manifest

Author: vidplace7

.github/workflows/build_firmware.yml

@@ -62,6 +62,7 @@ jobs:
           name: firmware-${{ inputs.platform }}-${{ inputs.pio_env }}-${{ inputs.version }}.zip
           overwrite: true
           path: |
+            release/*.mt.json
             release/*.bin
             release/*.elf
             release/*.uf2

.github/workflows/main_matrix.yml

@@ -27,7 +27,6 @@ on:
 
 jobs:
   setup:
-    if: github.repository == 'meshtastic/firmware'
     strategy:
       fail-fast: true
       matrix:
@@ -42,10 +41,6 @@ jobs:
           python-version: 3.x
           cache: pip
       - run: pip install -U platformio
-      - name: Uncomment build epoch
-        shell: bash
-        run: |
-          sed -i 's/#-DBUILD_EPOCH=$UNIX_TIME/-DBUILD_EPOCH=$UNIX_TIME/' platformio.ini
       - name: Generate matrix
         id: jsonStep
         run: |
@@ -62,7 +57,6 @@ jobs:
       check: ${{ steps.jsonStep.outputs.check }}
 
   version:
-    if: github.repository == 'meshtastic/firmware'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -226,6 +220,7 @@ jobs:
           name: firmware-${{matrix.arch}}-${{ needs.version.outputs.long }}
           overwrite: true
           path: |
+            ./firmware-*.mt.json
             ./firmware-*.bin
             ./firmware-*.uf2
             ./firmware-*.hex

bin/build-esp32.sh

@@ -22,6 +22,10 @@ export APP_VERSION=$VERSION
 basename=firmware-$1-$VERSION
 
 pio run --environment $1 # -v
+
+SRCMANIFEST=.pio/build/$1/meshtastic.json
+cp $SRCMANIFEST $OUTDIR/$basename.mt.json
+
 SRCELF=.pio/build/$1/firmware.elf
 cp $SRCELF $OUTDIR/$basename.elf
 

bin/build-nrf52.sh

@@ -22,6 +22,10 @@ export APP_VERSION=$VERSION
 basename=firmware-$1-$VERSION
 
 pio run --environment $1 # -v
+
+SRCMANIFEST=.pio/build/$1/meshtastic.json
+cp $SRCMANIFEST $OUTDIR/$basename.mt.json
+
 SRCELF=.pio/build/$1/firmware.elf
 cp $SRCELF $OUTDIR/$basename.elf
 

bin/build-rp2xx0.sh

@@ -22,6 +22,10 @@ export APP_VERSION=$VERSION
 basename=firmware-$1-$VERSION
 
 pio run --environment $1 # -v
+
+SRCMANIFEST=.pio/build/$1/meshtastic.json
+cp $SRCMANIFEST $OUTDIR/$basename.mt.json
+
 SRCELF=.pio/build/$1/firmware.elf
 cp $SRCELF $OUTDIR/$basename.elf
 

bin/build-stm32wl.sh

@@ -22,6 +22,10 @@ export APP_VERSION=$VERSION
 basename=firmware-$1-$VERSION
 
 pio run --environment $1 # -v
+
+SRCMANIFEST=.pio/build/$1/meshtastic.json
+cp $SRCMANIFEST $OUTDIR/$basename.mt.json
+
 SRCELF=.pio/build/$1/firmware.elf
 cp $SRCELF $OUTDIR/$basename.elf
 

bin/device-install.bat

@@ -93,6 +93,25 @@ IF NOT EXIST !FILENAME! (
     GOTO eof
 )
 
+CALL :LOG_MESSAGE DEBUG "Checking for metadata..."
+@REM Derive metadata filename from firmware filename.
+SET "METAFILE=!FILENAME:.bin=!.mt.json"
+IF EXIST !METAFILE! (
+    @REM Print parsed json with powershell
+    CALL :LOG_MESSAGE INFO "Firmware metadata: !METAFILE!"
+    powershell -NoProfile -Command "(Get-Content '!METAFILE!' | ConvertFrom-Json | Out-String).Trim()"
+
+    @REM Save metadata values to variables for later use.
+    FOR /f "usebackq" %%A IN (`powershell -NoProfile -Command ^
+        "(Get-Content '!METAFILE!' | ConvertFrom-Json).part_csv"`) DO SET "PART_CSV=%%A"
+    FOR /f "usebackq" %%A IN (`powershell -NoProfile -Command ^
+        "(Get-Content '!METAFILE!' | ConvertFrom-Json).has_mui"`) DO SET "HAS_MUI=%%A"
+    FOR /f "usebackq" %%A IN (`powershell -NoProfile -Command ^
+        "(Get-Content '!METAFILE!' | ConvertFrom-Json).mcu"`) DO SET "MCU=%%A"
+) ELSE (
+    CALL :LOG_MESSAGE WARN "No metadata file found: !METAFILE!"
+)
+
 IF NOT "!FILENAME:update=!"=="!FILENAME!" (
     CALL :LOG_MESSAGE DEBUG "We are working with a *update* file. !FILENAME!"
     CALL :LOG_MESSAGE INFO "Use script device-update.bat to flash update !FILENAME!."

bin/device-install.sh

@@ -76,6 +76,14 @@ else
     exit 1
 fi
 
+# Check for jq
+if ! command -v jq >/dev/null 2>&1; then
+    echo "Error: jq not found" >&2
+    echo "Install jq with your package manager." >&2
+    echo "e.g. 'apt install jq', 'dnf install jq', 'brew install jq', etc." >&2
+    exit 1
+fi
+
 set -e
 
 # Usage info
@@ -141,14 +149,29 @@ if [[ "$FILENAME" != firmware-* ]]; then
   exit 1
 fi
 
+# Extract BASENAME from %FILENAME% for later use.
+BASENAME="${FILENAME/firmware-/}"
+
+# Derive metadata filename from firmware filename.
+METAFILE="${FILENAME%.bin}.mt.json"
+
+# Display metadata if it exists
+if [[ -f "$METAFILE" ]]; then
+    echo "Firmware metadata: ${METAFILE}"
+    jq . "$METAFILE"
+    # Extract relevant fields from metadata
+    PART_CSV=$(jq -r '.part_csv' "$METAFILE")
+    HAS_MUI=$(jq -r '.has_mui' "$METAFILE")
+    MCU=$(jq -r '.mcu' "$METAFILE")
+else
+    echo "WARNING: No metadata file found: ${METAFILE}"
+fi
+
 # Check if FILENAME contains "-tft-" and set target partitionScheme accordingly.
 if [[ "${FILENAME//-tft-/}" != "$FILENAME" ]]; then
     TFT_BUILD=true
 fi
 
-# Extract BASENAME from %FILENAME% for later use.
-BASENAME="${FILENAME/firmware-/}"
-
 if [ -f "${FILENAME}" ] && [ -n "${FILENAME##*"update"*}" ]; then
     # Default littlefs* offset.
     OFFSET=0x300000

bin/platformio-custom.py

@@ -2,7 +2,7 @@
 # trunk-ignore-all(ruff/F821)
 # trunk-ignore-all(flake8/F821): For SConstruct imports
 import sys
-from os.path import join
+from os.path import join, basename
 import subprocess
 import json
 import re
@@ -181,3 +181,26 @@ def load_boot_logo(source, target, env):
 # Load the boot logo on TFT builds
 if ("HAS_TFT", 1) in env.get("CPPDEFINES", []):
     env.AddPreAction('$BUILD_DIR/littlefs.bin', load_boot_logo)
+
+def write_manifest(source, target, env):
+    manifest = {
+        "version": verObj["long"],
+        "build_epoch": build_epoch,
+        "board": env.get("PIOENV"),
+        "mcu": env.get("BOARD_MCU"),
+        "repo": repo_owner,
+        "part_csv": None,
+        "has_mui": False
+    }
+    # Include the partitions CSV filename if it is set
+    if env.get("PARTITIONS_TABLE_CSV"):
+        manifest["part_csv"] = basename(env.get("PARTITIONS_TABLE_CSV"))
+    # Enable MUI flag for TFT builds
+    if ("HAS_TFT", 1) in env.get("CPPDEFINES", []):
+        manifest["has_mui"] = True
+
+    # Write the manifest to the build directory
+    with open(f"{env['PROJECT_BUILD_DIR']}/{env.get('PIOENV')}/meshtastic.json", "w") as f:
+        json.dump(manifest, f, indent=4)
+
+env.AddPostAction("$PROGPATH", write_manifest)