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

package/ios/NativeEvsKit.xcframework/ios-arm64_x86_64-simulator/NativeEvsKit.framework/Info.plist

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleExecutable</key>
+    <string>NativeEvsKit</string>
+    <key>CFBundleIdentifier</key>
+    <string>UIKit.NativeEvsKit</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>NativeEvsKit</string>
+    <key>CFBundlePackageType</key>
+    <string>FMWK</string>
+    <key>CFBundleShortVersionString</key>
+    <string>1.0</string>
+    <key>CFBundleSupportedPlatforms</key>
+    <array>
+        <string>iPhoneSimulator</string>
+    </array>
+    <key>CFBundleVersion</key>
+    <string>1</string>
+    <key>MinimumOSVersion</key>
+    <string>14.0</string>
+    <key>UIDeviceFamily</key>
+    <array>
+        <integer>1</integer>
+        <integer>2</integer>       
+    </array>
+</dict>
+</plist>

package/ios/NativeEvsKit.xcframework/ios-arm64_x86_64-simulator/NativeEvsKit.framework/Modules/module.modulemap

@@ -0,0 +1,8 @@
+framework module "NativeEvsKit" {
+    umbrella header "NativeEvsKit.h"
+
+    export *
+    module * { export * }
+
+    use Foundation
+}

package/ios/RNEvsKit.podspec

@@ -0,0 +1,27 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, '..', 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name           = 'RNEvsKit'
+  s.version        = package['version']
+  s.summary        = package['description']
+  s.author         = ''
+  s.homepage       = 'https://github.com/patcat/react-native-evskit'
+  s.platforms      = { ios: '15.1' }
+  s.source         = { git: '' }
+  s.static_framework = true
+
+  s.dependency 'ExpoModulesCore'
+
+  # The Everysight SDK ships as prebuilt xcframeworks (EvsKit + NativeEvsKit)
+  # published on GitHub releases — there is no CocoaPods distribution and
+  # CocoaPods targets cannot consume Swift Package Manager packages. So we
+  # vendor the SDK xcframeworks here and link them through CocoaPods.
+  #
+  # The pod also compiles EvsKitModule.swift itself, which is what Expo's
+  # autolinking (ExpoModulesProvider.swift) expects: it does
+  # `import RNEvsKit` and references the module class directly.
+  s.source_files      = ['*.swift']
+  s.vendored_frameworks = ['EvsKit.xcframework', 'NativeEvsKit.xcframework']
+end

package/package.json

@@ -1,6 +1,52 @@
 {
   "name": "@therealitycrafters/react-native-evskit",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "React Native / Expo bridge for Everysight's Maverick SDK (EvsKit + NativeEvsKit)",
+  "author": "Patrick Catanzariti",
+  "homepage": "https://therealitycrafters.com",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/patcat/react-native-evskit.git"
+  },
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "source": "src/index.ts",
+  "files": [
+    "build",
+    "src",
+    "android",
+    "ios",
+    "expo-module.config.json"
+  ],
+  "scripts": {
+    "build": "expo-module build",
+    "clean": "expo-module clean",
+    "lint": "expo-module lint",
+    "prepare": "expo-module prepare",
+    "prepublishOnly": "expo-module prepublishOnly"
+  },
+  "keywords": [
+    "react-native",
+    "expo",
+    "everysight",
+    "maverick",
+    "evskit",
+    "smart-glasses"
+  ],
+  "peerDependencies": {
+    "expo": ">=57.0.0",
+    "react": ">=19.2.0",
+    "react-native": ">=0.86.0"
+  },
+  "dependencies": {
+    "@expo/config-plugins": "^8.0.0"
+  },
+  "devDependencies": {
+    "@types/react": "~19.2.18",
+    "expo": "~57.0.26",
+    "expo-module-scripts": "^4.0.0",
+    "react": "19.2.3",
+    "react-native": "0.86.3"
+  }
+}

package/src/EvsKit.types.ts

@@ -0,0 +1,122 @@
+/**
+ * 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.
+ */
+
+// ---------------------------------------------------------------------------
+// Communication (IEvsCommunicationService)
+// ---------------------------------------------------------------------------
+
+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";
+
+// ---------------------------------------------------------------------------
+// Glasses (IEvsGlassesStateService)
+// ---------------------------------------------------------------------------
+
+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";
+
+// ---------------------------------------------------------------------------
+// Display (IEvsDisplayService)
+// ---------------------------------------------------------------------------
+
+export interface EvsAutoBrightnessOptions {
+  enabled: boolean;
+}
+
+// ---------------------------------------------------------------------------
+// Sensors (IEvsSensorsService)
+// ---------------------------------------------------------------------------
+
+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;
+}
+
+// ---------------------------------------------------------------------------
+// Stock UI (Evs.instance().showUI(...))
+// ---------------------------------------------------------------------------
+
+export type EvsStockUIScreen = "configure" | "adjust" | "calibrate";
+
+// ---------------------------------------------------------------------------
+// Auth (IEvsAuthService) / lifecycle events (IEvsAppEvents)
+// ---------------------------------------------------------------------------
+
+export interface EvsBeginAuthEvent {
+  serial: string;
+  fwVersion: number;
+}
+
+// ---------------------------------------------------------------------------
+// Native event map — every event the native module can emit to JS via
+// EventEmitter. Keep this in sync with EvsKitModule.kt / EvsKitModule.swift.
+// ---------------------------------------------------------------------------
+
+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;
+};

package/src/EvsKitModule.ts

@@ -0,0 +1,65 @@
+import { NativeModule, requireNativeModule } from "expo-modules-core";
+
+import type {
+  EvsAutoBrightnessOptions,
+  EvsDeviceInfo,
+  EvsGlassesInfo,
+  EvsKitEvents,
+  EvsStockUIScreen,
+} from "./EvsKit.types";
+
+/**
+ * Raw native surface. This intentionally mirrors the SDK's service methods
+ * 1:1 (comm/glasses/display/sensors/auth) rather than inventing a different
+ * shape, so the JS API stays easy to cross-reference against the Maverick
+ * docs. Prefer using the higher-level classes exported from `src/index.ts`
+ * over calling this module directly.
+ */
+declare class EvsKitNativeModule extends NativeModule<EvsKitEvents> {
+  // --- Lifecycle -----------------------------------------------------------
+  /** Evs.init(context).start() on Android / Evs.instance().start() on iOS. */
+  start(): Promise<void>;
+  isStarted(): Promise<boolean>;
+
+  // --- Stock UI --------------------------------------------------------------
+  /** Evs.instance().showUI(name) — "configure" | "adjust" | "calibrate". */
+  showUI(screen: EvsStockUIScreen): Promise<void>;
+
+  // --- Communication (IEvsCommunicationService) -----------------------------
+  setDeviceInfo(info: EvsDeviceInfo): Promise<void>;
+  connect(): Promise<void>;
+  connectSecured(): Promise<void>;
+  disconnect(): Promise<void>;
+  hasConfiguredDevice(): Promise<boolean>;
+
+  // --- Glasses (IEvsGlassesStateService) -------------------------------------
+  getGlassesInfo(): Promise<EvsGlassesInfo>;
+  turnGlassesOff(): Promise<void>;
+
+  // --- Display (IEvsDisplayService) ------------------------------------------
+  turnDisplayOn(): Promise<void>;
+  /** Continuous brightness, 1-255. */
+  setBrightness(value: number): Promise<void>;
+  /** Discrete, display-optimized brightness controller. */
+  setBrightnessLevel(level: number): Promise<void>;
+  setAutoBrightness(options: EvsAutoBrightnessOptions): Promise<void>;
+
+  // --- Screens (rendering offset) ---------------------------------------------
+  setRenderingCenterX(dx: number): Promise<void>;
+  setRenderingCenterY(dy: number): Promise<void>;
+
+  // --- Sensors (IEvsSensorsService) -------------------------------------------
+  enableTouch(enabled: boolean): Promise<void>;
+  enableAmbient(enabled: boolean): Promise<void>;
+  enableGyro(enabled: boolean): Promise<void>;
+  enableMagnetometer(enabled: boolean): Promise<void>;
+  enableAccelerometer(enabled: boolean): Promise<void>;
+  enableSensorsFusion(enabled: boolean): Promise<void>;
+
+  // --- Auth (IEvsAuthService) --------------------------------------------------
+  setApiKeyName(fileNameWithoutExt: string): Promise<void>;
+  /** base64-encoded key bytes. */
+  setApiKey(base64Key: string): Promise<void>;
+}
+
+export default requireNativeModule<EvsKitNativeModule>("RNEvsKit");

package/src/index.ts

@@ -0,0 +1,172 @@
+import type { EventSubscription } from "expo-modules-core";
+import { useEffect } from "react";
+
+import type {
+  EvsAutoBrightnessOptions,
+  EvsDeviceInfo,
+  EvsGlassesInfo,
+  EvsKitEvents,
+  EvsStockUIScreen,
+} from "./EvsKit.types";
+import EvsKitNative from "./EvsKitModule";
+
+export * from "./EvsKit.types";
+
+/**
+ * Communication service — mirrors IEvsCommunicationService
+ * (`Evs.instance().comm()`).
+ *
+ * Scanning for glasses is NOT handled here: the SDK docs specify scanning
+ * is done with the platform's standard BLE APIs (CBCentralManager /
+ * BluetoothLeScanner) against `BTConstants.serviceUUID`, filtering for the
+ * "EV####" name pattern. Pair that with a BLE library (e.g. react-native-ble-plx)
+ * or just use `EvsUI.show('configure')` for the SDK's built-in scan/pair flow.
+ */
+export const EvsComm = {
+  setDeviceInfo(info: EvsDeviceInfo) {
+    return EvsKitNative.setDeviceInfo(info);
+  },
+  connect() {
+    return EvsKitNative.connect();
+  },
+  /** Use instead of connect() when the app requires BLE pairing. */
+  connectSecured() {
+    return EvsKitNative.connectSecured();
+  },
+  disconnect() {
+    return EvsKitNative.disconnect();
+  },
+  hasConfiguredDevice() {
+    return EvsKitNative.hasConfiguredDevice();
+  },
+};
+
+/** Mirrors IEvsGlassesStateService (`Evs.instance().glasses()`). */
+export const EvsGlasses = {
+  getInfo(): Promise<EvsGlassesInfo> {
+    return EvsKitNative.getGlassesInfo();
+  },
+  turnOff() {
+    return EvsKitNative.turnGlassesOff();
+  },
+};
+
+/** Mirrors IEvsDisplayService (`Evs.instance().display()`) plus screen offset controls. */
+export const EvsDisplay = {
+  turnOn() {
+    return EvsKitNative.turnDisplayOn();
+  },
+  /** Continuous scale, 1-255. Prefer setBrightnessLevel() where possible. */
+  setBrightness(value: number) {
+    return EvsKitNative.setBrightness(value);
+  },
+  /** Discrete brightness level via the SDK's display-optimized controller. */
+  setBrightnessLevel(level: number) {
+    return EvsKitNative.setBrightnessLevel(level);
+  },
+  setAutoBrightness(options: EvsAutoBrightnessOptions) {
+    return EvsKitNative.setAutoBrightness(options);
+  },
+  /** Adjust the virtual rendering area's center offset within the 640x400 display. */
+  setRenderingCenter(dx: number, dy: number) {
+    return Promise.all([
+      EvsKitNative.setRenderingCenterX(dx),
+      EvsKitNative.setRenderingCenterY(dy),
+    ]);
+  },
+};
+
+/**
+ * Mirrors IEvsSensorsService (`Evs.instance().sensors()`).
+ * Remember to disable sensors and unsubscribe events when no longer needed —
+ * the SDK docs call this out explicitly for battery/bandwidth reasons.
+ */
+export const EvsSensors = {
+  enableTouch(enabled: boolean) {
+    return EvsKitNative.enableTouch(enabled);
+  },
+  enableAmbient(enabled: boolean) {
+    return EvsKitNative.enableAmbient(enabled);
+  },
+  enableGyro(enabled: boolean) {
+    return EvsKitNative.enableGyro(enabled);
+  },
+  enableMagnetometer(enabled: boolean) {
+    return EvsKitNative.enableMagnetometer(enabled);
+  },
+  enableAccelerometer(enabled: boolean) {
+    return EvsKitNative.enableAccelerometer(enabled);
+  },
+  /** Enables Gyro + Magnetometer + Accelerometer and starts the fusion algorithm. */
+  enableFusion(enabled: boolean) {
+    return EvsKitNative.enableSensorsFusion(enabled);
+  },
+};
+
+/** Mirrors IEvsAuthService (`Evs.instance().auth()`). Usually unnecessary — see API Keys docs. */
+export const EvsAuth = {
+  setApiKeyName(fileNameWithoutExt: string) {
+    return EvsKitNative.setApiKeyName(fileNameWithoutExt);
+  },
+  setApiKey(base64Key: string) {
+    return EvsKitNative.setApiKey(base64Key);
+  },
+};
+
+/** Mirrors `Evs.instance().showUI(...)` — the SDK's built-in portrait UI screens. */
+export const EvsUI = {
+  show(screen: EvsStockUIScreen) {
+    return EvsKitNative.showUI(screen);
+  },
+};
+
+/** Top-level lifecycle, matching `Evs.init(context).start()` / `Evs.instance().start()`. */
+export const EvsKit = {
+  start() {
+    return EvsKitNative.start();
+  },
+  isStarted() {
+    return EvsKitNative.isStarted();
+  },
+  comm: EvsComm,
+  glasses: EvsGlasses,
+  display: EvsDisplay,
+  sensors: EvsSensors,
+  auth: EvsAuth,
+  ui: EvsUI,
+};
+
+export default EvsKit;
+
+// ---------------------------------------------------------------------------
+// Event subscription helpers
+// ---------------------------------------------------------------------------
+
+/** Subscribe to a single EvsKit event; call the returned function to unsubscribe. */
+export function addEvsKitListener<K extends keyof EvsKitEvents>(
+  eventName: K,
+  listener: EvsKitEvents[K],
+): EventSubscription {
+  return EvsKitNative.addListener(eventName, listener as any);
+}
+
+/**
+ * React hook that subscribes to an EvsKit event for the lifetime of the
+ * component. Pass a stable callback (e.g. via useCallback) to avoid
+ * resubscribing every render.
+ *
+ * @example
+ * useEvsKitEvent('onTouch', (direction) => {
+ *   if (direction === 'tap') showPopup();
+ * });
+ */
+export function useEvsKitEvent<K extends keyof EvsKitEvents>(
+  eventName: K,
+  listener: EvsKitEvents[K],
+) {
+  useEffect(() => {
+    const subscription = addEvsKitListener(eventName, listener);
+    return () => subscription.remove();
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [eventName, listener]);
+}