feat: show firmware version on UI

adlerre · Jan 8, 2025 · b200a46 · b200a46
1 parent e4ba98a
commit b200a46
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 6 deletions.
diff --git a/src/main.cpp b/src/main.cpp
@@ -111,6 +111,14 @@ void deepSleep(uint32_t ms) {
     esp_deep_sleep_start();
 }
 
+String getVersion() {
+    auto version = String(BUILD_GIT_BRANCH);
+    if (!version.startsWith("v")) {
+        version += " (" + String(BUILD_GIT_COMMIT_HASH) + ")";
+    }
+    return version;
+}
+
 void WiFiAPStart(WiFiEvent_t event, WiFiEventInfo_t info) {
     wifiAPStarted = true;
     DEBUG_PORT.println("WiFi AP started.");
@@ -173,6 +181,10 @@ void startWiFiAP() {
 }
 
 void startHttpServer() {
+    server.on("/api/version", HTTP_GET, [](AsyncWebServerRequest *request) {
+        request->send(200, "text/plain", getVersion());
+    });
+
     server.on("/api/settings", HTTP_GET, [](AsyncWebServerRequest *request) {
         request->send(200, "application/json", Settings.buildJson().c_str());
     });

diff --git a/ui/src/app/components/deviceInfo.component.html b/ui/src/app/components/deviceInfo.component.html
@@ -16,6 +16,13 @@
   -->
 
 <div id="deviceInfo">
+    <fieldset *ngIf="version">
+        <legend>Firmware</legend>
+        <dl class="row">
+            <dt class="col-sm-3">Version</dt>
+            <dd class="col-sm-9">{{ version }}</dd>
+        </dl>
+    </fieldset>
     <fieldset *ngIf="wifiInfo">
         <legend>WiFi Info</legend>
         <dl class="row">

diff --git a/ui/src/app/components/deviceInfo.component.spec.ts b/ui/src/app/components/deviceInfo.component.spec.ts
@@ -38,6 +38,10 @@ const testModemInfo: ModemInfo = {
 
 export class MockApiService {
 
+    version() {
+        return of("1.0.0");
+    }
+
     wifiInfo() {
         return of<WifiInfo>(testWiFiInfo);
     }
@@ -84,8 +88,9 @@ describe("DeviceInfoComponent", () => {
         expect(getElement("#deviceInfo")).toBeTruthy();
 
         const legends = getElements("legend");
-        expect(legends.length).toBe(2);
-        expect(legends[0].textContent).toBe("WiFi Info");
-        expect(legends[1].textContent).toBe("Modem Info");
+        expect(legends.length).toBe(3);
+        expect(legends[0].textContent).toBe("Firmware");
+        expect(legends[1].textContent).toBe("WiFi Info");
+        expect(legends[2].textContent).toBe("Modem Info");
     });
 });
diff --git a/ui/src/app/components/deviceInfo.component.ts b/ui/src/app/components/deviceInfo.component.ts
@@ -26,6 +26,8 @@ import { ApiService } from "../services/api.service";
 })
 export class DeviceInfoComponent implements OnInit {
 
+    version: string | undefined;
+
     wifiInfo: WifiInfo | undefined;
 
     modemInfo: ModemInfo | undefined;
@@ -34,6 +36,7 @@ export class DeviceInfoComponent implements OnInit {
     }
 
     ngOnInit(): void {
+        this.$api.version().subscribe(ver => this.version = ver);
         this.$api.wifiInfo().subscribe((wi) => this.wifiInfo = wi);
         this.$api.modemInfo().subscribe((mi) => this.modemInfo = mi);
     }

diff --git a/ui/src/app/services/api.service.ts b/ui/src/app/services/api.service.ts
@@ -17,10 +17,8 @@
 
 import { Injectable } from "@angular/core";
 import { HttpClient, HttpEvent, HttpEventType, HttpHeaders, HttpRequest } from "@angular/common/http";
-import { Configuration, DiscoveredDevices, ModemInfo, Settings, WifiInfo } from "../definitions";
+import { Configuration, DiscoveredDevices, ModemInfo, OBDState, OTAMode, Settings, WifiInfo } from "../definitions";
 import { distinctUntilChanged, last, map, Subject } from "rxjs";
-import { OTAMode } from "../definitions/ota";
-import { OBDState } from "../definitions/obdStates";
 
 @Injectable()
 export class ApiService {
@@ -36,6 +34,10 @@ export class ApiService {
         return this.$http.post("/api/reboot?reboot=true", {}, {responseType: "text"});
     }
 
+    version() {
+        return this.$http.get("/api/version", {responseType: "text"});
+    }
+
     wifiInfo() {
         return this.$http.get<WifiInfo>("/api/wifi");
     }