Project Away
Hands-free PC control, free and local. Webcam hand gestures drive the cursor, push-to-talk voice typing handles text, face cues gate who is dictating, and optional Wi-Fi CSI adds coarse motion confidence.
Nothing leaves your machine unless you point the optional LLM cleanup at an endpoint yourself.
Architecture
flowchart LR
CAM[Webcam] --> HL[MediaPipe Hand Landmarker]
CAM2[Optional 2nd camera] --> PAIR[Threaded capture + timestamp pairing]
CAM --> PAIR
PAIR --> HL
HL --> MV[Multi-view fusion: confidence, triangulation, handover]
MV --> NORM[Normalize + One Euro filter]
NORM --> GSM[Gesture state machine + static/TCN models]
GSM --> STEADY[Steady click + sigmoid curve + dwell/push]
CAM --> FL[MediaPipe Face Landmarker]
FL --> ASD[Active speaker + dictation gate]
MIC[Microphone] --> VAD[Silero VAD]
VAD --> ASR[faster-whisper / Parakeet]
ASD --> ASR
ASR --> CLEAN[Rule cleanup / optional LLM]
WIFI[Wi-Fi CSI or RSSI] --> CSI[Hampel + Doppler features]
CSI --> WCLS[Coarse presence/swipe classifier]
STEADY --> FUS[Fusion + event bus]
GUARD[Physical mouse/keyboard guard] --> FUS
WCLS --> FUS
FUS --> MOUSE[Cursor / click / scroll]
CLEAN --> KB[Type into active app]
FUS --> RING[Cursor ring overlay]
| Module | Role |
|---|---|
hands/ |
landmarks, One Euro filter, cursor mapping (power or sigmoid curve, per-direction speed), gesture state machine, stabilize.py (steady click, dwell) |
multicam/ |
capture.py (enumeration, camera threads, FramePairer), geometry.py (intrinsics, pose from hands, triangulation, checkerboard), calibration.py, fusion.py (per-view confidence, best-view/weighted fusion, 3D pinch, push) |
face/ |
face landmarker, active speaker, brow / mouth / wink triggers |
voice/ |
always-on + push-to-talk, ASR (vocabulary as prompt + hotwords), cleanup, numbers.py, edit.py (edit selected text) |
app/ |
runner (pipeline + device threads), tray, settings GUI, overlays, autopause.py |
bindings.py / actions.py |
trigger -> action mapping and execution |
Quickstart
Full per-OS instructions: docs/INSTALL.md. Wi-Fi sensing: docs/wifi-setup.md.
pipx install ".[all]" # Python 3.10–3.12
away setup # downloads models, checks camera + mic
away demo # synthetic end-to-end check
away run # or: away tray ; away autostart on
One-click installers (Releases page) bundle every feature: tracking, dictation, tray, settings
window and on-device training (CPU PyTorch). Parakeet/NeMo is the one exception (multi-GB,
NVIDIA-oriented; use pipx install "project-away[all,parakeet]"). Installers are ~0.4–0.8 GB; the models
(~1.6 GB, or ~0.5 GB with Whisper small) download during install on Windows and on first launch elsewhere.
- Windows: run the
setup.exe. It's unsigned, so choose More info → Run anyway, then Install. Models, start-at-sign-in, a desktop shortcut and launching the tray app are all on by default. - macOS: open the
.dmg, drag to Applications, then right-click → Open. The first launch downloads the models with a notification. Allow Camera, Microphone, Accessibility and Input Monitoring. - Linux: run the AppImage or install the
.deb; the first launch downloads the models. Mouse and keyboard control needs X11; Wayland is untested.
Customizing controls
Every control is a trigger → action binding you can change without touching code: from the
Settings window (tray → Settings..., or away settings), from the CLI, or in config.yaml
(away config path shows where it is). A running Away reloads the file within a second of a save.
Default bindings
| Trigger | Default action |
|---|---|
gesture:point (index finger) |
mouse:move (cursor) |
gesture:pinch |
mouse:click |
gesture:double_pinch |
mouse:double_click |
gesture:pinch_hold |
mouse:drag |
gesture:two_finger_scroll |
mouse:scroll |
gesture:open_palm (hold) |
pause:toggle (pause/resume gestures) |
gesture:swipe_left / swipe_right |
key:left / key:right |
face:brow_raise (needs face.brow_raise_toggle: true) |
dictation:toggle |
face:mouth_open (needs face.mouth_open_trigger: true) |
none |
face:wink_left / wink_right (needs face.wink_trigger: true) |
mouse:click / mouse:right_click |
gesture:dwell (needs hands.dwell.enabled: true) |
mouse:click |
gesture:push (needs depth: two calibrated cameras, or hands.multicam.push_monocular) |
mouse:click |
hotkey:ptt (= voice.hotkey, Ctrl+Alt+Space) |
dictation:toggle |
hotkey:mute (= voice.mute_hotkey, Ctrl+Alt+M) |
mic:toggle |
voice:"click", "double click", "right click", "scroll up", "scroll down" |
the matching mouse: action |
voice:"go back" / "go forward" |
key:alt+left / key:alt+right |
voice:"open browser" |
launch:https://www.google.com |
voice:"stop listening" / "start listening" |
dictation:stop / dictation:start |
voice:"command mode" / "dictation mode" |
voice:command_mode / voice:dictation_mode |
voice:"pause gestures" / "resume gestures" |
pause:on / pause:off |
Triggers: the gestures above plus your own (record with away record --custom --label wave, then
away calibrate), any spoken phrase (matched ignoring case and punctuation), face:brow_raise,
face:mouth_open, face:wink_left|wink_right, gesture:dwell, gesture:push, and any key combo
(hotkey:ctrl+alt+k). Two fixed hotkeys sit outside the bindings: app.toggle_hotkey (default F9,
gestures on/off) and voice.edit_hotkey (default Ctrl+Alt+E, edit the selected text by voice).
Actions: none · mouse:click|double_click|right_click|middle_click|scroll_up|scroll_down
(mouse:move, mouse:drag, mouse:scroll only on point / pinch_hold / two_finger_scroll) ·
key:ctrl+tab · type:any text · launch:firefox or launch:https://… (no shell) ·
shell:command (off unless bindings.allow_shell: true) · dictation:toggle|start|stop ·
mic:toggle|on|off · voice:command_mode|dictation_mode|toggle_mode · pause:toggle|on|off.
Per-app profiles
default holds the full map. Any other profile names the apps (process names, case-insensitive,
.exe optional) it applies to and overrides only the triggers it lists; everything else falls through
to default. active_profile: auto switches profile with the focused app (Linux needs xdotool);
away profile use chrome pins one.
CLI
away bindings list [--profile chrome] [--json]
away bindings set gesture:swipe_left key:alt+left
away bindings set "voice:new tab" key:ctrl+t --profile chrome
away bindings reset [TRIGGER] [--profile NAME | --all]
away bindings export my-controls.yaml # or "-" for stdout
away bindings import my-controls.yaml [--replace] # default merges
away profile list | use NAME|auto | new NAME --apps chrome chrome.exe [--copy-from default] | remove NAME
away voice show | mode always_on|push_to_talk|toggle | wake-word away|off | intent dictation|command | sensitivity 0.6
away settings # GUI editor (tkinter); prints CLI help when there is no display
away update --check # current vs latest release (exit 0 up to date, 10 update available)
away update [--yes] # download, verify SHA-256, install (see "Updates")
Invalid configs fail with every problem listed and its YAML path, e.g.
bindings.profiles.default.gestures.pinchh: unknown gesture 'pinchh' (did you mean 'pinch'?).
Tunables
Sliders in the Settings window, or in YAML: hands.cursor.gain (sensitivity), dead_zone,
acceleration, One Euro min_cutoff / beta / d_cutoff; hands.gestures.pinch_on / pinch_off
(pinch threshold), scroll_gain (scroll speed), swipe_min_dx + swipe_max_time (swipe velocity =
distance / time), double_pinch_window, drag_hold, clutch_hold; voice.vad_sensitivity,
end_silence_ms, max_utterance_s. Each is range-checked.
Pointer accuracy:
- Steady click (
hands.cursor.click_freeze: true): the cursor freezes while the pinch is closing (ratio belowpinch_on * (1 + freeze_margin)), and the click lands where the cursor wasclick_rewind_ms(100) before closing began, because closing thumb and index drags the index tip. Drags unfreeze immediately. - Curve (
hands.cursor.curve):sigmoid(default) gives a slow plateau (sigmoid_low) for precise work and a fast plateau (sigmoid_high) withsigmoid_mid/sigmoid_slopein between.poweris the original|d|^accelerationcurve.speed_up/down/left/rightscale each direction, for limited reach or an angled camera. The sigmoid idea comes from Google Project Gameface (Apache-2.0) and is re-implemented. - Dwell click (
hands.dwell): rest the cursor withinradius_pxfortime_sandgesture:dwellfires. - Face clicks:
face.wink_trigger/wink_threshold/wink_open_max/wink_hold, plusbrow_threshold,mouth_thresholdand the hold times. Thresholds are per user, so tune them in Settings. - Cursor ring (
cursor_overlay: trueoraway run --cursor-overlay): a small ring by the pointer that fills as the pinch closes, turns solid on pinch, blue while dragging, purple while dwelling and grey when paused. - Auto-pause (
app.auto_pause: true): touching the real mouse or keyboard pauses gesture output until it has been idle forapp.auto_pause_idle_ms. Away's own synthetic input is ignored.
Dictation extras: the vocabulary file is passed to faster-whisper as initial_prompt and as
hotwords (when the installed version supports it; 1.2.1 does). voice.numbers_as_digits turns
"twenty five" into 25 from numbers_min_value (10) up. voice.edit_hotkey works like this:
select text, press the hotkey, say an instruction ("uppercase", "replace cat with dog", "clean it up",
"make it a bullet list", or anything else when an LLM endpoint is configured), then press it again.
Voice input modes
voice.mode is always_on (default), push_to_talk (hold voice.hold_key) or toggle (press
voice.hotkey).
Always-on listens continuously, cuts speech into utterances with an energy VAD (end-pointing after
end_silence_ms of silence) and decides per utterance:
- Wake word on (
voice.wake_word_enabled: true,wake_word: away): only utterances starting with the wake word count ("away, scroll down"). A bare "away" opens awake_windowfor the next utterance. - Wake word off: text is typed only when the face gate agrees that you are at the screen and your
mouth is moving (active-speaker detection), so TV or background talk is ignored. With no camera,
voice.ambient_fallback: commands_only(default) runs bound phrases but types nothing. voice.intent: commandnever types, it only runs voice commands. Say "command mode" / "dictation mode" to switch.- "stop listening" / "start listening", the mute hotkey and the tray's Mic on item control it. The tray icon shows the state (green active, red mic off, amber not listening, blue recording, grey paused).
- Audio is kept in memory only and dropped after transcription. Nothing is written to disk.
app.always_on: true (default) makes gestures and voice active as soon as the app starts;
false starts paused and muted until you resume from the tray. app.start_minimized: false also opens
Settings at launch.
Example config.yaml
app:
always_on: true
start_minimized: true
voice:
mode: always_on # always_on | push_to_talk | toggle
wake_word_enabled: false
wake_word: away
intent: dictation # dictation | command
vad_sensitivity: 0.5
mute_hotkey: <ctrl>+<alt>+m
hands:
cursor: {curve: sigmoid, gain: 2.2, dead_zone: 0.004, min_cutoff: 1.0, beta: 0.02, click_freeze: true}
gestures: {pinch_on: 0.32, pinch_off: 0.45, scroll_gain: 40.0, swipe_min_dx: 0.25, swipe_max_time: 0.45}
bindings:
active_profile: auto
allow_shell: false
custom_gestures: [wave]
profiles:
default:
gestures:
swipe_left: key:alt+left
swipe_right: key:alt+right
wave: launch:https://calendar.google.com
voice:
"screenshot": key:cmd+shift+s
hotkeys:
ctrl+alt+d: type:Best regards,
chrome:
apps: [chrome, chrome.exe, Google Chrome]
gestures:
two_finger_scroll: key:ctrl+tab
voice:
"new tab": key:ctrl+t
"close tab": key:ctrl+w
code:
apps: [code, Code.exe]
gestures:
open_palm: key:ctrl+shift+p # open palm no longer pauses in VS Code
Multi-camera
A laptop webcam and an external camera can work together. A hand that one camera sees edge-on, or that is occluded, is usually clear in the other.
away cameras list # V4L2 names on Linux; probes indices on Windows/macOS
away cameras add 2 # index, /dev/video2, or part of the name ("brio")
away calibrate-cameras # wave an open hand through both views for ~20 s
away calibrate-cameras --method checkerboard --checkerboard 9x6 --square-mm 25 # accurate option
away calibrate-cameras --print-board board.png --checkerboard 9x6 # printable board
The same is available in Settings → Cameras (device pickers, roles, calibrate button, live per-camera confidence). In YAML:
hands:
cameras: # empty (default) = single-camera mode, unchanged
- {device: 0, role: primary, width: 640, height: 480, fps: 30, hfov_deg: 70}
- {device: "Logitech BRIO", role: secondary, width: 1280, height: 720, fps: 30, hfov_deg: 78}
multicam:
fusion: weighted # weighted | best_view
pair_tolerance_ms: 40
dropout_ms: 300
handover_decay_s: 1.0
use_3d_pinch: true
push_distance_m: 0.06
push_time_s: 0.35
How it works:
- Capture. Each camera runs in its own thread and stamps frames on arrival. The primary camera
sets the pace. Each secondary contributes the frame nearest in time, if it falls within
pair_tolerance_ms. A camera that stays silent fordropout_msis treated as dropped and the others carry on. - Per-view confidence. Each view is scored on the MediaPipe handedness score, the share of landmarks inside the image, hand size in pixels, and sharpness (Laplacian variance of the hand crop, which drops with motion blur).
- Fusion.
- Uncalibrated:
best_viewtakes the most confident view.weightedaverages the views by confidence after mapping secondaries into the primary image with an alignment learned while both cameras see the hand. - Calibrated, with both cameras seeing the hand: the 21 landmarks are triangulated
(
cv2.triangulatePoints). Reprojecting them into the primary view drives the cursor, and the 3D points give true depth.
- Uncalibrated:
- Depth uses.
gesture:push: the hand movespush_distance_mtoward the screen withinpush_time_s. The primary camera is assumed to sit at the screen. The gesture is bindable and clicks by default.- 3D pinch: the pinch ratio comes from 3D distances, so a thumb and index that only overlap from one angle no longer click.
- Occlusion handover. When one view loses the hand, tracking continues from the other. The jump
between estimates is absorbed by an offset that fades over
handover_decay_s, so the One Euro filter sees a continuous signal and the cursor does not jump.
Calibration. The hand-motion path pairs MediaPipe landmarks across views and runs
cv2.findFundamentalMat (RANSAC, then a least-squares refit on the inliers) → E = K2ᵀ F K1 →
cv2.recoverPose. Intrinsics are approximated from hfov_deg, and the translation is scaled so the
median palm (wrist to middle knuckle) is palm_length_m (9 cm). Depth is therefore approximately
metric; real palms vary by about 10–15%. The checkerboard path runs calibrateCamera per camera, then
stereoCalibrate with the real square size. Either way the extrinsics go to
<data dir>/camera_extrinsics.json and the reprojection error is printed.
Each view runs its own MediaPipe instance in sequence, so two cameras cost about twice the CPU of one.
Updates
The installed app checks GitHub Releases when the tray starts and every 24 hours. When a new version is out
you get a notification and an Update to vX.Y.Z tray item; clicking it downloads the installer for your
system, checks its SHA-256 (from the GitHub API digest, or the release's SHA256SUMS.txt; an unverifiable
file is refused), installs it and restarts the app. Windows runs the Inno Setup installer silently; macOS
swaps the .app from the .dmg after the app quits; an AppImage is replaced in place; a .deb is installed
with pkexec apt install only after you confirm. pip/pipx installs are never touched: run
pipx upgrade project-away.
updates:
check: true # false = never contact GitHub
auto_install: false # true = install silently when gestures are paused or idle (never for .deb)
channel: stable # beta = also offer pre-releases
The only network request is an anonymous GET to the public GitHub Releases API; nothing about you is sent.
Same options under Settings → Voice & input; from a terminal: away update --check / away update --yes.
Verified vs untested
| Area | Status |
|---|---|
| Core logic (filters, state machine, cleanup, CSI features, fusion, bindings, dispatch, always-on voice policy) | 661 tests pass (1 skipped where libtk is missing); ruff + mypy clean |
| Multi-camera geometry | Synthetic: two virtual cameras with known extrinsics. Pose from noisy (0.5 px) hand landmarks within 1.5°, palm-scaled baseline within 10%, exact noise-free triangulation, checkerboard stereo calibration under 0.5 px |
| Multi-camera fusion | Synthetic: best-view and weighted selection, timestamp pairing and dropout, occlusion handover with no jump, push gesture, 3D pinch rejecting an edge-on false pinch, Cameras-tab model |
| Real two-camera capture, calibration and fusion | Untested (no cameras in the build sandbox) |
| Steady click, sigmoid curve, dwell, wink, auto-pause guard, cursor ring states, numbers to digits, edit-selection rules | Logic unit-tested with synthetic input |
faster-whisper hotwords |
Parameter verified on the installed faster-whisper 1.2.1 by signature; not run on real speech |
| Cursor ring window, pynput auto-pause listeners, F9 / edit hotkeys, clipboard edit flow | Untested on real desktops |
| Static pose model | 99.27% acc / 0.982 macro-F1 on 4,094 HaGRID v2 samples from 520 unseen people (MediaPipe-annotated, not live webcam) |
| Temporal gesture model | Synthetic only. Off by default until away calibrate |
| MediaPipe hands/face on real photos | Verified |
| faster-whisper + Silero VAD on synthetic speech | Verified |
PicoScenes .csi parsing on sample file |
Verified |
Linux bundle, AppImage (aarch64), .deb |
Earlier lean bundle (without torch) built and launched in the sandbox; the full bundle is CI-verified on tag only |
| Settings window (tkinter) | Model logic unit-tested; window smoke-tested under Xvfb (Linux) only |
| Always-on voice | End-pointing, wake word and face-gate policy tested with synthetic audio; untested with a real mic/ASR |
| Per-app profile detection (active window process) | Untested on real desktops (Windows API / osascript / xdotool) |
| Real webcam, mic, mouse/keyboard, global hotkeys, tray, overlay | Untested |
Installer one-click flow (non-interactive setup --yes with no stdin, windowed-exe streams, first-launch download, Inno options) |
Logic unit-tested (tests/test_installer.py) |
Frozen bundle with every feature (away selftest: torch, onnx, onnxruntime, MediaPipe, OpenCV, faster-whisper + Silero VAD, PortAudio, tkinter, pynput, pystray) |
All 13 checks pass in the dev venv (Linux aarch64). The frozen build with the new bundle was not completed in the sandbox (too slow on its filesystem). Windows/macOS/Linux x86_64: CI-verified on tag only (the release workflow fails if any check fails) |
Windows .exe installer, macOS .dmg |
CI-built and smoke-tested on tag only; untested on real hardware |
Auto-update (away update, tray item) |
Version compare, asset choice, SHA-256 verify, command lines and AppImage replace unit-tested with no network (tests/test_updater.py); real installs on each OS untested |
| AX200/AX210 + PicoScenes live capture | Untested |
| Parakeet, LLM cleanup endpoint, Wayland | Untested |
Roadmap
- Real-hardware validation on Windows/macOS/Linux.
- Personal calibration data → fine-tune the temporal model on real recordings.
- Face recognition for the enrolled-user gate (currently largest face).
- TalkNet/Light-ASD active-speaker backend.
- Live AX210 CSI capture and a learned swipe/push-pull classifier.
- Phone-as-second-camera / IMU fusion.
- Real-hardware tuning of multi-camera fusion; parallel per-camera landmark inference.
Development
pip install -e ".[dev]"
pytest -q && ruff check . && ruff format --check . && mypy src
python scripts/mutation.py && python scripts/mutation.py --summary
Private project. All rights reserved by the author until a license is chosen.
Metadata
Release files for project-away 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| project_away-0.1.4.tar.gz | 489.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| project_away-0.1.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 913.7 kB
Release files / project_away-0.1.4.tar.gz
| Download URL | project_away-0.1.4.tar.gz |
|---|---|
| Size | 489.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1f72b41c288b7afb46c9676107ce2d1d07675b8e0427844c362f9c22c98899c5
|
|
BLAKE2b-256 checksum How to use checksums |
6a030a4d98d39668c5a0273722e18b70992eb2db9930fd6383d2bd313567ef29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency logRelease files / project_away-0.1.4-py3-none-any.whl
| Download URL | project_away-0.1.4-py3-none-any.whl |
|---|---|
| Size | 424.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
21e4d12c9abc23caa8fac16931a332706c7622054ac297e1d00b9b07c38eb435
|
|
BLAKE2b-256 checksum How to use checksums |
46ff2bb94d5fa5aadea56d5139c4e9e651cd47eacb3a39b7b9dc9023552fcfd8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 11, 2026.
Transparency log