mirror of
https://github.com/mineracks/seedhammer-v1-companion.git
synced 2026-06-26 22:01:05 +10:00
3696dd6b34
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>
20 lines
819 B
Go
20 lines
819 B
Go
// Package wire is the parent for v1 wire formats.
|
|
//
|
|
// Two sub-protocols share this directory:
|
|
//
|
|
// - wire/ (this dir, future): the live MarkingWay USB-serial protocol
|
|
// spoken by the Pi controller to the physical engraver. 10-byte binary
|
|
// command frames in 80-command batches, with status-byte handshake. See
|
|
// docs/architecture/v1-engrave-spec.md for the full audit.
|
|
//
|
|
// - wire/sh1e/: the QR-transport envelope (magic + version + length +
|
|
// CRC32 + CBOR-encoded design). See docs/architecture/sh1e-spec.md.
|
|
//
|
|
// SH1E is a transport from composer to Pi; the live wire is the protocol
|
|
// the Pi speaks to the engraver. They are NOT the same and don't share an
|
|
// encoder.
|
|
//
|
|
// Status: STUB — live wire encoder to be lifted from upstream's mjolnir/
|
|
// driver at v1.3.0.
|
|
package wire
|