@mentra/bluetooth-sdk 3.2.0-dev.168 → 3.2.0-dev.174

package/ios/Tests/DashboardRenderingTests.swift

@@ -0,0 +1,168 @@
+@testable import MentraBluetoothSDK
+import XCTest
+
+@MainActor
+final class DashboardRenderingTests: XCTestCase {
+    private func setupDashboard() -> (DeviceManager, PausedDisplay) {
+        let manager = DeviceManager()
+        let display = PausedDisplay()
+        manager.sgc = display
+        DeviceStore.shared.apply("glasses", "fullyBooted", true)
+        DeviceStore.shared.apply("glasses", "headUp", true)
+        DeviceStore.shared.apply("bluetooth", "contextual_dashboard", true)
+        DeviceStore.shared.apply("bluetooth", "screen_disabled", false)
+        manager.sceneStates[1] = SceneFrame(appId: "test", epoch: 1, replay: false, elements: [SceneElement(id: "old", type: "text", x: 0, y: 0, w: 100, h: 30, text: "old", data: nil, border: 0, radius: 0, change: "created", contentHash: "old")], removed: [])
+        return (manager, display)
+    }
+
+    func testSetterWaitsForCleanupAndLatestContentWins() async {
+        let (manager, display) = setupDashboard()
+        var firstReturned = false
+        let first = Task {
+            await manager.setDashboardContent("old")
+            firstReturned = true
+        }
+        await fulfillment(of: [display.cleanupStarted], timeout: 2)
+        XCTAssertFalse(firstReturned)
+        XCTAssertTrue(display.texts.isEmpty)
+
+        let secondStarted = XCTestExpectation(description: "second setter started")
+        let second = Task {
+            secondStarted.fulfill()
+            await manager.setDashboardContent("new")
+        }
+        await fulfillment(of: [secondStarted], timeout: 2)
+        display.finishCleanup()
+        await first.value
+        await second.value
+        XCTAssertFalse(display.texts.isEmpty)
+        XCTAssertTrue(display.texts.allSatisfy { $0.hasSuffix("new") })
+        XCTAssertEqual(display.cleanupCount, 1)
+    }
+
+    func testHeadDownDuringCleanupRendersMainView() async {
+        let (manager, display) = setupDashboard()
+        manager.viewStates[0].text = "main view"
+        let update = Task { await manager.setDashboardContent("dashboard") }
+        await fulfillment(of: [display.cleanupStarted], timeout: 2)
+        DeviceStore.shared.apply("glasses", "headUp", false)
+        display.finishCleanup()
+        await update.value
+        XCTAssertEqual(display.texts, ["main view"])
+    }
+
+    func testSceneArrivingDuringCleanupReplacesText() async {
+        let (manager, display) = setupDashboard()
+        let update = Task { await manager.setDashboardContent("old") }
+        await fulfillment(of: [display.cleanupStarted], timeout: 2)
+        manager.displayEvent([
+            "view": "dashboard",
+            "scene": ["appId": "new-scene", "sceneEpoch": 2, "elements": [[String: Any]]()],
+        ])
+        XCTAssertEqual(display.clearDisplayCount, 0)
+        XCTAssertTrue(display.scenes.isEmpty)
+        display.finishCleanup()
+        await update.value
+        await manager.sendCurrentState().value
+        XCTAssertTrue(display.texts.isEmpty)
+        XCTAssertFalse(display.scenes.isEmpty)
+        XCTAssertTrue(display.scenes.allSatisfy { $0.appId == "new-scene" })
+    }
+}
+
+@MainActor
+private final class PausedDisplay: SGCManager {
+    var type = "Test display"
+    let hasMic = false
+    let cleanupStarted = XCTestExpectation(description: "cleanup suspended")
+    var cleanupCount = 0
+    var clearDisplayCount = 0
+    var texts: [String] = []
+    var scenes: [SceneFrame] = []
+    private var continuation: CheckedContinuation<Void, Never>?
+
+    func clearSceneElements(_: [String]) async {
+        cleanupCount += 1
+        await withCheckedContinuation { continuation in
+            self.continuation = continuation
+            cleanupStarted.fulfill()
+        }
+    }
+
+    func finishCleanup() {
+        continuation?.resume()
+        continuation = nil
+    }
+
+    func sendTextWall(_ text: String) async {
+        texts.append(text)
+    }
+
+    func applySceneFrame(_ frame: SceneFrame) async {
+        scenes.append(frame)
+    }
+
+    func clearDisplay() {
+        clearDisplayCount += 1
+    }
+
+    // Unused device capabilities for the display test double.
+    func setMicEnabled(_: Bool) {}
+    func sortMicRanking(list: [String]) -> [String] {
+        list
+    }
+
+    func sendJson(_: [String: Any], wakeUp _: Bool, requireAck _: Bool) {}
+    func requestPhoto(_: PhotoRequest) {}
+    func startStream(_: [String: Any]) {}
+    func stopStream() {}
+    func sendStreamKeepAlive(_: [String: Any]) {}
+    func startVideoRecording(requestId _: String, save _: Bool, sound _: Bool) {}
+    func stopVideoRecording(requestId _: String) {}
+    func sendButtonPhotoSettings() {}
+    func sendButtonVideoRecordingSettings() {}
+    func sendCameraFovSetting() {}
+    func sendButtonMaxRecordingTime() {}
+    func setBrightness(_: Int, autoMode _: Bool) {}
+    func sendText(_: String) async {}
+    func sendDoubleTextWall(_: String, _: String) async {}
+    func displayBitmap(base64ImageData _: String, x _: Int32?, y _: Int32?, width _: Int32?, height _: Int32?) async -> Bool {
+        false
+    }
+
+    func showDashboard() {}
+    func setDashboardPosition(_: Int, _: Int) {}
+    func setHeadUpAngle(_: Int) {}
+    func getBatteryStatus() {}
+    func setSilentMode(_: Bool) {}
+    func exit() {}
+    func sendShutdown() {}
+    func sendReboot() {}
+    func sendRgbLedControl(requestId _: String, packageName _: String?, action _: String, color _: String?, onDurationMs _: Int, offDurationMs _: Int, count _: Int) {}
+    func disconnect() {}
+    func forget() {}
+    func findCompatibleDevices() {}
+    func stopScan() {}
+    func connectById(_: String) {}
+    func getConnectedBluetoothName() -> String? {
+        nil
+    }
+
+    func cleanup() {}
+    func ping() {}
+    func dbg1() {}
+    func dbg2() {}
+    func connectController() {}
+    func disconnectController() {}
+    func requestWifiScan(scanId _: String?) {}
+    func sendWifiCredentials(_: String, _: String) {}
+    func forgetWifiNetwork(_: String) {}
+    func sendHotspotState(_: Bool) {}
+    func sendUserEmailToGlasses(_: String) {}
+    func sendOtaStart(otaVersionUrl _: String?) {}
+    func sendOtaQueryStatus() {}
+    func queryGalleryStatus() {}
+    func sendGalleryMode() {}
+    func requestVersionInfo() {}
+    func sendIncidentId(_: String, apiBaseUrl _: String?) {}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mentra/bluetooth-sdk",
-  "version": "3.2.0-dev.168",
+  "version": "3.2.0-dev.174",
   "description": "SDK for communicating with smart glasses",
   "main": "build/index.js",
   "react-native": "src/index.ts",

package/scripts/public-dashboard-content-api.test.mjs

@@ -0,0 +1,74 @@
+import assert from "node:assert/strict"
+import {readFileSync} from "node:fs"
+import path from "node:path"
+import test from "node:test"
+import {fileURLToPath} from "node:url"
+
+const packageRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "..")
+const readPackageFile = (relativePath) => readFileSync(path.join(packageRoot, relativePath), "utf8")
+
+test("publishes setDashboardContent on React Native and native SDK surfaces", () => {
+  const publicTypes = readPackageFile("src/BluetoothSdk.types.ts")
+  const publicRoot = readPackageFile("src/index.ts")
+  const privateModule = readPackageFile("src/_private/BluetoothSdkModule.ts")
+  const androidModule = readPackageFile("android/src/main/java/com/mentra/bluetoothsdk/BluetoothSdkModule.kt")
+  const androidSdk = readPackageFile("android/src/main/java/com/mentra/bluetoothsdk/MentraBluetoothSdk.kt")
+  const appleModule = readPackageFile("ios/BluetoothSdkModule.swift")
+  const appleSdk = readPackageFile("ios/Source/MentraBluetoothSDK.swift")
+
+  assert.match(publicTypes, /setDashboardContent\(content: string\): Promise<void>/)
+  assert.match(publicRoot, /setDashboardContent: bindPublicMethod\("setDashboardContent"\)/)
+  assert.match(privateModule, /setDashboardContent\(content: string\): Promise<void>/)
+  assert.match(androidModule, /SdkAsyncFunction\("setDashboardContent"\)/)
+  assert.match(androidSdk, /fun setDashboardContent\(content: String\)/)
+  assert.match(appleModule, /AsyncFunction\("setDashboardContent"\)/)
+  assert.match(appleSdk, /public func setDashboardContent\(_ content: String\) async/)
+})
+
+test("keeps displayEvent internal and defers dashboard scene cleanup until rendering", () => {
+  const publicTypes = readPackageFile("src/BluetoothSdk.types.ts")
+  const publicRoot = readPackageFile("src/index.ts")
+  const androidSdk = readPackageFile("android/src/main/java/com/mentra/bluetoothsdk/MentraBluetoothSdk.kt")
+  const androidManager = readPackageFile("android/src/main/java/com/mentra/bluetoothsdk/DeviceManager.kt")
+  const appleSdk = readPackageFile("ios/Source/MentraBluetoothSDK.swift")
+  const appleManager = readPackageFile("ios/Source/DeviceManager.swift")
+
+  assert.doesNotMatch(publicTypes, /\bdisplayEvent\(/)
+  assert.doesNotMatch(publicRoot, /\bdisplayEvent\b/)
+  assert.match(androidSdk, /internal fun displayEvent\(/)
+  assert.doesNotMatch(androidSdk, /public fun displayEvent\(/)
+  assert.match(appleSdk, /\n\s+func displayEvent\(/)
+  assert.doesNotMatch(appleSdk, /public func displayEvent\(/)
+
+  const androidSetter = androidManager.slice(
+    androidManager.indexOf("internal fun setDashboardContent"),
+    androidManager.indexOf("private fun clearPendingDashboardSceneElements"),
+  )
+  const appleSetter = appleManager.slice(
+    appleManager.indexOf("func setDashboardContent"),
+    appleManager.indexOf("private func clearPendingDashboardSceneElements"),
+  )
+  assert.match(androidSetter, /if \(headUp && contextualDashboard\)/)
+  assert.match(appleSetter, /if headUp && contextualDashboard/)
+  assert.match(androidSetter, /pendingDashboardSceneElementIds\.addAll/)
+  assert.match(appleSetter, /pendingDashboardSceneElementIds\.formUnion/)
+  assert.match(androidSetter, /dashboardSceneCleanupPending = true/)
+  assert.match(appleSetter, /dashboardSceneCleanupPending = true/)
+  assert.doesNotMatch(androidSetter, /clearSceneElements/)
+  assert.doesNotMatch(appleSetter, /clearSceneElements/)
+  assert.doesNotMatch(androidSetter, /showDashboard/)
+  assert.doesNotMatch(appleSetter, /showDashboard/)
+
+  assert.match(androidManager, /clearPendingDashboardSceneElements\(currentStateIndex\)/)
+  assert.match(appleManager, /await clearPendingDashboardSceneElements\(for:/)
+  assert.match(
+    androidManager,
+    /private fun dispatchSceneFrame[\s\S]*?clearPendingDashboardSceneElements\(stateIndex\)/,
+  )
+  assert.match(
+    appleManager,
+    /private func dispatchSceneFrame[\s\S]*?await (?:self\.)?renderCurrentState\(\)/,
+  )
+  assert.match(androidManager, /cleanupDeferred = stateIndex == 1 && dashboardSceneCleanupPending/)
+  assert.match(appleManager, /cleanupDeferred = stateIndex == 1 && dashboardSceneCleanupDeferred/)
+})

package/src/BluetoothSdk.types.ts

@@ -1117,6 +1117,8 @@ export interface BluetoothSdkPublicModule {
 
   displayText(text: string, x?: number, y?: number, size?: number): Promise<void>
   clearDisplay(): Promise<void>
+  /** Set session-only content below the dashboard status header. Pass an empty string to reset it. */
+  setDashboardContent(content: string): Promise<void>
   showDashboard(): Promise<void>
   setDashboardPosition(height: number, depth: number): Promise<void>
   setHeadUpAngle(angleDegrees: number): Promise<void>

package/src/_private/BluetoothSdkModule.ts

@@ -77,6 +77,7 @@ declare class BluetoothSdkNativeModule extends NativeModule<BluetoothSdkModuleEv
   displayEvent(params: Record<string, unknown>): Promise<void>
   displayText(text: string, x?: number, y?: number, size?: number): Promise<void>
   clearDisplay(): Promise<void>
+  setDashboardContent(content: string): Promise<void>
 
   // Connection Commands
   requestStatus(): Promise<void>

package/src/generated/releaseMetadata.ts

@@ -12,9 +12,9 @@ export interface BluetoothSdkReleaseMetadata {
 export const BLUETOOTH_SDK_RELEASE_METADATA: Readonly<BluetoothSdkReleaseMetadata> = Object.freeze({
   "schemaVersion": 1,
   "familyBaseVersion": "3.2.0",
-  "releaseIdentity": "3.2.0-dev.168",
-  "releaseSetId": "mentra-3.2.0-dev.168",
-  "sourceCommit": "9a492a485727a0ebdd15ba9bb02fb92f3f102906",
-  "otaManifestUrl": "https://github.com/Mentra-Community/MentraOS/releases/download/mentra-builds-v3.2.0/mentra-live-ota-3.2.0-dev.168.json",
-  "otaManifestSha256": "79e6f5d746e0dcd2a0690ddd762d261cfb3448ccae4b39e44be79ad4bae8105c"
+  "releaseIdentity": "3.2.0-dev.174",
+  "releaseSetId": "mentra-3.2.0-dev.174",
+  "sourceCommit": "f81a22e61cce70842fc7df5d611b33995f516b78",
+  "otaManifestUrl": "https://github.com/Mentra-Community/MentraOS/releases/download/mentra-builds-v3.2.0/mentra-live-ota-3.2.0-dev.174.json",
+  "otaManifestSha256": "f97e5acc0c793025b271450b85468b4dc1417ce315075dcee2b6e5efd21e0337"
 })

package/src/index.ts

@@ -105,6 +105,7 @@ export const BluetoothSdk: BluetoothSdkPublicModule = Object.freeze({
   forget: bindPublicMethod("forget"),
   displayText: bindPublicMethod("displayText"),
   clearDisplay: bindPublicMethod("clearDisplay"),
+  setDashboardContent: bindPublicMethod("setDashboardContent"),
   showDashboard: bindPublicMethod("showDashboard"),
   setDashboardPosition: bindPublicMethod("setDashboardPosition"),
   setHeadUpAngle: bindPublicMethod("setHeadUpAngle"),