docs: the manual and the user guide describe the badge bar, the dock and the slide-over pages
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
1 parent
86ea0bac38
commit
328588a8b9
16 files changed
+180
-113
No files matched your search
+45
-22
@@ -6,9 +6,22 @@ what was built and why, and `SPECS.md` is the requirement document.
|
||||
|
||||

|
||||
|
||||
*The main window with a source streaming: the signal panel on the right, the plot in the middle, the
|
||||
status line directly under it, and the toolbar above. The window control — `2 s` — is the first thing
|
||||
on the left.*
|
||||
*The main window with a source streaming: the header bar above (the window control — `2 s` — first on
|
||||
the left), the plot, the badge bar under it with one badge per signal, the status line at the foot, and
|
||||
the dock on the right with the cursor and measurement readouts and the events block.*
|
||||
|
||||
The window is a plot with three things around it:
|
||||
|
||||
- the **badge bar** under the plot: a badge for each signal you have switched on, a `+` to add one
|
||||
(past six they fold into one `N signals` badge), and, on the right, **Trigger** and — only for a
|
||||
source with controls of its own — **Source**;
|
||||
- the **side panel**, which a badge opens over the plot's right edge, one page at a time: the trigger,
|
||||
a signal, the list of signals to add, the cursors, the measurements, the events, or a source's own
|
||||
controls. A second click on the badge, `Esc`, **Close** or a click on the plot closes it, and it
|
||||
never resizes the plot;
|
||||
- the **dock** on the right, which the dock button in the header bar (`s`) shows and hides: read-only
|
||||
**Readouts** of the cursors and of the measurements, each with an **Edit** button that opens its
|
||||
page, and an **Events** block.
|
||||
|
||||
## 1. Connecting
|
||||
|
||||
@@ -30,7 +43,7 @@ Every launch is its own process, so running two scopes side by side is fine.
|
||||
|
||||
## 2. The status line
|
||||
|
||||
Directly under the plot, it reads `● <state> · <rate> · <window>`, and the ⓘ beside it opens the
|
||||
At the foot of the window, under the badge bar, it reads `● <state> · <rate> · <window>`, and the ⓘ beside it opens the
|
||||
detail: packets, frames, gaps, per-channel sample counts, the buffer's span and its decimation.
|
||||
|
||||
- **The state word is one word** from a fixed set: `live`, `paused`, `armed`, `capturing`,
|
||||
@@ -44,14 +57,16 @@ detail: packets, frames, gaps, per-channel sample counts, the buffer's span and
|
||||
|
||||
## 3. Signals
|
||||
|
||||
The signal panel lists every signal the CONFIG described, with a switch each. **Signals start
|
||||
disabled — enabling one is what starts acquiring it**, and a signal nobody enables costs nothing.
|
||||
Drag a signal from the panel onto a plot row to add a trace; drag it again to another row to plot the
|
||||
same signal twice. The colour is per *signal*, so the same signal is the same colour wherever it
|
||||
appears.
|
||||
The **`+` badge** (or `g`) opens the **Signals** page, which lists what can be added: the signals the
|
||||
CONFIG described that are not acquired yet, each with a tick. **Signals start disabled — ticking one
|
||||
is what starts acquiring it**, and a signal nobody enables costs nothing. Its badge then appears in
|
||||
the badge bar. Drag the badge onto a plot row to add a trace; drag it again to another row to plot
|
||||
the same signal twice, or onto another badge to reorder the badges. The colour is per *signal*, so
|
||||
the same signal is the same colour wherever it appears.
|
||||
|
||||
The panel also holds the per-signal calibration: gain and offset, applied at ingest, so the
|
||||
measurements and the export carry the same numbers the plot shows.
|
||||
Clicking a signal's badge opens its own page: the colour, **Plot on** buttons for the rows, and
|
||||
**Calibrate** — gain and offset, applied at ingest, so the measurements and the export carry the same
|
||||
numbers the plot shows.
|
||||
|
||||
## 4. The window and navigation
|
||||
|
||||
@@ -83,8 +98,9 @@ should look like.
|
||||
*Single mode with a capture held: the axis is the event's own `[-pre, +post]`, the trigger marker
|
||||
sits at the edge, and the status line reads `event held`.*
|
||||
|
||||
The trigger panel has the edge, the pre/post split (as a share of the event span), Normal or Single,
|
||||
and Arm/Disarm. Selecting a signal for the trigger enables it.
|
||||
The trigger button in the header bar (`t`) turns trigger mode on. The **Trigger** badge opens the
|
||||
trigger page, which has the signal, the condition, the edge, the pre/post split (as a share of the
|
||||
event span), Normal or Single, and Arm/Disarm. Selecting a signal for the trigger enables it.
|
||||
|
||||
- **While a capture fills** the plot keeps drawing live data on the event's clock, so the post side
|
||||
fills in view; the axis does not move.
|
||||
@@ -94,6 +110,10 @@ and Arm/Disarm. Selecting a signal for the trigger enables it.
|
||||
when you disarm is the picture you keep.
|
||||
- The event window is counted in **stream seconds** end to end, so a source whose clock advances in
|
||||
jumps still gets the window it asked for.
|
||||
- **Events.** With *record events* on (trigger page), each latch is stored. The dock's **Events** block
|
||||
lists them newest first and **one click replays** one; **Manage** opens the full list as a page,
|
||||
where a click selects, a double click replays, and **Compare**, **Accumulate** and **Live** act on
|
||||
the selection or go back to the stream. The block is dimmed until something is recorded.
|
||||
|
||||
## 6. Pause
|
||||
|
||||
@@ -104,22 +124,24 @@ does not walk it off its snapshot.
|
||||
|
||||
## 7. Cursors
|
||||
|
||||
The cursors toolbar toggle switches on two instruments per row:
|
||||
The cursors toggle in the header bar (`c`) switches on two instruments per row:
|
||||
|
||||
- **vertical** — two times, shared by every row;
|
||||
- **horizontal** — two rulers per row;
|
||||
- **both** — the two together;
|
||||
- **mix** — the two times, read off each *trace* where they cross it.
|
||||
|
||||
The pane beside it reports each trace's values at the markers, and **Reset** puts them back at the
|
||||
window's edges. Values read `--` when a marker is past the newest sample and `partial` when only one
|
||||
The dock reports each trace's values at the markers; **Edit** beside **Cursors** opens the page with
|
||||
the mode and **Reset**, which puts them back at the window's edges. Values read `--` when a marker is past the newest sample and `partial` when only one
|
||||
marker is over data.
|
||||
|
||||
## 8. Measurements
|
||||
|
||||
The measurements pane computes statistics of the **visible window** of a signal: average, top,
|
||||
bottom, min, max, peak to peak, amplitude, pulse duration, period and frequency. `+` adds one, the
|
||||
row's pencil edits it, and **show on plot** draws its result as a ruler (levels) or markers (times).
|
||||
A measurement is a statistic of the **visible window** of a signal: average, top, bottom, min, max,
|
||||
peak to peak, amplitude, pulse duration, period and frequency. `m`, or **Edit** beside
|
||||
**Measurements** in the dock, opens the page; its `+` adds one, a click on a row (in the page or in
|
||||
the dock) edits it, and **show on plot** draws its result as a ruler (levels) or markers (times).
|
||||
The dock shows each measurement's value.
|
||||
|
||||
`top` and `bottom` take a *split* as a share of the window's own range — the percentage travels
|
||||
between signals where a threshold in volts would not. `period` and `frequency` deliberately have no
|
||||
@@ -127,7 +149,7 @@ split: they count rising crossings of the mid level, one edge per cycle, and a s
|
||||
setting you can only get wrong.
|
||||
|
||||
The values are refreshed on a cadence — at most every 100 ms while the window is scrolling, once when
|
||||
it stops, and once per mode change — so a live view cannot cost you frames. The pane's cost is
|
||||
it stops, and once per mode change — so a live view cannot cost you frames. The cost is
|
||||
reported in the exit dump with the app's self-check.
|
||||
|
||||
## 9. Math channels
|
||||
@@ -139,13 +161,14 @@ the square on the right. The orange dot marks the node that carries the channel'
|
||||
|
||||
A math channel is derived from the others and is then an ordinary channel: enable it and it is
|
||||
acquired, plotted, measured and exported like a streamed signal, and another math channel can use it
|
||||
as a source.
|
||||
as a source. The **Signals** page lists them under a `MATH` heading whose `+` creates one; a math
|
||||
channel's own page has **Edit graph** and **Delete**.
|
||||
|
||||
Operations: `channel` (a source), `gain + offset`, `abs`, `sqrt`, `clamp`, `low pass`, `high pass`,
|
||||
`band pass` (biquads, corner in Hz against the stored rate), `sum`, `difference`, `product`, `ratio`.
|
||||
|
||||
- **Click** a node to select it; its parameters appear in the form beside the canvas.
|
||||
- **Click an output square, then an input square**, to wire them. An input is only offered the nodes
|
||||
- **Drag from an output square to an input square** to wire them. An input is only offered the nodes
|
||||
above it — the graph is a list walked in order, so a cycle cannot be drawn.
|
||||
- **Drag** a box to move it. **add node**, **delete node** and **set as output** are below the form.
|
||||
- The **output is the last node** of a graph you build top to bottom, and the orange dot says which;
|
||||
|
||||
Reference in new issue
Block a user