Skip to main content

Build setup

Ordering the board, the off-board parts, and first power-up are in the repo-root BUILD.md. This page is only the firmware compile.

Requirements​

  • Arduino IDE or arduino-cli with Teensyduino support
  • Teensy 4.1 board support
  • Libraries referenced from toern.ino / README, including:
    • Teensy Audio
    • FastLED + WS2812Serial
    • MIDI
    • i2cEncoderLibV2
    • FastTouch
    • TeensyPolyphony
    • Mapf

Custom audio sources in src/ compile with the sketch — no extra package step.

PlatformIO​

The repository includes a pinned PlatformIO environment for Teensy 4.1:

pio run                         # build .pio/build/teensy41/firmware.hex
pio run --target upload         # build and open the Teensy upload flow
pio device monitor              # 115200 baud USB serial monitor
pio run --target compiledb      # generate compile_commands.json for IDE/AI tooling

The canonical environment runs the Teensy at 816 MHz, uses smallest-code optimization (TEENSY_OPT_SMALLEST_CODE), and enables MIDI + Audio + Serial (USB_MIDI_AUDIO_SERIAL). USB audio carries the two output channels to a host. Serial is retained for the SD tool and diagnostics. Musical MIDI handlers currently use Serial8/TRS; exposing a USB MIDI interface does not implement USB note or clock handling. Its pre-build script applies the project's sampler, amplitude-ramping, and resampler changes to the pinned upstream audio libraries, so no manually edited Arduino libraries are needed.

Open the sketch​

Open toern.ino from the repo root (the folder containing all toern_*.ino files). Arduino treats that folder as one sketch.

USB type​

Match platformio.ini: MIDI + Audio + Serial. The SD server needs Serial; AudioOutputUSB needs Audio. Use the TRS ports for musical MIDI. No USB audio input is connected to the sampler.

Docs site (this site)​

Sources live in repo-root devdocs/ (same pattern as handbook/). Publish details: This docs site.

cd devdocs
npm install
npm start

Node ≥ 20 required (see package.json engines).

To produce the static files for docs.toern.live:

cd devdocs
npm run build
# rsync build/ → root@tyng.app:/var/www/docs.toern.live/

Operator handbook​

End-user docs are static HTML under handbook/, served at handbook.toern.live — not part of the marketing site or docs.toern.live.