starfleet/communicator-esp32
Watch
1
0
Fork
You've already forked communicator-esp32
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: refresh README for shipped 'computer' microwakeword v2 #4

Merged
troed merged 2 commits from devel into main 2026-08-26 21:13:06 +02:00
Conversation 0 Commits 2 Files changed 11 +143 -39
troed commented 2026-08-26 21:12:48 +02:00
Owner
Copy link

Refreshes the stale README which still described stock wn9_hiesp/Hi-ESP as pending.

  • Build & flash: document mww partition and tools/flash_models.sh.
  • Provisioning: add MicroWakeWord Kconfig table (MWW_*) with verified defaults.
  • New Wake-word section covering v2 model (59392 B, cutoff 0.50, arena 34304, 7 ear-verified captures P=1.00), components/mww engine, training pipeline, runtime trigger/selftest.
  • Host gate + Architecture updated (AEC-only, mww_task, host/mwwtest).
  • Status now reflects shipped v2 instead of pending.
Refreshes the stale README which still described stock wn9_hiesp/Hi-ESP as pending. - Build & flash: document mww partition and tools/flash_models.sh. - Provisioning: add MicroWakeWord Kconfig table (MWW_*) with verified defaults. - New Wake-word section covering v2 model (59392 B, cutoff 0.50, arena 34304, 7 ear-verified captures P=1.00), components/mww engine, training pipeline, runtime trigger/selftest. - Host gate + Architecture updated (AEC-only, mww_task, host/mwwtest). - Status now reflects shipped v2 instead of pending.
Follow-up to the public-repo security audit: tracked files carried the real LAN IP of the `computer` server and personal home paths. This replaces them with placeholders / empty defaults; real values remain local-only (gitignored `sdkconfig`, Kconfig provisioning), mirroring the policy already used in starfleet/roster.

Changes:
- `main/Kconfig.projbuild`: `SERVER_HOST` default is now `""` (was the LAN IP). Provisioning stays Kconfig-only per README.
- `README.md`: provisioning table default updated to *(empty)*.
- `AGENTS.md`: field-test checklist no longer names the real server address; "Repo & commit conventions" expanded into a **Public repo hygiene** policy (no SSIDs/passwords/tokens/hostnames/LAN IPs/usernames/home paths; pre-push scan command).
- `host/tests/test_mww_features.py`: reference WAV now resolves to the sibling `../computer` checkout (overridable via `MWW_TEST_WAV`) instead of an absolute personal path.
- `docs/superpowers/**`: plans/specs sanitized (IPs and `/home/...` paths → placeholders).
- `tools/wakeword-model/REPRODUCIBILITY.md`, `tools/wakeword-training/config_computer*.json`: absolute paths → `<repo>` / `<path-to-computer-checkout>` placeholders.
- `main/wake_chime_data.h`: provenance comment uses a generic path.

Verification: `cd host/tests && python3 -m pytest -q` → **43 passed**; hygiene scan over tracked tree clean.
Co-authored-by: Troed Sångberg <github@troed.se>
Reviewed-on: #3
Replace stale Hi-ESP/WakeNet references with the now-shipped custom
'computer' microWakeWord system: v2 int8 mixednet (tools/wakeword-model/
59392 B, cutoff 0.50, arena 34304) fine-tuned on 7 ear-verified device
captures, TFLM engine in components/mww on the mww partition via
tools/flash_models.sh, full training pipeline in
tools/wakeword-training/ (piper synthesis + OHF micro-wake-word wrapper),
continuous streaming runtime and trigger spread-evidence, selftest and
FA-capture diagnostics, updated Kconfig table, build/flash notes,
architecture and host-gate docs.
troed merged commit 532fe34a7f into main 2026-08-26 21:13:06 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
starfleet/communicator-esp32!4
No description provided.