docs: domain model structural design + ADR-0006 (Story #3) - #5
Closed
jonathanstokes wants to merge 3 commits into
Closed
docs: domain model structural design + ADR-0006 (Story #3)#5jonathanstokes wants to merge 3 commits into
jonathanstokes wants to merge 3 commits into
Conversation
A successful run puts back everything it changed; a failed run restores as best it can and names what it could not. Separate from the offline suite, never in CI. Open questions recorded: invocation mechanism, what state is actually restorable, scratch slots.
The object hierarchy designed from the manual: Device, Directory entries as a type family, the Preset/Scene grid duality, polymorphic blocks, generic typed parameters, and a full manual-feature appendix mapping every feature to the model or an explicit omission with reason. ADR-0006: at M1 the model takes the top-level namespace and the protocol layer moves to pyquadcortex.protocol.
…ing report From the domain-model design session's hardware run, all nine items. Transport (items 1-3): a read failure retries once and two in a row confirm loss - the FIRST error after an unplug is a liar, carrying the same 0xE0005000 text as the benign write stall, while the second says "Device is disconnected". DeviceLostError (bearing the second message) now raises from every transport entry point, blocked waiters are woken to fail fast, and both background threads wait quietly instead of spinning on a dead handle. The read/write asymmetry is documented as the rule it is: 0 read errors and 91 write errors over a healthy 145 s session, so which call raised is the only signal. Client (items 4-5, both verified live this session): preset_dirty() answers in 2-11 ms and flips false across a save; RecallReason names RecallPreset.reason, with host recalls carrying OTHER and a save's push carrying SAVE - measured here, extending the report's characterisation by one value. UNDO remains unobserved. Docs (items 6-9): connect burst measured at ~9 s to the seed push; GlobalTempo streams per-beat so its rate follows the tempo; a knob turn broadcasts ~40 Grid messages; lock_screen_and_volume_knob noted in settings docs. Offline tests simulate the exact unplug sequence: a lone blip is transient, two failures surface the second message, a blocked request wakes on loss rather than timing out, and the RX thread stays alive throughout.
Open
6 tasks
Contributor
Author
|
Superseded by #6. Same design content, rebuilt on current Nothing was lost in the rebuild. Every line unique to the duplicate was a superseded version of something #6 carries this PR's Part I commit unchanged, with its original message and authorship, plus Part II (Story #4) and the resolution of Part I's forward references. The M0 gate review moves to #6, where the design is complete. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The M0 structural design of the domain model (Epic #2, Story #3):
docs/domain-model.mddesigns the object hierarchy from the Quad Cortex manual - Device, the Directory as a typed entry family, the Preset/Scene grid duality, polymorphic blocks, generic typed parameters, device-level feature objects, and assignments. An appendix maps every manual feature to a model surface or an explicit omission with a reason, annotated with protocol reachability from manual-coverage.md.Also records ADR-0006 (the model takes the top-level namespace at M1; the protocol layer moves to
pyquadcortex.protocol) and carries the previously-committed ADR-0005 (hardware-in-the-loop suite).Changes
docs/domain-model.md(new): Part I structural design + full manual-feature appendix; Part II (behavior) is a stub that Story State tracking and save behavior designed and verified on hardware #4 fillsdocs/ADR.md: ADR-0006 appendeddocs/STEERING.md: ADR table row, pointer to the design doc, change log entriesTest plan
manual-coverage.md; gaps in that audit are marked unaudited rather than guessedLinked issues