forked from Blendman974/faceclaw
49 lines
2.9 KiB
Markdown
49 lines
2.9 KiB
Markdown
# Head-up wake: software and hardware validation
|
||
|
||
The Android Display settings now contain “Head-up wake” and “Head-up angle”.
|
||
Glanceboard's “Show on head tilt” still only chooses which UI appears on wake.
|
||
|
||
Protocol reference: [OpenG2 Companion G2Protocol.swift](https://github.com/mmirman/open-g2-companion/blob/1400d1006ba045379a3ff34d0832add6fa10ced4/modules/ffs-ble/ios/G2Protocol.swift),
|
||
`setHeadUpSwitch` / `setHeadUpAngle`; dispatch to both lenses in
|
||
[`G2Central.swift`](https://github.com/mmirman/open-g2-companion/blob/1400d1006ba045379a3ff34d0832add6fa10ced4/modules/ffs-ble/ios/G2Central.swift).
|
||
|
||
Wire format uses Faceclaw's UI-settings sid 0x09, request flag, command 1, transaction
|
||
magic, device-receive-info field 3 / head-up field 4. Switch (field 1) and
|
||
angle (field 2) are sent in separate messages, including explicit zero values.
|
||
Angles are clamped to the reference's 0–60 degree range. No firmware patch,
|
||
firmware download or flash is needed by this implementation.
|
||
|
||
Untouched installations send neither field. The UI describes this inherited
|
||
state; its displayed ON/30 degree fallback is not a read-back of device state.
|
||
Changing just one control preserves the other device field. Explicit choices
|
||
are persisted in the existing settings store and resent on every connection.
|
||
The native session also retains them through transport reconnects and retries
|
||
after setting ACK timeouts. ACK reception confirms transport, not physical wake.
|
||
|
||
Software checks:
|
||
|
||
- `tests/head-up-wake.test.cjs`: persistence, untouched fields, angle bounds,
|
||
independence from Glanceboard, deduplication, reconnect and error recovery.
|
||
- `HeadUpProtocolTest`: byte-for-byte settings messages, including OFF and 0°.
|
||
- `GlassesSessionCoreTest`: both lenses, separate writes, pre-existing device
|
||
settings preserved, angle clamp and automatic transport reconnection.
|
||
|
||
Hardware validation: **pending**. Implementation was requested without device
|
||
access; protocol compatibility and physical effect on the target Faceclaw CFW
|
||
are not established by these software tests. The reference targets stock
|
||
2.2.6.10, while this repository normally uses newer Faceclaw firmware.
|
||
|
||
On the target glasses, record both lens firmware versions and test:
|
||
|
||
1. Leave preferences untouched and verify prior wake behavior remains unchanged.
|
||
2. Disable Head-up wake; sleep the display, raise the head repeatedly, and confirm
|
||
no wake. Check taps still wake normally.
|
||
3. Enable it and compare 0°, 30° and 60° trigger angles. Confirm other wake
|
||
gestures remain usable, including at the extreme values.
|
||
4. Reconnect Bluetooth, then restart the phone app; repeat ON/OFF and angle checks.
|
||
5. Toggle Glanceboard and “Show on head tilt” independently; disabled wake should
|
||
stay disabled, enabled wake should show the selected UI.
|
||
6. Check both lenses remain synchronized, including reconnecting only one arm.
|
||
|
||
Do not change firmware to run these checks without explicit permission.
|