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
@@ -23,15 +23,16 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>The trigger button in the toolbar (<key>t</key>) reveals the trigger panel: the
|
||||
signal, the level, the shape, the edge (rising, falling, either), the mode (Normal or
|
||||
Single) and the pre-trigger share.</p>
|
||||
<p>Click the <gui>Trigger</gui> badge at the right of the badge bar to open the
|
||||
trigger page: the signal, the level, the shape, the edge (rising, falling, either), the
|
||||
mode (Normal or Single) and the pre-trigger share. The trigger button in the header bar
|
||||
(<key>t</key>) turns trigger mode on and off; it does not open the page.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p><gui>Arm</gui> starts watching; <key>a</key> arms and disarms from the keyboard.
|
||||
When the pane is locked with its <gui>[edit]</gui> button — so that it states what the
|
||||
When the page is locked with its edit button — so that it states what the
|
||||
trigger is set to instead of showing the controls — <gui>Arm/Disarm</gui> is in its
|
||||
heading, and the trigger can be armed or disarmed without unfolding the panel. It is
|
||||
heading, and the trigger can be armed or disarmed without unfolding the page. It is
|
||||
offered only while trigger mode is on, because a trigger that is off has no engine to
|
||||
arm.</p>
|
||||
</item>
|
||||
@@ -170,29 +171,32 @@
|
||||
<p><em>Every triggered acquisition is kept.</em> Latches are written to the event cache
|
||||
(<file>~/.cache/udpscope/events/<source>/</file>) as a <file>.npy</file> of the
|
||||
event, a <file>.txt</file> of what it was, and a <file>.bmp</file> picture drawn from the
|
||||
samples. The <gui>Events</gui> pane on the left — opened from the toolbar's
|
||||
event-history button, which appears while recording is enabled, and collapsed until you
|
||||
ask for it — lists the last 32 newest first (time, duration, signals, rate), each row with
|
||||
its own picture beside the numbers.</p>
|
||||
samples. The <gui>Events</gui> block at the foot of the dock lists them, newest first, one
|
||||
short row each: a marker for the event on screen, its title and its number. It is dimmed
|
||||
until recording is on, an event is stored or one is being replayed. <gui>Manage</gui>
|
||||
beside its heading opens the <gui>Events</gui> page over the plot, which keeps the last 32
|
||||
(time, duration, signals, rate), each row with its own picture beside the numbers.</p>
|
||||
|
||||
<p>Clicking a row <em>replays</em> it: the stored event is loaded exactly like an exported
|
||||
<p>Clicking a row in the dock <em>replays</em> it: the stored event is loaded exactly like an exported
|
||||
file, <em>without changing the layout</em> — the rows, the colours, the window, the
|
||||
cursors and the measurements stay where they are and read the stored data instead. A
|
||||
replay leaves trigger mode, because a file has no edge to wait for, and the pane stays
|
||||
open. Drag the pane's edge to resize it. <gui>Live</gui> goes back to the stream; the
|
||||
status bar names the file until you do.</p>
|
||||
replay leaves trigger mode, because a file has no edge to wait for. <gui>Live</gui>, on the
|
||||
<gui>Events</gui> page, goes back to the stream; the status bar names the file until
|
||||
you do.</p>
|
||||
|
||||
<p>Select two or more events in the list and the two buttons under the header act on them:
|
||||
<p>On the <gui>Events</gui> page, select two or more events in the list and the two buttons
|
||||
under its header act on them:
|
||||
<gui>Compare</gui> puts two events in two plots side by side, keeping the layout you have
|
||||
— one plot per event, the axes synchronised, so zooming a row in one zooms the same row in
|
||||
the other — and <gui>Accumulate</gui> overlays up to four of them in the same traces,
|
||||
translucent, so where they agree the trace is brighter. Your own traces stay where they
|
||||
are in both. They need events with the same signals and the same length. A single click
|
||||
selects, a <em>double</em> click replays.</p>
|
||||
are in both. They need events with the same signals and the same length. On this page a
|
||||
single click selects and a <em>double</em> click replays.</p>
|
||||
|
||||
<p><gui>Record events</gui>, in the trigger panel with the trigger's other options, is
|
||||
<p><gui>Record events</gui>, on the trigger page with the trigger's other options, is
|
||||
what decides whether anything is kept. It is <em>off by default</em> — nothing is written
|
||||
to disk until you ask — and with it off the history button goes with it.</p>
|
||||
to disk until you ask — and with it off, and nothing stored, the dock's events block and
|
||||
the page stay dimmed.</p>
|
||||
</section>
|
||||
|
||||
<section id="search">
|
||||
|
||||
Reference in new issue
Block a user