Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ body:
attributes:
label: Version
description: The release you flashed (e.g. from its file name), or the commit if you built it yourself.
placeholder: v0.8.0
placeholder: v0.8.2
validations:
required: true

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,6 @@ body:
attributes:
label: Version
description: The release you are using, if the request is about something you've seen on hardware.
placeholder: v0.8.0
placeholder: v0.8.2
validations:
required: false
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
run: |
sh tools/host-tests/hostbuild.sh routetest.cc uitest.c miditest.cc miditest_alt.cc \
miditest_pickup.cc miditest_clock.cc ../../third_party/feldd/test/test_usb_rt_parse.c \
uactest.c prsttest.c
uactest.c prsttest.c cnfgtest.c
"$SP1_HOST_BUILD_DIR/routetest"
"$SP1_HOST_BUILD_DIR/uitest"
"$SP1_HOST_BUILD_DIR/miditest"
Expand All @@ -44,6 +44,7 @@ jobs:
"$SP1_HOST_BUILD_DIR/test_usb_rt_parse"
"$SP1_HOST_BUILD_DIR/uactest"
"$SP1_HOST_BUILD_DIR/prsttest"
"$SP1_HOST_BUILD_DIR/cnfgtest"

firmware:
runs-on: ubuntu-latest
Expand Down
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,23 @@

Wakes is a semimodular synthesizer, built as a custom firmware for the SP-1, an unreleased Teenage Engineering stem player that was turned into a dev board by its community.

Wakes combines two Mutable Instruments modules:
Wakes combines code from three Mutable Instruments modules:

- **Plaits**: A macro-synthesizer voice, featuring multiple sound engines
- **Marbles**: A playful random sequencer
- **Yarns**: A MIDI translator

The development of Wakes is unaffiliated with Teenage Engineering or Mutable Instruments.
**IMPORTANT:** Flash custom firmware on the SP-1 at your own risk. SP-1s are abandonware, they do not have manufacturer support. There is no way to go back to the base firmware once you've flashed it away.

**CRITICAL:** Flash custom firmware on the SP-1 at your own risk. SP-1s are abandonware, they do not have manufacturer support. There is no way to go back to the base firmware once you've flashed it away.

## 📖 Manual

**[Wakes – Manual (PDF)](docs/Wakes%20-%20Manual.pdf)**: The manual details the layout of each page, with every control and how how to use them, in an aesthetically pleasing and readable format. Once you've installed Wakes on your SP-1 using the Flashing section below, start here.
**[Wakes – Manual (PDF)](docs/Wakes%20-%20Manual.pdf)**: The manual details the layout of each page, with every control and how to use them, in an aesthetically pleasing and readable format. Once you've installed Wakes on your SP-1 using the Flashing section below, start here.

## Status

**v0.8.0, pre-release for beta testing.** Report problems with the bug form under [Issues](https://github.com/Worldwave/Wakes/issues).
**v0.8.2, pre-release for beta testing.** Report problems with the bug form under [Issues](https://github.com/Worldwave/Wakes/issues).

## Flashing

Expand All @@ -36,6 +38,17 @@ The T1+T4 recovery trigger in step 4 lives in Teenage Engineering's bootloader,
works with whatever firmware is installed. Wakes never writes below the flash memory's `0x20000` (and neither should your CFW's),
because that's where the bootloader lives.

## Configuration

Wakes keeps its settings as `.cnfg` files on its own drive, in `WAKES/CNFG/`: the engine stack
(`engines.cnfg`), MIDI (`midi.cnfg`), USB audio (`audio.cnfg`) and logging (`logs.cnfg`). Plug the
SP-1 into a computer while it's in STANDBY (OFF, with USB plugged in), edit a file in a text editor,
eject, and turn Wakes ON: it reads them at every ON. Each file explains its own settings. Delete a
file to reset it; Wakes writes a fresh copy with the defaults at the next ON. No fork or build needed.

The files in [`config/`](config/) are the defaults built into the firmware, not your device's
settings. Edit them only to build Wakes with different defaults ([`config/README.md`](config/README.md)).

## Building

Zephyr **v4.3.1** and Zephyr SDK **0.17.4**, both pinned. The workspace path must not contain
Expand All @@ -58,13 +71,14 @@ Output: `build/zephyr/wakes-sp1.bin`. The Zephyr patch is required and is lost o
| | |
|---|---|
| [`docs/UI-PAGES.md`](docs/UI-PAGES.md) | every control on every page, in detail |
| [`config/engines.csv`](config/engines.csv) | which engine sits in each of the 24 slots (editable) |
| [`config/engines.cnfg`](config/engines.cnfg) | the default engine stack: which engine sits in each of the 24 slots, and what every engine does |
| [`docs/PLAITS-ENGINES.md`](docs/PLAITS-ENGINES.md) | every engine, its faders and its CPU cost |
| [`docs/MARBLES-SETTINGS.md`](docs/MARBLES-SETTINGS.md) | Marbles models, ranges and scales |
| [`docs/DEFAULTS.md`](docs/DEFAULTS.md) | every default, and what a reset restores |
| [`docs/MIDI.md`](docs/MIDI.md) | MIDI over USB: what it does, and how to change it |
| [`config/midi.ini`](config/midi.ini) | the MIDI script: channel, legato, CC numbers (editable) |
| [`config/audio.ini`](config/audio.ini) | USB audio out: its level (parked or on VOL) and the speaker while a host records (editable) |
| [`config/midi.cnfg`](config/midi.cnfg) | the MIDI script: channel, legato, CC numbers (the default; Wakes reads `WAKES/CNFG/midi.cnfg` on its drive at every ON) |
| [`config/audio.cnfg`](config/audio.cnfg) | USB audio out: its level (parked or on VOL) and the speaker while a host records (the default; Wakes reads `WAKES/CNFG/audio.cnfg` on its drive at every ON) |
| [`config/logs.cnfg`](config/logs.cnfg) | the log Wakes writes to its drive, `WAKES/LOGS/` (the default; Wakes reads `WAKES/CNFG/logs.cnfg` on its drive at every ON) |
| [`docs/SAFETY.md`](docs/SAFETY.md) | rules for anyone changing the firmware |

## Licence
Expand Down
33 changes: 33 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# config/ — Wakes' built-in defaults

**These files are not the settings on your Wakes.** They are the defaults every firmware image is
built with. You do not need to edit them, fork this repository or build anything to change how
your Wakes behaves.

## To change your Wakes' settings

Edit the copies on Wakes' own drive:

1. Plug Wakes into a computer while it is off (STANDBY). It shows up as a drive.
2. Open `WAKES/CNFG/` and edit the file in a text editor.
3. Eject the drive and turn Wakes ON. It reads the files at every ON.

If a file is missing from `WAKES/CNFG/`, Wakes writes it there with these defaults at the next ON,
so deleting a file is how you reset it. Each file explains its own settings, and a line Wakes
cannot read keeps its default and is named in the log (`WAKES/LOGS/`).

| File | What it sets |
|---|---|
| `engines.cnfg` | which Plaits engine sits in each of the 24 slots, and what every engine does |
| `midi.cnfg` | MIDI over USB: channel, note priority, legato, portamento, which CC moves which parameter |
| `audio.cnfg` | USB audio out: its level (parked or on VOL) and the speaker while a host records |
| `logs.cnfg` | the log Wakes writes to its drive, and what goes in it |

## When to edit these

Only to build your own firmware with **different defaults**: the values a Wakes uses when its drive
has no file, and the text it writes there when one is missing. The build checks every file here and
stops, naming the line, if one is wrong, so a broken default can never ship.

You can also copy a file from here to `WAKES/CNFG/` to get a clean one back, though deleting it
from the drive does the same thing.
38 changes: 38 additions & 0 deletions config/audio.cnfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
; Format: ini
; =====================================================================================
; Wakes — the audio settings
; =====================================================================================
;
; This file configures how Wakes handles sound output. Wakes reads this file from its drive
; (WAKES/CNFG/audio.cnfg) every time it turns ON.
;
; Lines starting with ; or # are comments. They are not applied as settings.
; Every setting can be left blank to get its default.
; A line Wakes cannot read keeps its default, and the log (WAKES/LOGS/) names it.


[usb]
; USB AUDIO OUT. Plugged into a computer, phone or other USB host, Wakes shows up as an
; audio input ("Wakes Audio Out", or "Wakes" - the name depends on the host): 48 kHz,
; 16-bit stereo, no driver. It carries what the speaker and headphones get.

; level - How USB audio out sets its level:
; parked (default) =
; while a host takes USB audio, VOL is set to `parked_level` (the next parameter below)
; and VOL+/VOL- are disabled. When the host stops, VOL goes back to where you left it.
; Wakes has ONE output level controlling every output, so parking it parks the
; headphones (and the speaker, if `speaker = on`) at that level too.
; vol =
; VOL+/- are unlocked, controlling USB audio gain like everything else.
level = parked


; parked_level - 'parked' mode gainstage, in dB. Options are: -- 0, -3, -6, -9, -12,
; -15, -18, -21, -24, -27 or -30. 0 is full scale, which Wakes' loudest patches (the
; drive's top steps) reach; -6 leaves the recording device some headroom.
parked_level = -6

; speaker - enable or disable the speaker while a host takes USB audio:
; off (default) = while connected, the onboard speaker is disabled.
; on = the speaker will play the same audio that goes out over USB and the headphone jack.
speaker = off
43 changes: 0 additions & 43 deletions config/audio.ini

This file was deleted.

18 changes: 0 additions & 18 deletions config/engines-instructions.md

This file was deleted.

Loading
Loading