Skip to content

Docs: module notes from open reports (FM Synth, USB Audio, Euclid, Vector) - #701

Merged
repeat98 merged 1 commit into
mainfrom
docs/report-notes
Oct 19, 2026
Merged

repeat98 merged 1 commit into
mainfrom
docs/report-notes

Conversation

@repeat98

Copy link
Copy Markdown
Owner
  • What was wrong or hard: Five open reports describe behaviour the module pages don't explain, so people hit it with no warning and no workaround.
  • What this changes: Documentation only, with no firmware or version changes. Each module's README and the matching compatibility.limitations or control doc text in its manifest get the note and the workaround. Each module's current changelog entry gets a marked "Documentation-only (19 October 2026)" note. module-documents.json is regenerated.
    • FM Synth: ATK 0 with a short HOLD or REL can click; raise ATK or lengthen REL. LFO1/LFO2 list FLEX names, each standing for the FM knob in the same position (STRT is RATO, LEN is INDX, RATE is FINE, RTRG is FDBK, RTIM is DEC). Whether LFOs on them change the FM sound is not tested.
    • USB Audio: like every DRAM module, the build gives up about 10 MB of sample memory. Shorten the recorder reservation or RLEN, or load long samples into STATIC. [usb-audio-out-tracks-main-cue] Flex machine slot “out of memory” error #433 stays open in case there is also a separate allocation problem.
    • Euclid: MIX 127 is fully wet, but the wet signal is the input through the pulsed filter or amp. With the filter open or DEPTH at center it can sound dry.
    • Vector: the 0.2.4 fix covers only tracks still on VECTOR. In native.c, st_assign clears only the three marker bytes on deselect. At SPAN 8 or higher, the byte vector_pack leaves at sig+5 is the one the stock check rejects, so the bank can load empty after a save and reboot. This is read from the source and not reproduced. Workaround: set SPAN to 7 or lower before switching back, and don't SAVE a bank that already loads empty. The real fix, clearing all twelve bytes and tolerating the leftover byte on load, needs a firmware version and is not part of this PR.
  • How I checked it: npm run check -- --base origin/main and npm run pr:ready (Ready; 2,353 tests passed). Before writing the notes I read the FM page descriptor (upstream/synth/page.s) and Vector's engine.c and native.c. Nothing was run on a unit or in the emulator.

FM Synth's open update #555 also touches sdk/octabam/modules/synth/. The edits here are additive lines in the README and manifest, so any conflict should be small.


Generated by Claude Code

FM Synth: ATK 0 clicks and how to soften it (#557); LFO1/LFO2 keep FLEX's
destination names, mapped to the FM knobs (#589).
USB Audio: the ~10 MB sample-memory reserve and what frees memory (#433).
Euclid: MIX 127 is fully wet, and why it can still sound dry (#681).
Vector: switching back to STATIC/FLEX with SPAN 8+ can empty the bank
after a reboot; how to avoid it (#596, from the source, not reproduced).
Documentation-only changelog notes on each module's current version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SakBf5zGyZY61TAzvKCKHC
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 19, 2026
@repeat98 repeat98 mentioned this pull request Oct 19, 2026
@repeat98
repeat98 merged commit c3a17bc into main Oct 19, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant