Skip to content

docs: TeensyROM Suite replaces TeensyROM Web, UI and CLI - #87

Open
MetalHexx wants to merge 6 commits into
SensoriumEmbedded:mainfrom
MetalHexx:docs/trom-suite-docs
Open

MetalHexx wants to merge 6 commits into
SensoriumEmbedded:mainfrom
MetalHexx:docs/trom-suite-docs

Conversation

@MetalHexx

@MetalHexx MetalHexx commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

TeensyROM Suite 1.0.0-beta.1 replaced TeensyROM Web, the TeensyROM UI desktop app and TeensyROM-CLI with one suite: Trom UI (the web app, with the DJ Mixer), Trom Terminal, Trom Agent and Trom API. The TeensyROM-UI and TeensyROM-CLI repos are archived. This updates the docs that pointed at the old apps so they describe the suite as it is today and link its docs.

  • README:
    • The Remote Control list names the Suite and its four Trom apps.
    • Transfers from your computer name Trom UI, Trom Terminal and Trom Agent.
    • A DJ Mixer video joins Demo Videos.
    • The thank-you line names the Suite.
  • C64 Ultimate Enhancements:
    • Modern UI Control describes what the Suite does: the DJ Mixer, copying files and watch folders, themes, and Trom Agent as an AI companion.
    • The ASID section mentions the DJ Mixer, and the Serial / TCP section mentions Trom API.
  • ASID Player:
    • The Trom UI DJ Mixer is listed as an ASID source, with setup steps.
    • The ChipSynth preset tool is now part of Trom Terminal.
  • ControlComms, Ethernet Usage, General Usage, CONTRIBUTING, Comms-Protocol, CLAUDE.md and the steward agent: Trom API and the Suite replace the old app names.
  • Debug scripts: they name Trom API as what holds the serial port (trom api stop releases it).

Docs and comments only; no firmware, protocol or tool behavior change. Not hardware tested (nothing to test on hardware).

TeensyROM Suite 1.0.0-beta.1 replaced TeensyROM Web, the TeensyROM UI
desktop app and TeensyROM-CLI with one suite: Trom UI, Trom Terminal,
Trom Agent and Trom API. The old repos are archived, so the docs that
pointed at them now name the Suite apps and link their docs.

The C64 Ultimate page shows what the Suite does today, the DJ Mixer
joins the ASID sources, and the protocol notes name Trom API as the
client that depends on the command format.
With TeensyROM Suite, Trom API holds the cart's serial port, not a
desktop app, and it keeps holding it after the browser is closed.
`trom api stop` releases it.
The README's remote control list, transfer line and thank-you credit
pointed at TeensyROM Web, the TeensyROM UI desktop app and
TeensyROM-CLI, which TeensyROM Suite 1.0.0-beta.1 replaced. They now
describe the four Trom apps and link their docs, and a DJ Mixer video
joins Demo Videos.
Comment thread docs/ASID_Player.md Resolved
Comment thread docs/C64_Ultimate_Enhancements.md Resolved
Comment thread README.md Resolved
The README's remote control entry is back to one line, like the rest of
that list. The C64 Ultimate page calls Trom Agent what it is, an AI
companion, rather than quoting example requests. The DJ Mixer runs in
any browser with MIDI support, not only Chrome or Edge.
Both lines mean any TeensyROM app that holds the serial port, not
Trom API alone, so they go back to upstream's wording.
@MetalHexx
MetalHexx force-pushed the docs/trom-suite-docs branch from 151662a to dd25e72 Compare November 4, 2026 04:12
TeensyROM Suite adds a 64-bit ARM Linux build for Raspberry Pi, so the
places that name the Suite's platforms include it.
@MetalHexx
MetalHexx marked this pull request as ready for review November 4, 2026 04:49
Copilot AI balanced review requested due to automatic review settings November 4, 2026 04:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues remain for the documentation and comment updates introducing TeensyROM Suite.

No open issues 🎉

What changed in this PR

Updates TeensyROM documentation to present TeensyROM Suite as the successor to the separate Web, UI, and CLI apps. Changes are limited to documentation and comments; firmware, protocols, and tool behavior are unchanged.

Changes:

  • Replaces legacy app references with Trom UI, Trom Terminal, Trom Agent, and Trom API.
  • Documents Suite features, including the DJ Mixer, file transfers, themes, and ASID setup.
  • Updates contributor guidance and debug-script instructions to use current app names.
File Description
tools/​Debug/​run_z_sweep.py Updates the docstring to recommend stopping Trom API before use.
tools/​Debug/​dma_scope_write.py Updates the docstring’s serial-port release instructions.
README.md Introduces Suite apps, transfer options, and DJ Mixer videos.
docs/​General_Usage.md Links Suite tools for transferring firmware files.
docs/​Ethernet_Usage.md Describes Trom API’s network support and HTTP interface.
docs/​ControlComms.md Replaces legacy clients with Suite and Trom API entries.
docs/​C64_Ultimate_Enhancements.md Expands Suite feature descriptions and links.
docs/​ASID_Player.md Adds DJ Mixer setup and updates the preset-tool link.
docs/​Architecture/​Comms-Protocol.md Names Trom API as a protocol client.
CONTRIBUTING.md Updates companion-app and downstream dependency references.
CLAUDE.md Updates the remote-protocol dependency description.
.claude/​agents/​steward.md Updates the protocol-contract guidance to name Trom API.

Review effort: Balanced

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants