seedhammer-v1-companion/input/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

26 lines
841 B
Go

// Package input is the v1 controller's hardware input abstraction.
//
// On a real Pi: reads GPIO pins from the WaveShare 1.3" LCD HAT via
// periph.io (driver/wshat in upstream layout).
//
// In the browser emulator: keyboard event source from the host page,
// translated to the same Event{Button, Pressed} envelope.
//
// Eight inputs total: 5-way joystick (Up/Down/Left/Right/Center) + 3 keys
// (Button1/Button2/Button3). GPIO pin map (BCM283x):
//
// Up → GPIO 6
// Down → GPIO 19
// Left → GPIO 5
// Right → GPIO 26
// Center → GPIO 13
// Button1 → GPIO 21
// Button2 → GPIO 20
// Button3 → GPIO 16
//
// Active-low with internal pull-ups, 10 ms debounce.
//
// Status: STUB — to be lifted from upstream at v1.3.0 (driver/wshat path,
// formerly input/input.go pre the v1.2.0 refactor).
package input