@therealitycrafters/react-native-evskit 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,152 @@
-# Temporary Holding Version
+# react-native-evskit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A modular Expo Module bridge for Everysight's [Maverick SDK](https://everysight.github.io/maverick_docs/) (`EvsKit` + `NativeEvsKit`), covering communication (BLE connect/pair), glasses state, display/brightness, sensors, auth, and the SDK's built-in stock UI screens.
+
+## Status
+
+The native module calls into `Evs.instance()...` are wired up in both `EvsKitModule.kt` and `EvsKitModule.swift`. The sample app consumes this package from a local `link:` dependency. You need an Everysight `sdk.key` and GitHub Packages access to compile the Android SDK.
+
+## Project layout
+
+```
+react-native-evskit/
+├─ src/
+│  ├─ EvsKit.types.ts     # Shared TS types (mirrors SDK interfaces)
+│  ├─ EvsKitModule.ts     # Raw native module binding (1:1 with SDK methods)
+│  └─ index.ts            # Public API: EvsComm / EvsGlasses / EvsDisplay /
+│                          #   EvsSensors / EvsAuth / EvsUI + useEvsKitEvent hook
+├─ android/
+│  ├─ build.gradle
+│  └─ src/main/java/expo/modules/evskit/EvsKitModule.kt
+├─ ios/
+│  ├─ RNEvsKit.podspec
+│  └─ EvsKitModule.swift
+├─ plugin/
+│  └─ withEverysightBundleResources.js  # Adds SDK key files to the app bundle
+├─ app.plugin.js            # Config plugin entry point Expo looks for
+└─ expo-module.config.json
+```
+
+The JS API is grouped to match the SDK's own `IEvsApp` service breakdown (`comm()`, `glasses()`, `display()`, `sensors()`, `auth()`), so anything in the Maverick docs maps directly onto an equivalent call here. Initialise the SDK from within a `React.useEffect`, the exported screen/component itself must remain synchronous:
+
+```ts
+import * as React from 'react';
+import { EvsKit, EvsComm, EvsDisplay, EvsSensors, useEvsKitEvent } from '@therealitycrafters/react-native-evskit';
+
+export function HomeScreen() {
+  React.useEffect(() => {
+    async function initEvsKit() {
+      await EvsKit.start();
+      if (await EvsComm.hasConfiguredDevice()) {
+        await EvsComm.connect();
+      } else {
+        await EvsKit.ui.show('configure');
+      }
+      await EvsSensors.enableTouch(true);
+      await EvsDisplay.setAutoBrightness({ enabled: true });
+    }
+
+    void initEvsKit();
+  }, []);
+
+  useEvsKitEvent('onTouch', (direction) => {
+    if (direction === 'tap') {
+      // show a popup, trigger an action, etc.
+    }
+  });
+
+  return null;
+}
+```
+
+## Setup
+
+### 1. Install this module
+
+The sample app currently uses the package directly from this repository:
+
+```json
+{
+  "dependencies": {
+    "react-native-evskit": "link:../react-native-evskit"
+  }
+}
+```
+
+From `SampleEvsKitProject/`, install dependencies with `pnpm install`. Expo autolinking discovers the package through `expo-module.config.json`. If you use another app, install the published package or use an equivalent local dependency and add `@therealitycrafters/react-native-evskit` to that app's Expo plugins.
+
+### 2. Android
+
+Follow the [Android setup guide](https://everysight.github.io/maverick_docs/libraries-api/android/):
+
+- Add the Everysight GitHub Packages Maven repo (already referenced in `android/build.gradle` — set `EVERYSIGHT_GITHUB_USERNAME` / `EVERYSIGHT_GITHUB_TOKEN` env vars, or the equivalent `gradle.properties` keys, with a PAT scoped to `read:packages`).
+- Add the `proguard-rules.pro` entries from the docs if you enable minify.
+- Place your `sdk.key` (development) or `app.key` (production) file as an Android resource.
+- Add `<uses-permission android:name="android.permission.INTERNET" />` — this module doesn't touch your `AndroidManifest.xml`, since you're likely managing permissions via an Expo config plugin already, given your `expo-build-properties` workarounds elsewhere in the project.
+
+### 3. iOS
+
+This package includes the prebuilt `EvsKit.xcframework` and `NativeEvsKit.xcframework` in its podspec. Expo autolinking adds `RNEvsKit.podspec` to the app's Podfile, and CocoaPods links both frameworks when you run `pnpm ios` or regenerate native projects.
+
+The active config plugin adds key files to the app bundle. Enable the package plugin in `app.config.ts` and provide the key path:
+
+```json
+{
+  "plugins": [
+    ["@therealitycrafters/react-native-evskit", { "bundleResources": ["./sdk.key"] }]
+  ]
+}
+```
+
+Typically, this is configured in `app.config.ts`:
+
+```ts
+['@therealitycrafters/react-native-evskit', { bundleResources: ['./sdk.key'] }]
+```
+Do not commit key files. Keep `sdk.key` at the project root and then the plugin adds it to the generated iOS Resources build phase.
+
+#### Android — GitHub Packages credentials
+
+The Everysight Android SDK is published to a private GitHub Packages Maven registry. **Anyone building an app that includes this bridge** needs a GitHub **Personal Access Token (PAT)** with the `read:packages` scope — this isn't just for developing the bridge itself, because the SDK `.aar` artifacts are pulled at build time by Gradle:
+
+1. Go to GitHub → Settings → Developer settings → Personal access tokens
+2. Click **Generate new token (classic)**
+3. Select the `read:packages` scope
+4. Generate and copy the token
+
+Set it as an environment variable before building:
+
+```bash
+export EVERYSIGHT_GITHUB_USERNAME=your-github-username
+export EVERYSIGHT_GITHUB_TOKEN=ghp_xxxxxxxxxxxx
+```
+
+Or add it to `~/.gradle/gradle.properties` (do NOT commit this file):
+
+```properties
+everysightGithubUsername=your-github-username
+everysightGithubToken=ghp_xxxxxxxxxxxx
+```
+
+You can also keep these in a `.env` file in the project root and load them before building:
+
+```bash
+source .env
+./gradlew build
+```
+
+**Make sure `.env` is in `.gitignore`** — never commit real credentials.
+
+Then run `./gradlew build` to verify.
+
+#### iOS — local Metro development
+
+When running in simulator, as you'll see in the sample app, you may need the `ios` script to run something like this `cross-env REACT_NATIVE_PACKAGER_HOSTNAME=localhost expo run:ios`.
+
+This is apparently required when macOS selects an interface such as an iPhone hotspot address (`192.0.0.2`). Without it, the simulator can try to load Metro over an HTTP address that iOS App Transport Security rejects. For another app, use `REACT_NATIVE_PACKAGER_HOSTNAME=localhost` with `expo run:ios` when the simulator and Metro run on the same Mac.
+
+## Notes / deliberate scope cuts
+
+- **BLE scanning** isn't wrapped here — the SDK docs specify scanning uses the platform's standard BLE APIs directly (`CBCentralManager` / `BluetoothLeScanner`) against `BTConstants.serviceUUID`, filtering for `EV####`-style device names. Pair this module with a BLE library (e.g. `react-native-ble-plx`) for a custom scan UI, or just call `EvsKit.ui.show('configure')` to use the SDK's built-in scan/pair screen.
+- **Custom auto-brightness providers** (`IEvsAutoBrightnessProvider`) aren't exposed to JS — round-tripping ambient-lux → brightness through the RN bridge on every reading isn't a good fit for a hot sensor loop. Use the SDK's default `AutoBrightnessGainProvider` (wired via `setAutoBrightness`) or implement a custom `IEvsAutoBrightnessController` natively if you need different behaviour.
+- The **UI Kit** (`Screen`, custom controls, animations) and **Line of Sight** kit are separate, larger surfaces not covered by this bridge — they're typically implemented natively per-screen rather than driven from JS, since they involve the glasses' own rendering pipeline.

package/android/build.gradle

@@ -0,0 +1,46 @@
+apply plugin: 'com.android.library'
+apply plugin: 'kotlin-android'
+
+group = 'expo.modules.evskit'
+version = '0.1.0'
+
+android {
+  namespace "expo.modules.evskit"
+  defaultConfig {
+    minSdkVersion getExpoModuleDefaultMinSdkVersion()
+    targetSdkVersion getExpoModuleDefaultTargetSdkVersion()
+    versionCode 1
+    versionName "0.1.0"
+  }
+  compileSdkVersion getExpoModuleDefaultCompileSdkVersion()
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_17
+    targetCompatibility JavaVersion.VERSION_17
+  }
+
+  kotlinOptions {
+    jvmTarget = "17"
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+  // Everysight SDK — see https://everysight.github.io/maverick_docs/libraries-api/android/
+  maven {
+    url = uri("https://maven.pkg.github.com/everysight-maverick/m1-android-maven")
+    credentials {
+      // Populate these via gradle.properties / env vars — do not commit real
+      // credentials. A GitHub PAT with `read:packages` scope is required.
+      username = findProperty("everysightGithubUsername") ?: System.getenv("EVERYSIGHT_GITHUB_USERNAME")
+      password = findProperty("everysightGithubToken") ?: System.getenv("EVERYSIGHT_GITHUB_TOKEN")
+    }
+  }
+}
+
+dependencies {
+  implementation project(':expo-modules-core')
+  implementation "com.everysight:evskit:2.6.1"
+  implementation "com.everysight:nativeevskit:2.6.1"
+}

package/android/src/main/java/expo/modules/evskit/EvsKitModule.kt

@@ -0,0 +1,380 @@
+package expo.modules.evskit
+
+import android.util.Base64
+import expo.modules.kotlin.modules.Module
+import expo.modules.kotlin.modules.ModuleDefinition
+import expo.modules.kotlin.Promise
+import expo.modules.kotlin.records.Field
+import expo.modules.kotlin.records.Record
+
+// ---------------------------------------------------------------------------
+// The SDK's service interfaces live in the UIKit.* package hierarchy, not
+// under com.everysight.nativeevskit.*. The Evs entry point is at
+// com.everysight.evskit.android.Evs (Android) / com.everysight.evskit.Evs
+// (generic).
+// ---------------------------------------------------------------------------
+import com.everysight.evskit.Evs
+import UIKit.services.IEvsGlassesEvents
+import UIKit.services.IEvsSensorsEvents
+import UIKit.services.IEvsYprSensorsEvents
+import UIKit.services.IEvsQuaternionSensorsEvents
+import UIKit.services.IEvsCommunicationService
+import UIKit.services.IEvsDisplayService
+import UIKit.services.IEvsAutoBrightnessController
+import UIKit.app.data.TouchDirection
+import UIKit.app.data.CalibrationStatus
+import UIKit.app.data.PowerButtonAction
+import UIKit.app.data.ProximityActionType
+import UIKit.app.data.YprData
+import UIKit.app.data.QuaternionData
+
+class DeviceInfoRecord : Record {
+  @Field val deviceId: String = ""
+  @Field val name: String = ""
+}
+
+class AutoBrightnessOptionsRecord : Record {
+  @Field val enabled: Boolean = false
+}
+
+class EvsKitModule : Module() {
+
+  // Keep a reference so listeners registered against the SDK can be torn
+  // down cleanly if the module is invalidated (app reload, etc).
+  private var glassesEventsHandle: IEvsGlassesEvents? = null
+  private var sensorsEventsHandle: IEvsSensorsEvents? = null
+
+  override fun definition() = ModuleDefinition {
+    Name("RNEvsKit")
+
+    Events(
+      "onConnectionStateChanged",
+      "onBeginAuth",
+      "onGlassesInfoChanged",
+      "onTouch",
+      "onProximity",
+      "onAmbient",
+      "onYpr",
+      "onQuaternion",
+      "onError"
+    )
+
+    OnCreate {
+      registerNativeListeners()
+    }
+
+    OnDestroy {
+      unregisterNativeListeners()
+    }
+
+    // --- Lifecycle -----------------------------------------------------------
+
+    AsyncFunction("start") { promise: Promise ->
+      try {
+        val context = appContext.reactContext ?: throw IllegalStateException("No context")
+        Evs.init(context).start()
+        if (Evs.instance().comm().hasConfiguredDevice()) {
+          Evs.instance().comm().connect()
+        }
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_START_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("isStarted") { promise: Promise ->
+      promise.resolve(Evs.isStarted())
+    }
+
+    // --- Stock UI --------------------------------------------------------------
+
+    AsyncFunction("showUI") { screen: String, promise: Promise ->
+      try {
+        Evs.instance().showUI(screen)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SHOW_UI_FAILED", e.message, e)
+      }
+    }
+
+    // --- Communication (IEvsCommunicationService) -----------------------------
+
+    AsyncFunction("setDeviceInfo") { info: DeviceInfoRecord, promise: Promise ->
+      try {
+        Evs.instance().comm().setDeviceInfo(info.deviceId, info.name)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_DEVICE_INFO_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("connect") { promise: Promise ->
+      try {
+        Evs.instance().comm().connect()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_CONNECT_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("connectSecured") { promise: Promise ->
+      try {
+        Evs.instance().comm().connectSecured()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_CONNECT_SECURED_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("disconnect") { promise: Promise ->
+      try {
+        Evs.instance().comm().disconnect()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_DISCONNECT_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("hasConfiguredDevice") { promise: Promise ->
+      promise.resolve(Evs.instance().comm().hasConfiguredDevice())
+    }
+
+    // --- Glasses (IEvsGlassesStateService) -------------------------------------
+
+    AsyncFunction("getGlassesInfo") { promise: Promise ->
+      try {
+        val glasses = Evs.instance().glasses()
+        val info = mapOf(
+          "batteryLevel" to glasses.batteryPercentage(),
+          "batteryStatus" to glasses.batteryLevel().name,
+          "estimatedRemainingTime" to glasses.estimatedRemainingTime(),
+          "firmwareVersion" to glasses.fwVersion()
+        )
+        promise.resolve(info)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_GLASSES_INFO_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("turnGlassesOff") { promise: Promise ->
+      try {
+        Evs.instance().glasses().turnOff()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_TURN_OFF_FAILED", e.message, e)
+      }
+    }
+
+    // --- Display (IEvsDisplayService) ------------------------------------------
+
+    AsyncFunction("turnDisplayOn") { promise: Promise ->
+      try {
+        Evs.instance().display().turnDisplayOn()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_TURN_DISPLAY_ON_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("setBrightness") { value: Int, promise: Promise ->
+      try {
+        Evs.instance().display().setBrightness(value)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_BRIGHTNESS_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("setBrightnessLevel") { level: Int, promise: Promise ->
+      try {
+        Evs.instance().display().desecrateBrightness().setBrightnessLevel(level)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_BRIGHTNESS_LEVEL_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("setAutoBrightness") { options: AutoBrightnessOptionsRecord, promise: Promise ->
+      try {
+        Evs.instance().display().autoBrightness().setProvider(AutoBrightnessGainProvider())
+        Evs.instance().display().autoBrightness().enable(options.enabled)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_AUTO_BRIGHTNESS_FAILED", e.message, e)
+      }
+    }
+
+    // --- Screens -----------------------------------------------------------------
+
+    AsyncFunction("setRenderingCenterX") { dx: Float, promise: Promise ->
+      try {
+        Evs.instance().screens().setRenderingCenterX(dx)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_RENDERING_CENTER_X_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("setRenderingCenterY") { dy: Float, promise: Promise ->
+      try {
+        Evs.instance().screens().setRenderingCenterY(dy)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_RENDERING_CENTER_Y_FAILED", e.message, e)
+      }
+    }
+
+    // --- Sensors (IEvsSensorsService) -------------------------------------------
+
+    AsyncFunction("enableTouch") { enabled: Boolean, promise: Promise ->
+      try {
+        Evs.instance().sensors().enableTouch(enabled)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_TOUCH_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("enableAmbient") { enabled: Boolean, promise: Promise ->
+      try {
+        Evs.instance().sensors().enableAmbient(enabled)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_AMBIENT_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("enableGyro") { enabled: Boolean, promise: Promise ->
+      try {
+        if (enabled) Evs.instance().sensors().enableGyro()
+        else Evs.instance().sensors().disableInertialSensors()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_GYRO_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("enableMagnetometer") { enabled: Boolean, promise: Promise ->
+      try {
+        if (enabled) Evs.instance().sensors().enableMagnetometer()
+        else Evs.instance().sensors().disableInertialSensors()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_MAGNETOMETER_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("enableAccelerometer") { enabled: Boolean, promise: Promise ->
+      try {
+        if (enabled) Evs.instance().sensors().enableAccelerometer()
+        else Evs.instance().sensors().disableInertialSensors()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_ACCELEROMETER_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("enableSensorsFusion") { enabled: Boolean, promise: Promise ->
+      try {
+        if (enabled) Evs.instance().sensors().enableSensorsFusion()
+        else Evs.instance().sensors().disableInertialSensors()
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_ENABLE_SENSORS_FUSION_FAILED", e.message, e)
+      }
+    }
+
+    // --- Auth (IEvsAuthService) --------------------------------------------------
+
+    AsyncFunction("setApiKeyName") { fileNameWithoutExt: String, promise: Promise ->
+      try {
+        Evs.instance().auth().setApiKeyName(fileNameWithoutExt)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_API_KEY_NAME_FAILED", e.message, e)
+      }
+    }
+
+    AsyncFunction("setApiKey") { base64Key: String, promise: Promise ->
+      try {
+        val bytes = Base64.decode(base64Key, Base64.DEFAULT)
+        Evs.instance().auth().setApiKey(bytes)
+        promise.resolve(null)
+      } catch (e: Exception) {
+        promise.reject("EVSKIT_SET_API_KEY_FAILED", e.message, e)
+      }
+    }
+  }
+
+  // ---------------------------------------------------------------------------
+  // Wires the SDK's callback-style listeners (IEvsGlassesEvents,
+  // IEvsSensorsEvents, IEvsYprSensorsEvents, IEvsQuaternionSensorsEvents) to
+  // this module's `sendEvent(...)`, so JS can subscribe via
+  // `addEvsKitListener` / `useEvsKitEvent` instead of touching native code.
+  // ---------------------------------------------------------------------------
+
+  private fun registerNativeListeners() {
+    glassesEventsHandle = object : IEvsGlassesEvents {
+      override fun onTouch(touch: TouchDirection) {
+        sendEvent("onTouch", mapOf("direction" to touch.name))
+      }
+      override fun onBatteryChanged(percentage: Int) {
+        sendEvent("onGlassesInfoChanged", mapOf("batteryLevel" to percentage))
+      }
+      override fun onChargerStateChanged(isChargerConnected: Boolean) {
+        sendEvent("onGlassesInfoChanged", mapOf("isCharging" to isChargerConnected))
+      }
+      override fun onDisplayState(isDisplayOn: Boolean) {
+        // Not mapped to JS — display state is internal
+      }
+      override fun onPowerButton(action: PowerButtonAction) {
+        // Not mapped to JS — power button is a hardware event
+      }
+      override fun onBrightnessChangeRequested(value: Short) {
+        // Not mapped to JS — brightness changes are handled by setBrightness
+      }
+    }
+    Evs.instance().glasses().registerGlassesEvents(glassesEventsHandle)
+
+    sensorsEventsHandle = object : IEvsSensorsEvents {
+      override fun onAmbient(lux: Float) {
+        sendEvent("onAmbient", lux)
+      }
+      override fun onProximity(proximity: ProximityActionType): Boolean {
+        sendEvent("onProximity", if (proximity == ProximityActionType.OnFace) "onFace" else "offFace")
+        return true
+      }
+    }
+    Evs.instance().sensors().registerSensorsEvents(sensorsEventsHandle)
+
+    Evs.instance().sensors().registerYprSensorsEvents(object : IEvsYprSensorsEvents {
+      override fun onYpr(timestampMs: Long, yprData: YprData, calibrationStatus: CalibrationStatus) {
+        sendEvent("onYpr", mapOf(
+          "timestampMs" to timestampMs,
+          "data" to mapOf("yaw" to yprData.yaw, "pitch" to yprData.pitch, "roll" to yprData.roll),
+          "calibrationStatus" to calibrationStatus.name
+        ))
+      }
+    })
+
+    Evs.instance().sensors().registerQuaternionSensorsEvents(object : IEvsQuaternionSensorsEvents {
+      override fun onQuaternion(timestampMs: Long, quaternionsData: QuaternionData, calibrationStatus: CalibrationStatus) {
+        sendEvent("onQuaternion", mapOf(
+          "timestampMs" to timestampMs,
+          "data" to mapOf(
+            "w" to quaternionsData.w,
+            "x" to quaternionsData.x,
+            "y" to quaternionsData.y,
+            "z" to quaternionsData.z
+          ),
+          "calibrationStatus" to calibrationStatus.name
+        ))
+      }
+    })
+  }
+
+  private fun unregisterNativeListeners() {
+    glassesEventsHandle?.let { Evs.instance().glasses().unregisterGlassesEvents(it) }
+    sensorsEventsHandle?.let { Evs.instance().sensors().unregisterSensorsEvents(it) }
+  }
+}

package/build/EvsKit.types.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Type definitions mirroring Everysight's Maverick SDK interfaces
+ * (IEvsCommunicationService, IEvsGlassesStateService, IEvsDisplayService,
+ * IEvsSensorsService, IEvsAuthService).
+ *
+ * Signatures confirmed against the everysight-maverick/samples repo (v2.6.1)
+ * and the MCP API reference.
+ */
+export interface EvsDeviceInfo {
+    /** Bluetooth device address/id, e.g. from a BLE scan (EV0080 style name). */
+    deviceId: string;
+    /** Bluetooth device name. */
+    name: string;
+}
+export type EvsConnectionState = "disconnected" | "connecting" | "connected" | "authenticating" | "error";
+export interface EvsGlassesInfo {
+    /** Battery percentage 0-100 from IEvsGlassesStateService.batteryPercentage(). */
+    batteryLevel: number;
+    /** Battery level category (Unknown/Critical/Low/Medium/High) from batteryLevel(). */
+    batteryStatus: string;
+    /** Estimated remaining operation time in minutes. */
+    estimatedRemainingTime: number;
+    /** Firmware version number (Int from fwVersion()). */
+    firmwareVersion: number;
+}
+export type TouchDirection = "backward" | "forward" | "tap" | "longTap";
+export type ProximityEvent = "onFace" | "offFace";
+export interface EvsAutoBrightnessOptions {
+    enabled: boolean;
+}
+export type CalibrationStatus = "calibrated" | "inProgress" | "required";
+/** Currently only rate0 and rate1 are operational per the SDK docs; the rest are experimental. */
+export type SensorRate = "rate0" | "rate1" | "rate2" | "rate3";
+export interface EvsYprData {
+    yaw: number;
+    pitch: number;
+    roll: number;
+}
+export interface EvsQuaternionData {
+    w: number;
+    x: number;
+    y: number;
+    z: number;
+}
+export interface EvsVector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface EvsSensorSample<T> {
+    timestampMs: number;
+    data: T;
+}
+export interface EvsYprSample extends EvsSensorSample<EvsYprData> {
+    calibrationStatus: CalibrationStatus;
+}
+export interface EvsQuaternionSample extends EvsSensorSample<EvsQuaternionData> {
+    calibrationStatus: CalibrationStatus;
+}
+export type EvsStockUIScreen = "configure" | "adjust" | "calibrate";
+export interface EvsBeginAuthEvent {
+    serial: string;
+    fwVersion: number;
+}
+export type EvsKitEvents = {
+    onConnectionStateChanged: (state: EvsConnectionState) => void;
+    onBeginAuth: (event: EvsBeginAuthEvent) => void;
+    onGlassesInfoChanged: (info: EvsGlassesInfo) => void;
+    onTouch: (direction: TouchDirection) => void;
+    onProximity: (event: ProximityEvent) => void;
+    onAmbient: (lux: number) => void;
+    onYpr: (sample: EvsYprSample) => void;
+    onQuaternion: (sample: EvsQuaternionSample) => void;
+    onError: (message: string) => void;
+};
+//# sourceMappingURL=EvsKit.types.d.ts.map

package/build/EvsKit.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvsKit.types.d.ts","sourceRoot":"","sources":["../src/EvsKit.types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAMH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,CAAC;IACjB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,kBAAkB,GAC5B,cAAc,GAAG,YAAY,GAAG,WAAW,GAAG,gBAAgB,GAAG,OAAO,CAAC;AAM3E,MAAM,WAAW,cAAc;IAC7B,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAC;IACrB,qFAAqF;IACrF,aAAa,EAAE,MAAM,CAAC;IACtB,qDAAqD;IACrD,sBAAsB,EAAE,MAAM,CAAC;IAC/B,sDAAsD;IACtD,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,CAAC;AAExE,MAAM,MAAM,cAAc,GAAG,QAAQ,GAAG,SAAS,CAAC;AAMlD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,OAAO,CAAC;CAClB;AAMD,MAAM,MAAM,iBAAiB,GAAG,YAAY,GAAG,YAAY,GAAG,UAAU,CAAC;AAEzE,kGAAkG;AAClG,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;AAE/D,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,UAAU;IACzB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,YAAa,SAAQ,eAAe,CAAC,UAAU,CAAC;IAC/D,iBAAiB,EAAE,iBAAiB,CAAC;CACtC;AAED,MAAM,WAAW,mBAAoB,SAAQ,eAAe,CAAC,iBAAiB,CAAC;IAC7E,iBAAiB,EAAE,iBAAiB,CAAC;CACtC;AAMD,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;AAMpE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAOD,MAAM,MAAM,YAAY,GAAG;IACzB,wBAAwB,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAC;IAC9D,WAAW,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAChD,oBAAoB,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,CAAC;IACrD,OAAO,EAAE,CAAC,SAAS,EAAE,cAAc,KAAK,IAAI,CAAC;IAC7C,WAAW,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IAC7C,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,KAAK,EAAE,CAAC,MAAM,EAAE,YAAY,KAAK,IAAI,CAAC;IACtC,YAAY,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACpD,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACpC,CAAC"}

package/build/EvsKit.types.js

@@ -0,0 +1,10 @@
+/**
+ * Type definitions mirroring Everysight's Maverick SDK interfaces
+ * (IEvsCommunicationService, IEvsGlassesStateService, IEvsDisplayService,
+ * IEvsSensorsService, IEvsAuthService).
+ *
+ * Signatures confirmed against the everysight-maverick/samples repo (v2.6.1)
+ * and the MCP API reference.
+ */
+export {};
+//# sourceMappingURL=EvsKit.types.js.map