@evenrealities/evenhub-simulator 0.1.0

package/README.md

@@ -0,0 +1,63 @@
+# EvenHub Simulator
+
+A development tool for rapid iteration and early-stage debugging of evenhub applications. This simulator allows developers to preview UI layouts and logic before running on physical hardware.
+
+## Installation
+
+```bash
+npm install -g evenhub-simulator
+```
+
+## Usage
+
+```
+EvenHub glasses app simulator
+
+Usage: evenhub-simulator [OPTIONS] [targetUrl]
+
+Arguments:
+  [targetUrl]  The URL to load on startup
+
+Options:
+  -g, --glow...         Enable glow effect on glasses display
+      --anim-spring...  Use spring bounce animation instead of default
+  -h, --help            Print help (see more with '--help')
+  -V, --version         Print version
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `-g`, `--glow` | Adds a glow effect to the display. Disabled by default as it can appear overly bold. |
+| `--anim-spring` | Replaces bounce animations with spring-style motion. Simulator-only feature. |
+
+## Caveats
+
+### Display & UI Rendering
+
+The firmware runs LVGL v9, while the simulator uses v8 (via `lvgl-sys` in Rust). 
+
+Due to library differences and other implementation differences, the overall display characteristics, like font rendering, may not perfectly mirror the hardware. However, the current fidelity is sufficient for layout validation and logic testing.
+
+### List Behavior
+
+List scrolling mechanics, specifically the screen positioning of focused items, vary across environments. This is because the simulator re-implements drawing logic rather than sharing the embedded source code directly.
+
+### Error Handling
+
+Under normal conditions, the simulator behaves nearly identically to the hardware. Error response handling (e.g., invalid inputs) may diverge but will converge as the codebase matures.
+
+### Image Processing
+
+The simulator processes images faster and currently does not impose constraints on image size or similar limitations. Future versions may introduce stricter checks to simulate hardware behavior.
+
+### Audio & Events
+
+- **Audio:** Not currently supported. Planned for a future release.
+- **Status Events:** Not emitted; user profiles and device statuses are hardcoded.
+- **Supported Inputs:** Up, Down, Click, Double-click.
+
+## Final Note
+
+This simulator is a supplement to, not a replacement for, hardware testing. Always validate on actual hardware before deployment.

package/bin/index.js

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+const { execFileSync } = require("child_process");
+
+const platform = process.platform;
+const arch = process.arch;
+const binName = platform === "win32" ? "evenhub-simulator.exe" : "evenhub-simulator";
+
+let binPath;
+try {
+  binPath = require.resolve(`@evenrealities/sim-${platform}-${arch}/bin/${binName}`);
+} catch {
+  console.error(`Unsupported platform: ${platform}-${arch}`);
+  process.exit(1);
+}
+
+try {
+  execFileSync(binPath, process.argv.slice(2), { stdio: "inherit" });
+} catch (e) {
+  process.exit(e.status || 1);
+}

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@evenrealities/evenhub-simulator",
+  "version": "0.1.0",
+  "description": "EvenHub glasses app simulator",
+  "bin": {
+    "evenhub-simulator": "bin/index.js"
+  },
+  "optionalDependencies": {
+    "@evenrealities/sim-darwin-arm64": "0.1.0",
+    "@evenrealities/sim-darwin-x64": "0.1.0",
+    "@evenrealities/sim-linux-x64": "0.1.0",
+    "@evenrealities/sim-win32-x64": "0.1.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/even-realities/evenhub-simulator"
+  },
+  "license": "MIT"
+}