@mentra/sdk 3.0.0-alpha.1 → 3.0.0-alpha.4

package/node_modules/@mentra/types/src/applet.ts

@@ -0,0 +1,55 @@
+/**
+ * @mentra/types - App/Applet types for client interfaces
+ */
+
+import { HardwareRequirement } from "./hardware";
+
+/**
+ * App execution model types
+ */
+export type AppletType = "standard" | "background" | "system_dashboard";
+
+/**
+ * Permission types that apps can request
+ */
+export type AppPermissionType =
+  | "ALL"
+  | "MICROPHONE"
+  | "CAMERA"
+  | "CALENDAR"
+  | "LOCATION"
+  | "BACKGROUND_LOCATION"
+  | "READ_NOTIFICATIONS"
+  | "POST_NOTIFICATIONS";
+
+/**
+ * Permission object with type and description
+ */
+export interface AppletPermission {
+  type: AppPermissionType;
+  description?: string;
+  required?: boolean;
+}
+
+/**
+ * Minimal app interface for client home screen display
+ * Optimized for fast rendering - only essential fields
+ *
+ * This is the client-facing interface used by mobile apps.
+ * Internal cloud services use AppI from models (more fields).
+ */
+export interface AppletInterface {
+  packageName: string;
+  name: string;
+  webviewUrl: string;
+  logoUrl: string;
+  type: AppletType;
+  permissions: AppletPermission[];
+  running: boolean;
+  healthy: boolean;
+  hardwareRequirements: HardwareRequirement[];
+  /** ISO date string when the app was installed */
+  installedDate?: string;
+  /** ISO date string when the app was last run. Undefined if never run (app is "new") */
+  lastActiveAt?: string;
+}

package/node_modules/@mentra/types/src/capabilities/even-realities-g1.ts

@@ -0,0 +1,63 @@
+/**
+ * @fileoverview Even Realities G1 Hardware Capabilities
+ *
+ * Capability profile for the Even Realities G1 smart glasses model.
+ * Defines the hardware and software features available on this device.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Even Realities G1 capability profile
+ */
+export const evenRealitiesG1: Capabilities = {
+  modelName: "Even Realities G1",
+
+  // Camera capabilities - G1 does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - G1 has a green monochrome display
+  hasDisplay: true,
+  display: {
+    count: 2,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: true,
+    resolution: { width: 640, height: 200 },
+    fieldOfView: { horizontal: 25 },
+    maxTextLines: 5,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - G1 has one microphone without VAD
+  hasMicrophone: true,
+  microphone: {
+    count: 1,
+    hasVAD: false,
+  },
+
+  // Speaker capabilities - G1 does not have a speaker
+  hasSpeaker: false,
+  speaker: null,
+
+  // IMU capabilities - G1 has IMU for head-up/down detection but raw data not exposed to apps
+  hasIMU: true,
+  imu: null,
+
+  // Button capabilities - G1 does not have buttons
+  hasButton: false,
+  button: null,
+
+  // Light capabilities - G1 does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities - G1 does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - G1 does not support WiFi
+  hasWifi: false,
+};

package/node_modules/@mentra/types/src/capabilities/even-realities-g2.ts

@@ -0,0 +1,70 @@
+/**
+ * @fileoverview Even Realities G2 Hardware Capabilities
+ *
+ * Capability profile for the Even Realities G2 smart glasses model.
+ * G2 uses the EvenHub protocol with protobuf-based commands.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Even Realities G2 capability profile
+ */
+export const evenRealitiesG2: Capabilities = {
+  modelName: "Even Realities G2",
+
+  // Camera capabilities - G2 does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - G2 has a green monochrome display (similar to G1)
+  hasDisplay: true,
+  display: {
+    count: 2,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: true,
+    resolution: { width: 640, height: 200 },
+    fieldOfView: { horizontal: 25 },
+    maxTextLines: 5,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - G2 has one microphone (right side), LC3 codec
+  hasMicrophone: true,
+  microphone: {
+    count: 1,
+    hasVAD: false,
+  },
+
+  // Speaker capabilities - G2 does not have a speaker
+  hasSpeaker: false,
+  speaker: null,
+
+  // IMU capabilities - G2 has IMU
+  hasIMU: true,
+  imu: null,
+
+  // Button capabilities - G2 has a capacitive touchbar
+  hasButton: true,
+  button: {
+    count: 1,
+    buttons: [{
+      type: "swipe1d",
+      events: ["TAP", "DOUBLE_TAP", "TRIPLE_TAP", "PRESS_HOLD", "SWIPE_UP", "SWIPE_DOWN"],
+      isCapacitive: true,
+    }],
+  },
+
+  // Light capabilities - G2 does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - G2 does not support WiFi
+  hasWifi: false,
+};

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

@@ -0,0 +1,63 @@
+/**
+ * @fileoverview Mentra Display Hardware Capabilities
+ *
+ * Capability profile for the Mentra Display smart glasses model.
+ * Defines the hardware and software features available on this device.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Mentra Display capability profile
+ */
+export const mentraDisplay: Capabilities = {
+  modelName: "Mentra Display",
+
+  // Camera capabilities - Mentra Display does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - Mentra Display has a green monochrome display
+  hasDisplay: true,
+  display: {
+    count: 2,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: true,
+    resolution: { width: 640, height: 200 },
+    fieldOfView: { horizontal: 25 },
+    maxTextLines: 5,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - Mentra Display has one microphone without VAD
+  hasMicrophone: true,
+  microphone: {
+    count: 1,
+    hasVAD: false,
+  },
+
+  // Speaker capabilities - Mentra Display does not have a speaker
+  hasSpeaker: false,
+  speaker: null,
+
+  // IMU capabilities - Mentra Display has IMU for head-up/down detection but raw data not exposed to apps
+  hasIMU: true,
+  imu: null,
+
+  // Button capabilities - Mentra Display does not have buttons
+  hasButton: false,
+  button: null,
+
+  // Light capabilities - Mentra Display does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities - Mentra Display does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - Mentra Display does not support WiFi
+  hasWifi: false,
+};

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

@@ -0,0 +1,103 @@
+/**
+ * @fileoverview Mentra Live Hardware Capabilities
+ *
+ * Capability profile for the Mentra Live smart glasses model.
+ * Defines the hardware and software features available on this device.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Mentra Live capability profile
+ */
+export const mentraLive: Capabilities = {
+  modelName: "Mentra Live",
+
+  // Camera capabilities - Mentra Live has camera with streaming
+  hasCamera: true,
+  camera: {
+    resolution: { width: 1920, height: 1080 },
+    hasHDR: false,
+    hasFocus: true,
+    video: {
+      canRecord: true,
+      canStream: true,
+      supportedStreamTypes: ["rtmp"],
+      supportedResolutions: [
+        { width: 1920, height: 1080 },
+        { width: 1280, height: 720 },
+        { width: 640, height: 480 },
+      ],
+    },
+  },
+
+  // Display capabilities - Mentra Live does not have a display
+  hasDisplay: false,
+  display: null,
+
+  // Microphone capabilities - Mentra Live has one microphone with VAD
+  hasMicrophone: true,
+  microphone: {
+    count: 1,
+    hasVAD: true,
+  },
+
+  // Speaker capabilities - Mentra Live has one standard speaker
+  hasSpeaker: true,
+  speaker: {
+    count: 1,
+    isPrivate: false,
+  },
+
+  // IMU capabilities - Mentra Live has 6-axis IMU
+  hasIMU: true,
+  imu: {
+    axisCount: 6,
+    hasAccelerometer: true,
+    hasCompass: false,
+    hasGyroscope: true,
+  },
+
+  // Button capabilities - Mentra Live has one physical button
+  hasButton: true,
+  button: {
+    count: 1,
+    buttons: [
+      {
+        type: "press",
+        events: ["press", "double_press", "long_press"],
+        isCapacitive: false,
+      },
+    ],
+  },
+
+  // Light capabilities - Mentra Live has two lights: privacy light + RGB LED
+  hasLight: true,
+  light: {
+    count: 2,
+    lights: [
+      {
+        id: "privacy",
+        purpose: "privacy",
+        isFullColor: false,
+        color: "white",
+        position: "front_facing",
+      },
+      {
+        id: "user_feedback",
+        purpose: "user_feedback",
+        isFullColor: true,
+        color: "rgb",
+        position: "user_facing",
+      },
+    ],
+  },
+
+  // Power capabilities - Mentra Live does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - Mentra Live supports WiFi
+  hasWifi: true,
+};

package/node_modules/@mentra/types/src/capabilities/none.ts

@@ -0,0 +1,76 @@
+/**
+ * @fileoverview Simulated Glasses Hardware Capabilities
+ *
+ * Capability profile for the Simulated Glasses model.
+ * Defines the hardware and software features available on this device.
+ * This profile matches the Vuzix Z100 capabilities for testing purposes.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Simulated Glasses capability profile
+ */
+export const none: Capabilities = {
+  modelName: "None",
+
+  // Camera capabilities - does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - has a green monochrome display
+  hasDisplay: false,
+  display: {
+    count: 1,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: false,
+    resolution: { width: 640, height: 480 },
+    fieldOfView: { horizontal: 30 },
+    maxTextLines: 7,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - has a microphone (phone mic)
+  hasMicrophone: false,
+  microphone: {
+    count: 1,
+    hasVAD: false,
+  },
+
+  // Speaker capabilities - has a speaker (phone speaker)
+  hasSpeaker: false,
+  speaker: {
+    count: 1,
+    isPrivate: false,
+  },
+
+  // IMU capabilities - does not have an IMU
+  hasIMU: false,
+  imu: null,
+
+  // Button capabilities - Has one simulated button
+  hasButton: false,
+  button: {
+    count: 1,
+    buttons: [
+      {
+        type: "press",
+        events: ["press"],
+        isCapacitive: false,
+      },
+    ],
+  },
+
+  // Light capabilities - does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities - does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - does not support WiFi
+  hasWifi: false,
+};

package/node_modules/@mentra/types/src/capabilities/simulated-glasses.ts

@@ -0,0 +1,76 @@
+/**
+ * @fileoverview Simulated Glasses Hardware Capabilities
+ *
+ * Capability profile for the Simulated Glasses model.
+ * Defines the hardware and software features available on this device.
+ * This profile matches the Vuzix Z100 capabilities for testing purposes.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Simulated Glasses capability profile
+ */
+export const simulatedGlasses: Capabilities = {
+  modelName: "Simulated Glasses",
+
+  // Camera capabilities - does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - has a green monochrome display
+  hasDisplay: true,
+  display: {
+    count: 1,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: false,
+    resolution: { width: 640, height: 480 },
+    fieldOfView: { horizontal: 30 },
+    maxTextLines: 7,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - has a microphone (phone mic)
+  hasMicrophone: true,
+  microphone: {
+    count: 1,
+    hasVAD: false,
+  },
+
+  // Speaker capabilities - has a speaker (phone speaker)
+  hasSpeaker: true,
+  speaker: {
+    count: 1,
+    isPrivate: false,
+  },
+
+  // IMU capabilities - does not have an IMU
+  hasIMU: false,
+  imu: null,
+
+  // Button capabilities - Has one simulated button
+  hasButton: true,
+  button: {
+    count: 1,
+    buttons: [
+      {
+        type: "press",
+        events: ["press"],
+        isCapacitive: false,
+      },
+    ],
+  },
+
+  // Light capabilities - does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities - does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - does not support WiFi
+  hasWifi: false,
+};

package/node_modules/@mentra/types/src/capabilities/vuzix-z100.ts

@@ -0,0 +1,60 @@
+/**
+ * @fileoverview Vuzix Z100 Hardware Capabilities
+ *
+ * Capability profile for the Vuzix Z100 smart glasses model.
+ * Defines the hardware and software features available on this device.
+ */
+
+import type { Capabilities } from "../hardware";
+
+/**
+ * Vuzix Z100 capability profile
+ */
+export const vuzixZ100: Capabilities = {
+  modelName: "Vuzix Z100",
+
+  // Camera capabilities - does not have a camera
+  hasCamera: false,
+  camera: null,
+
+  // Display capabilities - has a green monochrome display
+  hasDisplay: true,
+  display: {
+    count: 1,
+    isColor: false,
+    color: "green",
+    canDisplayBitmap: false,
+    resolution: { width: 640, height: 480 },
+    fieldOfView: { horizontal: 30 },
+    maxTextLines: 7,
+    adjustBrightness: true,
+  },
+
+  // Microphone capabilities - does not have a microphone
+  hasMicrophone: false,
+  microphone: null,
+
+  // Speaker capabilities - does not have a speaker
+  hasSpeaker: false,
+  speaker: null,
+
+  // IMU capabilities - does not have an IMU
+  hasIMU: false,
+  imu: null,
+
+  // Button capabilities - does not have buttons
+  hasButton: false,
+  button: null,
+
+  // Light capabilities - does not have lights
+  hasLight: false,
+  light: null,
+
+  // Power capabilities - does not have external battery
+  power: {
+    hasExternalBattery: false,
+  },
+
+  // WiFi capabilities - does not support WiFi
+  hasWifi: false,
+};