diff --git a/changelog.md b/changelog.md index 96a5af2..f07cf4b 100644 --- a/changelog.md +++ b/changelog.md @@ -15,6 +15,13 @@ sustained stretch without a correction. ## Unreleased +### Conditional editor metadata is exposed + +Catalog parameters now expose `toggle_on`, `toggle_off`, and `toggle_steps` as +integer tuples: the catalog's own conditional-editor references, published +without a claim about how a host editor should act on them. Read from the CorOS +4.0.1 catalog, where 132, 83 and 13 parameters carry them. + ### Rename the unit, drive undo/redo, and read inhibited modules `set_device_name()` sends a sparse Version update. `undo()` and `redo()` drive diff --git a/docs/STEERING.md b/docs/STEERING.md index ec34ba4..3f4c7cb 100644 --- a/docs/STEERING.md +++ b/docs/STEERING.md @@ -94,7 +94,8 @@ ADR-0012. - `examples/` - runnable scripts - `docs/` - the documents listed in [`writing.md`](writing.md) - `scripts/` - `compile_protos.sh`, `check_artifacts.py`, the three generators - and `_snapshots.py`, `extract_scale_fixture.py` + and `_snapshots.py`, `extract_scale_fixture.py`, + `extract_editor_metadata_fixture.py` - `.github/workflows/` - CI ## 5. Patterns in Use diff --git a/docs/domain-model.md b/docs/domain-model.md index 75172b6..0ff7b7a 100644 --- a/docs/domain-model.md +++ b/docs/domain-model.md @@ -1193,18 +1193,26 @@ hardware, host concerns or reference text with nothing for a host API to model. ## Catalog attributes -The unit puts 24 distinct attributes on its `` elements. Seventeen are +The unit puts 24 distinct attributes on its `` elements. Twenty are parsed. What follows is what is known about the ones that matter to a caller, and -the seven that are not yet explained. Counts are from the CorOS 4.0.1 catalog, +the four that are not yet explained. Counts are from the CorOS 4.0.1 catalog, 3,809 parameters. Nothing here is guessed at: a control we do not understand is omitted with the reason written down. +### Conditional editor metadata + +`toggleOn`, `toggleOff`, and `toggleStep` occur on 132 / 83 / 13 fields, +212 parameters between them. They are exposed as `toggle_on`, `toggle_off`, +and `toggle_steps` without assigning host behaviour. The catalog shape indicates +that the first two name a conditional-visibility driver and the last names its +option: Splitter's controls partition cleanly by `TYPE`. Three Mono Synth +parameters self-reference, so those cases remain unexplained. + ### Unexplained | attribute | on | what it looks like, and what is unknown | |---|---|---| | `replaces` | 462 | Distinct from the `` attribute of the same name. On a parameter it presumably names a superseded index, which would matter for reading an old preset. Untested | -| `toggleOn`, `toggleOff`, `toggleStep` | 132 / 83 / 13, 212 parameters between them | `toggleOn` carries a number on `float` parameters such as a tremolo's `LEVEL`, and `toggleStep` sometimes carries a pair (`"0,1"`). The obvious reading is the two values a footswitch toggle alternates between. Untested | | `tooltip` | 126 | The help text the unit shows. Real prose, sometimes with content: a Vibrato's `MODE` warns that changing it causes a brief mute. The values contain HTML | | `selfTestValue` | 66 | A value the unit uses during its self test. Sometimes an IR name, sometimes a token | | `isplayPos` | 1 | `displayPos` with the `d` missing. The catalog's own typo, recorded rather than silently accepted as an alias | @@ -1358,6 +1366,10 @@ On ``, `blob` is unexplained: a same-length string that changes between reads, on 338 models and no others across the three lab captures. A per-read token, not content. +`linkedSceneMode` appears 44 times in the contributed CorOS 4.1.0 catalog and +zero times in 4.0.1. Its meaning and relationship, if any, to preset +`scene_mode` are unknown, so it is recorded here and not exposed as shared API. + On `