@evenrealities/evenhub-simulator 0.1.2 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +63 -19
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,6 +1,9 @@
1
1
  # EvenHub Simulator
2
2
 
3
- 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.
3
+ A development tool for rapid iteration and early-stage debugging of EvenHub applications. This simulator lets developers preview UI layouts and logic before running on physical hardware.
4
+
5
+ This simulator is a supplement to, not a replacement for, hardware testing, because inconsistencies between the simulator and real glasses can occur. Always validate on actual hardware before deployment. If you find discrepancies that affect coding logic, please file a bug report (in Discord for now) so we can reduce the differences.
6
+
4
7
 
5
8
  ## Installation
6
9
 
@@ -11,7 +14,7 @@ npm install -g @evenrealities/evenhub-simulator
11
14
  ## Usage
12
15
 
13
16
  ```
14
- EvenHub glasses app simulator
17
+ EvenHub simulator
15
18
 
16
19
  Usage: evenhub-simulator [OPTIONS] [targetUrl]
17
20
 
@@ -19,45 +22,86 @@ Arguments:
19
22
  [targetUrl] The URL to load on startup
20
23
 
21
24
  Options:
22
- -g, --glow... Enable glow effect on glasses display
23
- --anim-spring... Use spring bounce animation instead of default
24
- -h, --help Print help (see more with '--help')
25
- -V, --version Print version
25
+ -c, --config <config> Path to config file (default: OS config dir, e.g. ~/.config/evenhub/simulator.yaml on Linux/macOS or %APPDATA%\evenhub\simulator.yaml on Windows)
26
+ -g, --glow... Enable glow effect on glasses display
27
+ --no-glow... Disable glow effect (overrides config)
28
+ -b, --bounce <bounce> Bounce animation type: 'default' or 'spring' [possible values: default, spring]
29
+ --list-audio-input-devices... List available audio input devices
30
+ --aid <aid> Choose the specified audio input device instead of default
31
+ --no-aid... Use default audio device (overrides config)
32
+ --completions <SHELL> Print shell completion script [possible values: bash, elvish, fish, powershell, zsh]
33
+ -h, --help Print help (see more with '--help')
34
+ -V, --version Print version
35
+ ```
36
+
37
+ example to generate zsh completions:
38
+
39
+ ```bash
40
+ evenhub-simulator --completions zsh > ~/.zsh/completions/_evenhub-simulator
26
41
  ```
27
42
 
28
43
  ### Options
29
44
 
30
45
  | Option | Description |
31
46
  |--------|-------------|
32
- | `-g`, `--glow` | Adds a glow effect to the display. Disabled by default as it can appear overly bold. |
33
- | `--anim-spring` | Replaces bounce animations with spring-style motion. Simulator-only feature. |
47
+ | `-c`, `--config <config>` | Path to a config file. Defaults to the OS config dir (for example, `~/.config/evenhub/simulator.yaml` on Linux/macOS or `%APPDATA%\evenhub\simulator.yaml` on Windows). |
48
+ | `-g`, `--glow` / `--no-glow` | Enable or disable the glow effect on the glasses display. |
49
+ | `-b`, `--bounce <bounce>` | Sets bounce animation type: `default` or `spring`. |
50
+ | `--list-audio-input-devices` | Lists available audio input devices and exits. |
51
+ | `--aid <aid>` / `--no-aid` | Select a specific audio input device, or force the system default device. |
52
+ | `--completions <shell>` | Prints a shell completion script for `bash`, `elvish`, `fish`, `powershell`, or `zsh`. |
34
53
 
35
54
  ## Caveats
36
55
 
37
56
  ### Display & UI Rendering
38
57
 
39
- The firmware runs LVGL v9, while the simulator uses v8 (via `lvgl-sys` in Rust).
40
-
41
- 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.
58
+ Due to implementation differences, overall display characteristics (such as font rendering) may not perfectly match the hardware. The current fidelity should still be sufficient for layout validation and logic testing.
42
59
 
43
60
  ### List Behavior
44
61
 
45
- 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.
62
+ List scrolling behavior, especially focused-item positioning on screen, can vary. This happens because the simulator re-implements drawing logic instead of sharing embedded source code directly.
46
63
 
47
64
  ### Error Handling
48
65
 
49
- 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.
66
+ Under normal conditions, the simulator behaves similarly to the hardware. Error-response handling (for example, invalid inputs) may still differ, but should converge as the codebase matures.
50
67
 
51
68
  ### Image Processing
52
69
 
53
- 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.
70
+ The simulator processes images faster and currently does not enforce constraints such as hardware image-size limits. Future versions may introduce stricter checks to better simulate hardware behavior.
54
71
 
55
- ### Audio & Events
72
+ ### Events
56
73
 
57
- - **Audio:** Not currently supported. Planned for a future release.
58
74
  - **Status Events:** Not emitted; user profiles and device statuses are hardcoded.
59
- - **Supported Inputs:** Up, Down, Click, Double-click.
75
+ - **Supported Inputs:** Up, Down, Click, Double Click.
76
+
77
+
78
+ ### Audio
79
+
80
+ The simulator now emits `audioEvents`. The data specification for each event is:
81
+
82
+ - Sample rate: 16000
83
+ - Signed 16-bit little-endian PCM
84
+ - 100 ms of data per event (3200 bytes, 1600 samples)
85
+
86
+
87
+ # Changelog
88
+
89
+ ## v0.3.1 (2026-02-17)
90
+ - Adjust audio input device listing format
91
+
92
+ ## v0.3.0
93
+
94
+ - Shell completion support
95
+
96
+ ## v0.2.2
97
+
98
+ - Adjust audio resampling logic and ability to choose audio input device.
99
+ - Add config file support so you do not need to repeat common options.
100
+ - Add more command-line flags to override config options.
101
+
60
102
 
61
- ## Final Note
103
+ ## v0.2.0 (2026-02-16)
62
104
 
63
- This simulator is a supplement to, not a replacement for, hardware testing. Always validate on actual hardware before deployment.
105
+ - Upgrade `lvgl-sys` to v9 (via a custom crate), with no obvious visual changes.
106
+ - Use a lighter font for CJK characters.
107
+ - Add preliminary audio event support.
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@evenrealities/evenhub-simulator",
3
- "version": "0.1.2",
3
+ "version": "0.3.1",
4
4
  "description": "EvenHub glasses app simulator",
5
5
  "bin": {
6
6
  "evenhub-simulator": "bin/index.js"
7
7
  },
8
8
  "optionalDependencies": {
9
- "@evenrealities/sim-darwin-arm64": "0.1.2",
10
- "@evenrealities/sim-darwin-x64": "0.1.2",
11
- "@evenrealities/sim-linux-x64": "0.1.2",
12
- "@evenrealities/sim-win32-x64": "0.1.2"
9
+ "@evenrealities/sim-darwin-arm64": "0.3.1",
10
+ "@evenrealities/sim-darwin-x64": "0.3.1",
11
+ "@evenrealities/sim-linux-x64": "0.3.1",
12
+ "@evenrealities/sim-win32-x64": "0.3.1"
13
13
  },
14
14
  "license": "MIT"
15
15
  }