seedhammer-v1-companion/gui/doc.go
mineracks 3696dd6b34 Initial skeleton — Phase 1 scaffolding
A browser-based companion for SeedHammer v1 hardware. Three coordinated
PWAs (composer, emulator, combined-sim) plus an optional Android wrapper,
inspired by Gangleri42's SeedHammer II fork but retargeted to v1's
Pi-Zero / WaveShare / MarkingWay hardware.

What's in this commit:

- LICENSE: Unlicense (matching upstream)
- README.md: project overview + status + roadmap
- CREDITS.md: upstream provenance + pinned baseline SHAs
- docs/architecture/: five authoritative design docs (lifted from
  the prep work in mineracks-infrastructure):
  * BASELINES.md — pinned SHAs, license audit, path-mapping table
  * v1-engrave-spec.md — MarkingWay USB-serial wire protocol audit
  * v1-buttons-and-ui.md — GPIO map, UI screen flow, keyboard map
  * sh1e-spec.md — composer-to-Pi envelope format spec
  * seedsigner-reuse.md — Pyodide strategy + jumbo (SeedSigner+) support
- Go package skeleton with doc.go contracts:
  backup, bezier, bspline, engrave, engrave/wire, engrave/wire/sh1e,
  font (+ comfortaa, poppins, constant), gui, input, internal/golden,
  platform/v1
- cmd/ entrypoints with stub main(): composer, emulator, combined-sim,
  seedsigner-sim
- web/ static-shell skeleton
- go.mod (module github.com/mineracks/seedhammer-v1-companion, Go 1.22)
- go build ./... + go vet ./... both clean

Next: lift universal packages (backup, font, bezier, bspline) from
upstream seedhammer/seedhammer at v1.3.0 verbatim.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-28 18:25:03 +10:00

23 lines
940 B
Go

// Package gui is the v1 controller's on-device UI — screen drawing, menu
// navigation, page state machine.
//
// Self-contained, hardware-abstracted: it talks to platform/ for input
// events and frame output. That abstraction lets the same gui run on a
// real Pi (via driver/wshat + driver/drm) and in the browser emulator
// (via platform/v1 + canvas).
//
// Screen flow follows the v1 controller's existing conventions:
//
// - Joystick (Up/Down/Left/Right/Center) = navigation
// - Button1 = back
// - Button2 = secondary action (hold-to-arm dry-run)
// - Button3 = primary confirm (hold-to-engrave)
//
// Hold-to-confirm distinguishes Pressed from Click with a confirmDelay
// timer (see gui.go in upstream).
//
// Status: STUB — to be lifted from upstream seedhammer/seedhammer at v1.3.0.
// Browser-emulator-specific tweaks (mock camera, keyboard event source)
// live in platform/v1, NOT in this package.
package gui