memlnaut-nisps/schemas/midi_devices/README.md
monkey-w1n5t0n 7ce4598a0b chore(schemas): retire the clobbering seed script; fix the direction-of-truth text
Phase 3 (L39, ST13, ST9, ST10).

- L39: deleted codegen/seed-midi-devices.ts. It regenerated — and therefore
  silently CLOBBERED — the hand-tuned device schemas it had originally created.
  Its purpose is served and git retains it. Confirmed nothing invokes it (the
  root package.json that once might have was deleted in Phase 1).
- ST13: moved the provenance artifact out of the repo root. AUDIT CORRECTION:
  the finding's proposed destination, schemas/midi_devices/synth-midi-cc.sources.json,
  would have BROKEN codegen and CI — generate-midi-devices.ts treats every *.json
  directly under that directory as a device template and ajv-validates it, and
  the sources file has no device_id/midi/params, so the generator would exit
  non-zero. It went to schemas/midi_devices/sources/ instead.
- ST9: schemas/schema.json's own description stated the direction of truth
  BACKWARDS. Rewritten: schemas are canonical, codegen emits C++ and TypeScript.
  (The audit cited params_notes.md; the real path is schemas/modes/params_notes.md.)
- ST10: codegen/README.md rewritten against current reality — it described
  retired playground paths and a phantom temp dir.

Descriptions are never emitted, so this is behaviour-inert; proven by
regenerating all four generated directories byte-identically.
2026-07-21 14:03:07 +02:00

2.7 KiB

MIDI device templates

Canonical, committed source of truth for controlling external hardware synths over MIDI CC from NISPS — ingested by both the RP2350 firmware and the Manifold browser engine from one set of files.

Files

  • ../midi_device.schema.json — Draft 2020-12 meta-schema (validated by codegen).
  • <device>.json — one template per device. Each param: { id, cc, label, min, max, default, group }label is what humans see, cc is the MIDI Control Change number, group is a coarse UI section.
  • sources/synth-midi-cc.json — verified CC provenance + sources for every device (research artifact; kept out of the top-level dir because codegen globs *.json there as device templates).

Currently shipped (CC-controllable): moog_sub37, moog_sub_phatty, creamware_pro12_asb, elektron_analog_keys, asm_hydrasynth, roland_jd800.

Regenerate after editing

bun run codegen/generate-midi-devices.ts

Emits (do not hand-edit the outputs):

  • nisps/midi/generated/midi_devices.hpp — no-heap constexpr (firmware + WASM).
  • manifold/src/midi-devices/generated/ — typed catalogue for the browser.

Idempotent. The templates were originally machine-seeded from sources/synth-midi-cc.json (by codegen/seed-midi-devices.ts, since deleted — see git history) and are hand-tuned since; edit the <device>.json files directly.

Using it

Browser (Manifold, live at /next/): Outputs drawer → MIDI backend → Device template → pick a synth → tick the parameters to control → Apply. This fills the per-output CC table (CC#/channel/name) and the CC count; the result is savable via the named-preset bar. Parameters are shown by name, not CC number.

Firmware: one flashable variant per device. The model maps the joystick to a curated 8-param subset (pick_cc_slots prefers musical params over Bank Select / housekeeping CCs). Build + flash, e.g.:

scripts/build-and-flash-firmware.sh ExtSynthSub37
# others: ExtSynthSubPhatty ExtSynthPro12 ExtSynthAnalogKeys ExtSynthHydrasynth ExtSynthJD800

Set the synth to receive on the template's default_channel (1 by default).

Notes / caveats

  • default is a neutral midpoint (64); it's only sent when a param is fixed, not when the model is driving it live.
  • The firmware drives 8 params; the browser can drive as many as the engine has outputs. To change the firmware's default subset for a device, reorder/curate that device's params (or its groups) and regenerate — pick_cc_slots takes the first non-global params.
  • Roland JD-800 only receives a small CC set (its panel sliders emit SysEx); Korg Polysix and the Behringer "RD-9" are intentionally excluded (no usable CC).