@mentra/engine 3.1.0-dev.10 → 3.1.0-dev.102

package/src/services/asg/localNetworkTransport.ts

@@ -1,5 +1,5 @@
 import * as RNFS from "@dr.pogodin/react-native-fs"
-import {MentraLocalNetwork, type LocalNetworkDownloadProgress} from "@mentra/bluetooth-sdk/internal"
+import {otaLocalNetwork, type OtaLocalNetworkDownloadProgress} from "@mentra/bluetooth-sdk/ota-transport"
 import {Buffer} from "buffer"
 import {Platform} from "react-native"
 import WifiManager from "react-native-wifi-reborn"
@@ -17,7 +17,7 @@ export function shouldUseScopedLocalNetwork(os: string, moduleAvailable: boolean
 }
 
 function supportsScopedConnection(): boolean {
-  return shouldUseScopedLocalNetwork(Platform.OS, MentraLocalNetwork != null)
+  return shouldUseScopedLocalNetwork(Platform.OS, otaLocalNetwork.isAvailable())
 }
 
 function normalizeHeaders(headers?: HeadersInit): Record<string, string> {
@@ -48,25 +48,25 @@ export const localNetworkTransport = {
       await WifiManager.connectToProtectedSSID(ssid, password, false, false)
       return undefined
     }
-    const result = await MentraLocalNetwork!.connect(ssid, password)
+    const result = await otaLocalNetwork.connect(ssid, password)
     scopedConnectionActive = true
     return result.localAddress
   },
 
   async disconnect(): Promise<void> {
     if (supportsScopedConnection()) {
-      await MentraLocalNetwork!.disconnect().catch(() => {})
+      await otaLocalNetwork.disconnect().catch(() => {})
     }
     scopedConnectionActive = false
     nativeJobs.clear()
   },
 
   async fetch(url: string | URL | Request, init?: RequestInit, timeoutMs = 30_000): Promise<Response> {
-    if (!scopedConnectionActive || !MentraLocalNetwork || typeof url !== "string") {
+    if (!scopedConnectionActive || !otaLocalNetwork.isAvailable() || typeof url !== "string") {
       return globalThis.fetch(url, init)
     }
 
-    const nativeModule = MentraLocalNetwork
+    const nativeModule = otaLocalNetwork
     const id = requestId("request")
     const signal = init?.signal
     const cancel = () => void nativeModule.cancel(id)
@@ -92,13 +92,13 @@ export const localNetworkTransport = {
   },
 
   downloadFile(options: DownloadOptions): DownloadHandle {
-    if (!scopedConnectionActive || !MentraLocalNetwork) return RNFS.downloadFile(options)
+    if (!scopedConnectionActive || !otaLocalNetwork.isAvailable()) return RNFS.downloadFile(options)
 
     const jobId = nextJobId++
     const id = requestId("download")
     let began = false
     nativeJobs.set(jobId, id)
-    const subscription = MentraLocalNetwork.addListener("downloadProgress", (event: LocalNetworkDownloadProgress) => {
+    const subscription = otaLocalNetwork.onDownloadProgress((event: OtaLocalNetworkDownloadProgress) => {
       if (event.requestId !== id) return
       if (!began) {
         began = true
@@ -116,14 +116,15 @@ export const localNetworkTransport = {
       })
     })
 
-    const promise = MentraLocalNetwork.download(
-      id,
-      options.fromUrl,
-      options.toFile,
-      options.headers || {},
-      options.connectionTimeout || 30_000,
-      options.readTimeout || 30_000,
-    )
+    const promise = otaLocalNetwork
+      .download(
+        id,
+        options.fromUrl,
+        options.toFile,
+        options.headers || {},
+        options.connectionTimeout || 30_000,
+        options.readTimeout || 30_000,
+      )
       .then((result) => {
         if (!began) {
           options.begin?.({
@@ -154,16 +155,16 @@ export const localNetworkTransport = {
 
   stopDownload(jobId: number): void {
     const nativeId = nativeJobs.get(jobId)
-    if (nativeId && MentraLocalNetwork) {
+    if (nativeId && otaLocalNetwork.isAvailable()) {
       cancelledNativeJobs.add(jobId)
-      void MentraLocalNetwork.cancel(nativeId)
+      void otaLocalNetwork.cancel(nativeId)
       return
     }
     RNFS.stopDownload(jobId)
   },
 }
 
-MentraLocalNetwork?.addListener("networkLost", () => {
+otaLocalNetwork.onNetworkLost(() => {
   scopedConnectionActive = false
   nativeJobs.clear()
 })

package/src/services/glassesClockSync.ts

@@ -2,7 +2,7 @@
  * Push phone time to glasses only when clock skew is detected (gallery sync, OTA, etc.).
  */
 
-import BluetoothSdk from "@mentra/bluetooth-sdk/internal"
+import BluetoothSdk from "@mentra/bluetooth-sdk"
 import {BgTimer} from "../utils/timers"
 import {useGlassesStore} from "../stores/glasses"
 

package/src/services/otaInstallPolicy.ts

@@ -32,6 +32,8 @@ export const PING_INTERVAL_MS = 10_000
 export const QUERY_REPLY_TIMEOUT_MS = 6000
 /** 15s lockout on the Continue button after a BES restart, to prevent an accidental tap. */
 export const BES_CONTINUE_LOCKOUT_MS = 15_000
+/** Fail closed if a BES reboot never reconnects; normal restarts complete in a fraction of this window. */
+export const BES_RESTART_TIMEOUT_MS = 120_000
 
 // --- Legacy old-build (< MINIMUM_OTA_STATUS_BUILD) OTA policy (WP 8C) ---
 //
@@ -51,6 +53,7 @@ export const LEGACY_MTK_INSTALL_TIMEOUT_MS = MTK_INSTALL_TIMEOUT_MS + LEGACY_EXT
 export const LEGACY_GLOBAL_OTA_TIMEOUT_MS = GLOBAL_OTA_TIMEOUT_MS + LEGACY_EXTRA_TIMEOUT_MS
 export const LEGACY_PING_INTERVAL_MS = PING_INTERVAL_MS + LEGACY_EXTRA_TIMEOUT_MS
 export const LEGACY_BES_CONTINUE_LOCKOUT_MS = BES_CONTINUE_LOCKOUT_MS + LEGACY_EXTRA_TIMEOUT_MS
+export const LEGACY_BES_RESTART_TIMEOUT_MS = BES_RESTART_TIMEOUT_MS + LEGACY_EXTRA_TIMEOUT_MS
 /**
  * After a legacy apk `install FINISHED` observed in-flight, the legacy screen held the
  * completed state for 12s (+20s pad) so the ASG process restart settles (and fresh
@@ -122,6 +125,7 @@ export function selectOtaProtocolProfile(
 export const OtaProgressMessages = {
   stalledOrStuck: "Update may have failed. Ensure glasses have internet access and try again.",
   globalTimeout: "Update took too long. Please try again.",
+  restartTimeout: "Glasses did not finish restarting. Restart them before trying the update again.",
   sendOtaStartFailed: "Failed to communicate with glasses.",
   hotspotArtifactDownloadFailed: "Could not download the update to your phone. Check phone internet and try again.",
   hotspotArtifactVerifyFailed: "The update package could not be verified. Please try again later.",

package/src/services/otaReleaseVersion.ts

@@ -0,0 +1,22 @@
+const COORDINATED_RELEASE_VERSION = /^\d+\.\d+\.\d+(?:-(?:dev|beta)\.[1-9]\d*)?$/
+
+type OtaReleaseVersionInput = {
+  manifestReleaseVersion?: string | null
+  manifestUrl: string
+  packagedManifestUrl?: string | null
+  packagedReleaseIdentity?: string | null
+}
+
+function validReleaseVersion(version: string | null | undefined): string | null {
+  const trimmed = version?.trim()
+  return trimmed && COORDINATED_RELEASE_VERSION.test(trimmed) ? trimmed : null
+}
+
+/** Resolve the label for the selected OTA pin, including stable promotion of exact beta OTA bytes. */
+export function resolveOtaReleaseVersion(input: OtaReleaseVersionInput): string | null {
+  const packagedRelease = validReleaseVersion(input.packagedReleaseIdentity)
+  if (packagedRelease && input.packagedManifestUrl?.trim() === input.manifestUrl.trim()) {
+    return packagedRelease
+  }
+  return validReleaseVersion(input.manifestReleaseVersion)
+}

package/src/stores/appVisibility.ts

@@ -0,0 +1,3 @@
+/** Combine registry-enforced visibility with the user's home-screen choice. */
+export const resolveHiddenStatus = (registryHidden: boolean, userHidden: boolean): boolean =>
+  registryHidden || userHidden

package/src/stores/apps.ts

@@ -25,6 +25,7 @@ import {islandNotifications} from "../services/NotificationsEmitter"
 import sttModelManager from "../services/STTModelManager"
 import {miniappLauncher} from "../services/MiniappLauncher"
 import {miniappRunningRegistry} from "../services/MiniappRunningRegistry"
+import {resolveHiddenStatus} from "./appVisibility"
 import {SETTINGS, useSettingsStore} from "./settings"
 import BluetoothSdk from "@mentra/bluetooth-sdk"
 
@@ -221,7 +222,12 @@ function projectApps(previousState: AppStatusState, localApps: ClientApp[]): Cli
       ...app,
       screenshot: previousByPackage.get(app.packageName)?.screenshot ?? app.screenshot,
       compatibility: HardwareCompatibility.checkCompatibility(app.hardwareRequirements, capabilities),
-      hidden: previousState.getHiddenStatus(app.packageName),
+      // A registry source can force an app off the primary home screen (for
+      // example, Miniapp Developer while its home-screen setting is disabled).
+      // Compose that gate with the user's persisted home-screen layout instead
+      // of replacing it, otherwise a default-false persisted value makes a
+      // source-hidden app visible again during projection.
+      hidden: resolveHiddenStatus(app.hidden, previousState.getHiddenStatus(app.packageName)),
       // Derive the foreground flag from the store's single source of truth
       // (`foregroundedPackage`), NOT from the previous snapshot. Carrying it over
       // per-app meant a refresh that momentarily omitted an app (e.g. the

package/src/stores/core.ts

@@ -1,13 +1,13 @@
 import {create} from "zustand"
 import {subscribeWithSelector} from "zustand/middleware"
-import type {BluetoothStatus} from "@mentra/bluetooth-sdk/internal"
+import type {PublicBluetoothStatus} from "@mentra/bluetooth-sdk"
 
-export interface CoreState extends BluetoothStatus {
-  setCoreInfo: (info: Partial<BluetoothStatus>) => void
+export interface CoreState extends PublicBluetoothStatus {
+  setCoreInfo: (info: Partial<PublicBluetoothStatus>) => void
   reset: () => void
 }
 
-const initialState: BluetoothStatus = {
+const initialState: PublicBluetoothStatus = {
   // state:
   searching: false,
   searchingController: false,

package/src/stores/glasses.ts

@@ -1,12 +1,12 @@
 import type {
   GlassesConnectionStatus,
-  GlassesStatus,
   HotspotStatus,
   OtaProgress,
   OtaStatus,
   OtaUpdateInfo,
+  PublicGlassesStatus,
   WifiStatus,
-} from "@mentra/bluetooth-sdk/internal"
+} from "@mentra/bluetooth-sdk"
 import {isGlassesConnected, isGlassesLinkLayerBusy, isGlassesReady} from "../services/GlassesReadiness"
 import {create} from "zustand"
 import {subscribeWithSelector} from "zustand/middleware"
@@ -20,7 +20,14 @@ export const selectGlassesConnected = (state: {connection: GlassesConnectionStat
 
 export const selectGlassesReady = (state: {connection: GlassesConnectionStatus}) => isGlassesReady(state.connection)
 
-export interface GlassesState extends GlassesStatus {
+type EngineGlassesStatus = PublicGlassesStatus & {
+  otaUpdateAvailable: OtaUpdateInfo | null
+  otaProgress: OtaProgress | null
+  otaInProgress: boolean
+  otaVersionUrl: string
+}
+
+export interface GlassesState extends EngineGlassesStatus {
   systemTimeMs: number
   wifiStatusKnown: boolean
   setGlassesInfo: (info: GlassesInfoUpdate) => void
@@ -53,7 +60,7 @@ type LegacyHotspotFields = {
   hotspotLocalIp?: string
 }
 
-type GlassesInfoUpdate = Partial<GlassesStatus> & LegacyWifiFields & LegacyHotspotFields
+type GlassesInfoUpdate = Partial<EngineGlassesStatus> & LegacyWifiFields & LegacyHotspotFields
 
 function wifiFromLegacyFields(info: LegacyWifiFields): WifiStatus | null {
   if (info.wifiConnected === true) {
@@ -80,7 +87,7 @@ function hotspotFromLegacyFields(info: LegacyHotspotFields): HotspotStatus | nul
   return null
 }
 
-export const getGlasesInfoPartial = (state: GlassesStatus) => {
+export const getGlasesInfoPartial = (state: EngineGlassesStatus) => {
   const wifi = state.wifi
   const connected = isGlassesConnected(state.connection)
   return {
@@ -98,7 +105,7 @@ export const getGlasesInfoPartial = (state: GlassesStatus) => {
   }
 }
 
-interface GlassesStore extends GlassesStatus {
+interface GlassesStore extends EngineGlassesStatus {
   systemTimeMs: number
   mtkUpdatedThisSession: boolean
   wifiStatusKnown: boolean

package/src/types/applet.ts

@@ -1,5 +1,5 @@
 /**
- * @mentra/types - App/Applet types for client interfaces
+ * App and miniapp types owned by @mentra/engine.
  */
 
 import type {ReactNode} from "react"

package/src/types/capabilities/even-realities-g1.ts

@@ -64,4 +64,7 @@ export const evenRealitiesG1: Capabilities = {
 
   // WiFi capabilities - G1 does not support WiFi
   hasWifi: false,
+
+  // OTA capabilities - G1 firmware updates are not driven by the ASG OTA flow
+  hasOta: false,
 };

package/src/types/capabilities/even-realities-g2.ts

@@ -82,6 +82,9 @@ export const evenRealitiesG2: Capabilities = {
   // WiFi capabilities - G2 does not support WiFi
   hasWifi: false,
 
+  // OTA capabilities - G2 firmware updates are not driven by the ASG OTA flow
+  hasOta: false,
+
   // Dashboard - G2 renders Even Realities' native dashboard in firmware, so
   // MentraOS does not manage the dashboard or expose dashboard settings for it
   hasNativeDashboard: true,

package/src/types/capabilities/mentra-display.ts

@@ -72,4 +72,7 @@ export const mentraDisplay: Capabilities = {
 
   // WiFi capabilities - Mentra Display does not support WiFi
   hasWifi: false,
+
+  // OTA capabilities - Mentra Display firmware updates are not driven by the ASG OTA flow
+  hasOta: false,
 };

package/src/types/capabilities/mentra-live.ts

@@ -100,4 +100,7 @@ export const mentraLive: Capabilities = {
 
   // WiFi capabilities - Mentra Live supports WiFi
   hasWifi: true,
+
+  // OTA capabilities - Mentra Live supports ASG/BES/MTK OTA updates
+  hasOta: true,
 };

package/src/types/capabilities/nimo.ts

@@ -0,0 +1,59 @@
+/**
+ * @fileoverview NIMO hardware capabilities.
+ *
+ * NIMO uses framed UART-over-BLE for widget content and a separate Opus
+ * microphone channel.
+ */
+
+import type {Capabilities} from "../hardware"
+
+export const nimo: Capabilities = {
+  modelName: "NIMO",
+  hasCamera: false,
+  camera: null,
+  hasDisplay: true,
+  display: {
+    count: 2,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: true,
+    // Bitmaps render into the 160x160 2bpp navigation widget. The resolution
+    // below remains the existing text-display placeholder until hardware
+    // screen information is available.
+    resolution: {width: 640, height: 400},
+    maxTextLines: 5,
+    adjustBrightness: true,
+  },
+  hasMicrophone: true,
+  microphone: {
+    count: 2,
+    hasVAD: false,
+  },
+  hasSpeaker: false,
+  speaker: null,
+  hasIMU: true,
+  imu: null,
+  hasButton: true,
+  button: {
+    count: 2,
+    buttons: [
+      {
+        type: "press",
+        events: ["press", "double_press", "long_press"],
+        isCapacitive: true,
+      },
+      {
+        type: "press",
+        events: ["press", "double_press", "long_press"],
+        isCapacitive: true,
+      },
+    ],
+  },
+  hasLight: false,
+  light: null,
+  power: {
+    hasExternalBattery: false,
+  },
+  hasWifi: false,
+  hasOta: false,
+}

package/src/types/capabilities/none.ts

@@ -73,4 +73,7 @@ export const none: Capabilities = {
 
   // WiFi capabilities - does not support WiFi
   hasWifi: false,
+
+  // OTA capabilities - none profile does not support OTA
+  hasOta: false,
 };

package/src/types/capabilities/simulated-glasses.ts

@@ -73,4 +73,7 @@ export const simulatedGlasses: Capabilities = {
 
   // WiFi capabilities - does not support WiFi
   hasWifi: false,
+
+  // OTA capabilities - simulated glasses do not support OTA
+  hasOta: false,
 };

package/src/types/capabilities/vuzix-z100.ts

@@ -61,4 +61,7 @@ export const vuzixZ100: Capabilities = {
 
   // WiFi capabilities - does not support WiFi
   hasWifi: false,
+
+  // OTA capabilities - Z100 firmware updates are not driven by the ASG OTA flow
+  hasOta: false,
 };

package/src/types/enums.ts

@@ -11,6 +11,7 @@ export enum DeviceTypes {
   Z100 = "Vuzix Z100",
   NEX = "Mentra Display",
   FRAME = "Brilliant Frame",
+  NIMO = "NIMO",
 }
 
 export enum ControllerTypes {

package/src/types/hardware.ts

@@ -4,6 +4,7 @@ import { evenRealitiesG1 } from "./capabilities/even-realities-g1";
 import { evenRealitiesG2 } from "./capabilities/even-realities-g2";
 import { mentraDisplay } from "./capabilities/mentra-display";
 import { mentraLive } from "./capabilities/mentra-live";
+import { nimo } from "./capabilities/nimo";
 import { simulatedGlasses } from "./capabilities/simulated-glasses";
 import { vuzixZ100 } from "./capabilities/vuzix-z100";
 import { none } from "./capabilities/none";
@@ -158,7 +159,7 @@ export interface Capabilities {
   hasWifi: boolean;
 
   // OTA capability
-  hasOta?: boolean;
+  hasOta: boolean;
 
   // Native dashboard capability
   // True when the device renders its own dashboard in firmware (e.g. Even
@@ -180,6 +181,7 @@ export const HARDWARE_CAPABILITIES: Record<string, Capabilities> = {
   [mentraLive.modelName]: mentraLive,
   [simulatedGlasses.modelName]: simulatedGlasses,
   [vuzixZ100.modelName]: vuzixZ100,
+  [nimo.modelName]: nimo,
   [DeviceTypes.MACH1]: vuzixZ100, // Mach1 uses same Vuzix Ultralite hardware as Z100
   [DeviceTypes.AR99]: {
     ...evenRealitiesG1,
@@ -207,4 +209,4 @@ export const getModelCapabilities = (deviceType: DeviceTypes): Capabilities => {
 };
 
 // export * from "./capabilities"
-export { simulatedGlasses, evenRealitiesG1, evenRealitiesG2, mentraLive, vuzixZ100, mentraDisplay };
+export { simulatedGlasses, evenRealitiesG1, evenRealitiesG2, mentraLive, nimo, vuzixZ100, mentraDisplay };

package/src/types/index.ts

@@ -25,6 +25,7 @@ export {
   evenRealitiesG1,
   evenRealitiesG2,
   mentraLive,
+  nimo,
   vuzixZ100,
   mentraDisplay,
 } from "./hardware"

package/src/utils/display/composer/ColumnComposer.ts

@@ -11,7 +11,7 @@
  * 2. Merges columns line-by-line with pixel-precise space padding
  * 3. Returns a single pre-composed string ready for native to chunk & send
  *
- * @see cloud/issues/026-mobile-display-processor for design docs
+ * @see notes/miniapp-display-api-redesign.md for the current display design
  */
 
 import type { DisplayProfile } from "../profiles/types";