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

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]);
+}