feat: rolling build version (rN) with navbar up-to-date badge

gitVersion.py now embeds a rolling build revision (rN from the commit
count) alongside the git describe; the release workflow publishes it in
version.json. A passive /version endpoint compares the running build to
the latest rolling release; the web UI shows the build as a navbar badge
(green = up to date, amber = update available, dim = unknown) and lists
it in the info dialog. New nav.updateAvailable / systeminfo.lblBuild
locale keys.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: fhirschmann

.github/workflows/release-firmware.yml

@@ -60,8 +60,10 @@ jobs:
           # `describe` must match what the firmware embeds (gitVersion.py uses the same command),
           # so the device can tell whether it already runs this build.
           DESCRIBE="$(git describe --always --dirty)"
-          printf '{"version":"%s","short":"%s","describe":"%s","date":"%s","ref":"%s"}\n' \
-            "$GITHUB_SHA" "${GITHUB_SHA:0:7}" "$DESCRIBE" "$(date -u +%Y-%m-%dT%H:%M:%SZ)" "$GITHUB_REF_NAME" \
+          # rolling build revision (commit count), same scheme as gitVersion.py -> "r249"
+          BUILD="r$(git rev-list --count HEAD)"
+          printf '{"version":"%s","short":"%s","describe":"%s","build":"%s","date":"%s","ref":"%s"}\n' \
+            "$GITHUB_SHA" "${GITHUB_SHA:0:7}" "$DESCRIBE" "$BUILD" "$(date -u +%Y-%m-%dT%H:%M:%SZ)" "$GITHUB_REF_NAME" \
             > release/version.json
           cat release/version.json
 

README.md

@@ -95,6 +95,7 @@ neon logo that doubles as the SVG favicon ([`7be5254`](../../commit/7be5254)):
 | Bluetooth-mode dropdown in the control tab (Normal / Speaker / Headphones), mirroring the sleep-timer dropdown; selecting a mode restarts the device into it and the button highlights the active BT mode | [`d57f24a`](../../commit/d57f24a) |
 | Mobile-optimized control tab: the hard-to-drag volume slider is replaced by full-width louder/quieter (+ EQ) buttons on phones, and the control header stacks so the legend stays on one line with the action buttons below | [`aef1765`](../../commit/aef1765) |
 | System-information dialog rendered as a clean property/value table (instead of preformatted text) and extended with the PN5180 RFID-reader firmware version (read once from the reader's EEPROM at init and exposed via `/info`) | [`715d867`](../../commit/715d867) |
+| Rolling build version (`rN` from the commit count, embedded via `gitVersion.py` and published in the release `version.json`) shown as a navbar badge — green when the device runs the latest rolling release, amber when an update is available (passive `/version` check); also listed in the info dialog | [`VERSIONHASH`](../../commit/VERSIONHASH) |
 
 #### Feature highlights
 

gitVersion.py

@@ -23,6 +23,7 @@
     #define __GIT_REVISION_H__
     constexpr const char gitRevision[] = "Git-revision: {git_revision}";
     constexpr const char gitRevShort[] = "\\"{git_revision}\\"";
+    constexpr const char buildRevision[] = "{build_revision}";
 #endif
 """
 
@@ -42,14 +43,31 @@ def git_revision():
         return "unknown"
 
 
+def build_revision():
+    """Returns a rolling build revision like 'r249' (commit count), '-dirty' if applicable."""
+    try:
+        count = subprocess.check_output(
+            ["git", "rev-list", "--count", "HEAD"],
+            text=True,
+            stderr=subprocess.PIPE,
+        ).strip()
+        dirty = subprocess.run(["git", "diff", "--quiet"]).returncode != 0
+        return f"r{count}{'-dirty' if dirty else ''}"
+    except (subprocess.CalledProcessError, OSError):
+        return "r0"
+
+
 def generate():
     """Generates header file."""
     print("GENERATING GIT REVISION HEADER FILE")
     gitrev = git_revision()
-    print(f'  "{gitrev}" -> {OUTPUT_PATH}')
+    buildrev = build_revision()
+    print(f'  "{gitrev}" ({buildrev}) -> {OUTPUT_PATH}')
     OUTPUT_PATH.parent.mkdir(exist_ok=True, parents=True)
     with OUTPUT_PATH.open("w") as output_file:
-        output_file.write(TEMPLATE.format(git_revision=gitrev))
+        output_file.write(
+            TEMPLATE.format(git_revision=gitrev, build_revision=buildrev)
+        )
 
 
 generate()

html/locales/de.json

@@ -27,6 +27,7 @@
 		"saved": "Einstellungen gespeichert."
 	},
 	"nav": {
+		"updateAvailable": "Update verfügbar",
 		"control": "Steuerung",
 		"rfid": "Dateien",
 		"wifi": "WLAN",
@@ -596,6 +597,7 @@
 	},
 	"systeminfo": {
 		"lblSoftware": "Software",
+		"lblBuild": "Build",
 		"lblGit": "Git-Revision",
 		"lblEnv": "Arduino / ESP-IDF",
 		"lblChip": "Chip",

html/locales/en.json

@@ -27,6 +27,7 @@
 		"saved": "Settings saved."
 	},
 	"nav": {
+		"updateAvailable": "Update available",
 		"control": "Control",
 		"rfid": "Files",
 		"wifi": "WiFi",
@@ -598,6 +599,7 @@
 	},
 	"systeminfo": {
 		"lblSoftware": "Software",
+		"lblBuild": "Build",
 		"lblGit": "Git revision",
 		"lblEnv": "Arduino / ESP-IDF",
 		"lblChip": "Chip",

html/locales/fr.json

@@ -27,6 +27,7 @@
 		"saved": "Paramètres enregistrés."
 	},
 	"nav": {
+		"updateAvailable": "Mise à jour disponible",
 		"control": "Contrôle",
 		"rfid": "Fichiers",
 		"wifi": "WiFi",
@@ -585,6 +586,7 @@
 	},
 	"systeminfo": {
 		"lblSoftware": "Logiciel",
+		"lblBuild": "Build",
 		"lblGit": "Révision Git",
 		"lblEnv": "Arduino / ESP-IDF",
 		"lblChip": "Puce",

html/management.html

@@ -226,6 +226,37 @@
 			color: #ff2a6d;
 		}
 
+		/* navbar firmware-version badge (green = up to date, amber = update available) */
+		.cp-version-badge {
+			font-family: "Share Tech Mono", monospace;
+			font-size: .8rem;
+			letter-spacing: .05em;
+			padding: 1px 8px;
+			margin-left: 8px;
+			border-radius: 4px;
+			border: 1px solid transparent;
+			text-decoration: none;
+			white-space: nowrap;
+			align-self: center;
+		}
+
+		.cp-version-badge.up-to-date {
+			color: var(--cp-green);
+			border-color: rgba(10, 255, 157, .45);
+			text-shadow: 0 0 8px rgba(10, 255, 157, .5);
+		}
+
+		.cp-version-badge.update-available {
+			color: var(--cp-yellow);
+			border-color: rgba(252, 238, 10, .45);
+			text-shadow: 0 0 8px rgba(252, 238, 10, .5);
+		}
+
+		.cp-version-badge.unknown {
+			color: var(--cp-dim);
+			border-color: var(--cp-border);
+		}
+
 		#menuToggle {
 			color: var(--cp-cyan) !important;
 			text-shadow: 0 0 8px rgba(0, 240, 255, .6);
@@ -1401,6 +1432,7 @@
 				<span id="navbar-brand-co" class="d-none d-md-inline">Leo Industries AT-1</span>
 				<span id="navbar-heading" class="d-none d-md-inline" data-i18n="title"></span>
 			</a>
+			<a class="navbar-text cp-version-badge unknown" id="versionBadge" href="https://github.com/fhirschmann/leoino/releases" target="_blank" rel="noopener" style="display:none;"></a>
 			<div class="collapse navbar-collapse justify-content-end">
 				<span class="navbar-text" id="connLost" data-i18n="[title]toast.conlost"><i class="fas fa-link-slash"></i></span>
 				<span class="navbar-text" id="actionOk" aria-hidden="true"><i class="fas fa-check"></i> OK</span>
@@ -3846,6 +3878,37 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 			}
 		}
 
+		// Fetch the running build + rolling-release up-to-date state and reflect it in the navbar badge.
+		async function refreshVersionBadge(retries) {
+			const el = document.getElementById('versionBadge');
+			if (!el) return;
+			let v;
+			try {
+				v = await (await fetch("http://" + host + "/version", { cache: "no-store" })).json();
+			} catch (e) {
+				return;
+			}
+			if (!v || !v.build) return;
+			el.style.display = '';
+			el.classList.remove('up-to-date', 'update-available', 'unknown');
+			if (v.upToDate === 1) {
+				el.classList.add('up-to-date');
+				el.textContent = v.build;
+				el.title = i18next.t("tools.fwupdate.github.uptodate", "Up to date");
+			} else if (v.upToDate === 0) {
+				el.classList.add('update-available');
+				el.textContent = v.build + " ⬆";
+				el.title = i18next.t("nav.updateAvailable", "Update available") + (v.latest ? " (" + v.latest + ")" : "");
+			} else {
+				el.classList.add('unknown');
+				el.textContent = v.build;
+				el.title = v.build;
+				if ((retries || 0) < 5) {
+					setTimeout(function () { refreshVersionBadge((retries || 0) + 1); }, 4000);
+				}
+			}
+		}
+
 		function updateOperationModeIndicator(opmode) {
 			const btStartSource = document.getElementById('btStartSource');
 			const btStartSink = document.getElementById('btStartSink');
@@ -3912,6 +3975,7 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 				socket.send('{"ssids":{"ssids":"ssids"}}'); // get ssids
 				socket.send('{"trackinfo":{"trackinfo":"trackinfo"}}'); // get trackinfo
 				socket.send('{"coverimg":{"coverimg":"coverimg"}}'); // get cover image
+				refreshVersionBadge(0); // update the navbar firmware-version badge
 			};
 			socket.onclose = function (e) {
 				console.log('Socket is closed. Reconnect will be attempted in 5 seconds.', e.reason);
@@ -5474,6 +5538,7 @@ <h5 class="modal-title" data-i18n="tools.nvs.erase.title"></h5>
 			};
 
 			add('systeminfo.lblSoftware', info.software.version);
+			add('systeminfo.lblBuild', info.software.build);
 			add('systeminfo.lblGit', info.software.git);
 			add('systeminfo.lblEnv', info.software.arduino + ' / ' + info.software.idf);
 			add('systeminfo.lblChip', info.hardware.model + ' (rev ' + info.hardware.revision + ')');

src/Web.cpp

@@ -636,6 +636,47 @@ void Web_TriggerGithubOta(void) {
 #endif
 }
 
+// Passive "is this build the latest release?" check, used only for the UI version badge
+// (independent of the OTA flasher). -1 = unknown/not yet checked, 0 = update available, 1 = up to date.
+static volatile int8_t gFirmwareUpToDate = -1;
+static char gLatestBuild[24] = "";
+
+// Fetches the rolling release's version.json and compares it to the running build (background task).
+static void versionCheckTask(void *parameter) {
+	WiFiClientSecure client;
+	client.setInsecure();
+	HTTPClient http;
+	http.setFollowRedirects(HTTPC_STRICT_FOLLOW_REDIRECTS);
+	http.setConnectTimeout(8000);
+	if (http.begin(client, githubVersionUrl)) {
+		if (http.GET() == 200) {
+			JsonDocument doc;
+			if (deserializeJson(doc, http.getString()) == DeserializationError::Ok) {
+				String latest = doc["describe"].as<String>();
+				String latestBuild = doc["build"].as<String>();
+				String current = String(gitRevShort);
+				current.replace("\"", "");
+				if (latest.length() > 0) {
+					gFirmwareUpToDate = (latest == current) ? 1 : 0;
+				}
+				if (latestBuild.length() > 0) {
+					strncpy(gLatestBuild, latestBuild.c_str(), sizeof(gLatestBuild) - 1);
+					gLatestBuild[sizeof(gLatestBuild) - 1] = '\0';
+				}
+			}
+		}
+		http.end();
+	}
+	vTaskDelete(NULL);
+}
+
+// Kick off a background version check (no-op on boards without OTA support).
+void Web_CheckForUpdate(void) {
+#ifdef BOARD_HAS_16MB_FLASH_AND_OTA_SUPPORT
+	xTaskCreatePinnedToCore(versionCheckTask, "verCheck", 8192, NULL, 1, NULL, 1);
+#endif
+}
+
 void webserverStart(void) {
 	if (!webserverStarted && (Wlan_IsConnected() || (WiFi.getMode() == WIFI_AP))) {
 		// password protection (no-op when no password is set or in accesspoint-mode)
@@ -793,6 +834,15 @@ void webserverStart(void) {
 			snprintf(buf, sizeof(buf), "{\"status\":%u,\"progress\":%u,\"message\":\"%s\"}", gGithubOtaStatus, gGithubOtaProgress, gGithubOtaMsg);
 			request->send(200, "application/json", buf);
 		});
+		// running build + rolling-release up-to-date state, used for the navbar version badge
+		wServer.on("/version", HTTP_GET, [](AsyncWebServerRequest *request) {
+			if (gFirmwareUpToDate == -1) {
+				Web_CheckForUpdate(); // lazy first check
+			}
+			char buf[160];
+			snprintf(buf, sizeof(buf), "{\"build\":\"%s\",\"upToDate\":%d,\"latest\":\"%s\"}", buildRevision, (int) gFirmwareUpToDate, gLatestBuild);
+			request->send(200, "application/json", buf);
+		});
 
 		// ESP-restart
 		wServer.on("/restart", HTTP_POST, [](AsyncWebServerRequest *request) {
@@ -977,6 +1027,7 @@ void webserverStart(void) {
 		DefaultHeaders::Instance().addHeader("Access-Control-Allow-Origin", "*");
 		wServer.begin();
 		webserverStarted = true;
+		Web_CheckForUpdate(); // populate the version badge in the background
 		Log_Println(httpReady, LOGLEVEL_NOTICE);
 		// start a first WiFi scan (to get a WiFi list more quickly in webview)
 		WiFi.scanNetworks(true, false, true, 120);
@@ -1703,6 +1754,7 @@ void handleGetInfo(AsyncWebServerRequest *request) {
 		JsonObject softwareObj = infoObj["software"].to<JsonObject>();
 		softwareObj["version"] = (String) softwareRevision;
 		softwareObj["git"] = (String) gitRevision;
+		softwareObj["build"] = (String) buildRevision;
 		softwareObj["arduino"] = String(ESP_ARDUINO_VERSION_MAJOR) + "." + String(ESP_ARDUINO_VERSION_MINOR) + "." + String(ESP_ARDUINO_VERSION_PATCH);
 		softwareObj["idf"] = String(ESP.getSdkVersion());
 	}