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
@@ -22,12 +22,13 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>Press the cursors button in the toolbar, or <key>c</key>.</p>
|
||||
<p>Press the cursors button in the header bar, or <key>c</key>. It switches the cursors on
|
||||
and off.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>The readings are in the side panel (a read-only copy) and in the cursors panel, which
|
||||
<gui>Edit</gui> beside <gui>Cursors</gui> opens over the plot and which owns a
|
||||
<gui>Reset</gui> button. Drag a marker to move it.</p>
|
||||
<p>The readings are in the dock (a read-only copy) and on the <gui>Cursors</gui> page, which
|
||||
<gui>Edit</gui> beside <gui>Cursors</gui> opens over the plot and which owns the mode
|
||||
and a <gui>Reset</gui> button. Drag a marker to move it.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>The mode dropdown offers four modes: <gui>vertical</gui> (the shared time pair),
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 146 KiB After Width: | Height: | Size: 130 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 123 KiB After Width: | Height: | Size: 129 KiB |
@@ -22,10 +22,12 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>Press the math button in the toolbar, or <key>g</key>.</p>
|
||||
<p>Open the <gui>Signals</gui> page (the <gui>+</gui> badge, or <key>g</key>). Math channels
|
||||
are listed under a <gui>MATH</gui> heading.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>The pane's <gui>+</gui> adds a channel, and opening one shows the graph editor:
|
||||
<p>The heading's <gui>+</gui> adds a channel. <gui>Edit graph</gui>, on a channel's page,
|
||||
shows the graph editor:
|
||||
nodes as boxes, click a box to select it and edit its parameters beside the canvas.</p>
|
||||
</item>
|
||||
<item>
|
||||
@@ -53,7 +55,7 @@
|
||||
<em>above</em> it. A wire drawn right to left re-sorts the list silently so the graph
|
||||
stays valid. A cycle is unrepresentable: the connection is refused rather than created,
|
||||
and the line beneath the form says why — a loop, or a node asked to read itself.</p></item>
|
||||
<item><p>A derived channel <em>is</em> a channel. It appears in the signal panel, can be
|
||||
<item><p>A derived channel <em>is</em> a channel. It is listed with the signals, gets a badge once computed, can be
|
||||
plotted, measured, exported, and used as a source for another math channel.</p></item>
|
||||
<item><p>The math runs on the <em>stored</em> samples — decimated and averaged — so a
|
||||
cutoff you type in Hz means the rate the filter will actually run at. Change the window
|
||||
|
||||
@@ -28,10 +28,12 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>Press <key>m</key>, or <gui>Edit</gui> beside <gui>Measurements</gui> in the side panel.</p>
|
||||
<p>Press <key>m</key>, or <gui>Edit</gui> beside <gui>Measurements</gui> in the dock. Either opens the
|
||||
<gui>Measurements</gui> page over the plot; the dock itself shows each measurement's value,
|
||||
and a click on one opens its dialog.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>The panel's <gui>+</gui> adds one; clicking a row opens the dialog where the signal,
|
||||
<p>The page's <gui>+</gui> adds one; clicking a row opens the dialog where the signal,
|
||||
the type, the threshold share or shares and the on-plot marks are set, with
|
||||
<gui>Save</gui> and <gui>Delete</gui>.</p>
|
||||
</item>
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
<info>
|
||||
<link type="guide" xref="index#main"/>
|
||||
<desc>What udpscope plots, the four parts of the window, and one pass through the
|
||||
<desc>What udpscope plots, the parts of the window, and one pass through the
|
||||
application from connecting to saving.</desc>
|
||||
<credit type="author copyright">
|
||||
<name>Martino Ferrari</name>
|
||||
@@ -34,11 +34,12 @@
|
||||
|
||||
<figure>
|
||||
<title>The udpscope window</title>
|
||||
<desc>The header bar above the plots, the side panel on the right, and the status bar
|
||||
along the bottom.</desc>
|
||||
<desc>The header bar above the plots, the badge bar and the status bar under them, and
|
||||
the dock on the right.</desc>
|
||||
<media type="image" mime="image/png" src="figures/main-window.png" width="1280" height="800">
|
||||
<p>One figure of three rows with four signals enabled, the Measure tab open in the
|
||||
side panel, and the status bar reading <gui>live</gui>.</p>
|
||||
<p>One figure of three rows with three signals plotted, a badge for each in the badge
|
||||
bar, the dock with its readouts and its events block, and the status bar reading
|
||||
<gui>live</gui>.</p>
|
||||
</media>
|
||||
</figure>
|
||||
</section>
|
||||
@@ -55,7 +56,7 @@
|
||||
|
||||
<p>The signals arrive <em>disabled</em>. Nothing is acquired until you turn one on in the
|
||||
signal list, and enabling is what starts acquisition — so a freshly opened scope with an
|
||||
idle side panel is working correctly, not failing to connect. For the same reason a start
|
||||
empty badge bar is working correctly, not failing to connect. For the same reason a start
|
||||
that has enabled nothing prints no <code>buffer allocated:</code> line on stderr.</p>
|
||||
|
||||
<note style="warning">
|
||||
@@ -81,32 +82,48 @@
|
||||
<terms>
|
||||
<item>
|
||||
<title>The header bar</title>
|
||||
<p>Left to right: the time window (<gui>2 s</gui>), the trigger and the pause, the
|
||||
events, cursors and side-panel switches, and the menu, which holds
|
||||
<gui>Fit to data</gui>, the <gui>Layout editor</gui>, <gui>Export</gui>,
|
||||
<gui>Keyboard shortcuts</gui>, <gui>Help</gui> and <gui>About</gui>.</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The side panel</title>
|
||||
<p>A read-only copy of the cursors and of the measurements; the <gui>Edit</gui> button
|
||||
beside each heading opens that instrument's full panel over the plot. The channel
|
||||
list and the trigger are panels of their own, opened from the badge bar and the
|
||||
toolbar, where a math channel is a row of the one list under a <gui>MATH</gui>
|
||||
heading whose <gui>+</gui> creates one. One row per channel: its colour, an enable
|
||||
switch, its name and its unit. A channel's badge in the badge bar is dragged onto a
|
||||
plot row.</p>
|
||||
<p>Left to right: the time window (<gui>2 s</gui>), the trigger and the pause; then, on
|
||||
the right, the cursors switch, the dock switch and the menu, which holds
|
||||
<gui>Fit to data</gui>, the <gui>Layout editor</gui>, <gui>Export visible range</gui>,
|
||||
<gui>Configurations</gui>, <gui>Help</gui>, <gui>Preferences</gui> and
|
||||
<gui>About</gui>. The trigger button turns trigger mode on and off; the trigger's
|
||||
settings are in the panel its badge opens.</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The plot</title>
|
||||
<p>Up to eight rows, each with its own y axis and up to four traces, all on one shared
|
||||
time axis. Right-click a row for its own menu (fit, add a signal, remove a trace).</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The badge bar</title>
|
||||
<p>The strip under the plot. On the left, one badge for each signal you have switched
|
||||
on, then a <gui>+</gui>; past six signals they fold into a single <gui>N signals</gui>
|
||||
badge. On the right, <gui>Trigger</gui>, which names the trigger's state, and <gui>Source</gui>, which is there only when the
|
||||
source has controls of its own. A badge opens its page in the panel described next;
|
||||
a signal's badge is also what you drag onto a row.</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The side panel over the plot</title>
|
||||
<p>One panel, 360 px wide, slides over the plot's right edge and shows one page at a
|
||||
time: the trigger, a signal's colour, calibration and rows, the list of signals to
|
||||
add, the cursors, the measurements, the events, or a source's own controls. It closes
|
||||
with a second click on the badge that opened it, with <key>Esc</key>, with
|
||||
<gui>Close</gui>, or with a click on the plot, and it never resizes the plot.</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The dock</title>
|
||||
<p>The column on the right, which the dock button in the header bar (<key>s</key>)
|
||||
shows and hides. Its <gui>Readouts</gui> are a read-only copy of the cursors and of
|
||||
every measurement; <gui>Edit</gui> beside each heading opens that instrument's full
|
||||
page. Under them, <gui>Events</gui> lists the captured events, newest first; a click
|
||||
replays one and <gui>Manage</gui> opens the full list.</p>
|
||||
</item>
|
||||
<item>
|
||||
<title>The status bar</title>
|
||||
<p>Directly above the plot's bottom edge — the state word, the stored sample rate and
|
||||
<p>The last line, under the badge bar — the state word, the stored sample rate and
|
||||
the window, and the ⓘ beside it for packets, gaps and the buffer's own figures. The
|
||||
second screenshot below is what a held capture looks like: <gui>event held</gui>, the
|
||||
axis pinned to the event, and the trigger marker at the edge.</p>
|
||||
second screenshot below is what a capture looks like: the trigger marker at the edge
|
||||
and the axis pinned to the event.</p>
|
||||
</item>
|
||||
</terms>
|
||||
|
||||
@@ -129,12 +146,12 @@
|
||||
and port.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p><em>Enable a signal</em> in the <gui>Add a signal</gui> page (the <gui>+</gui> badge). The plot stays empty for the first
|
||||
<p><em>Enable a signal</em> in the <gui>Signals</gui> page (the <gui>+</gui> badge, or <key>g</key>). The plot stays empty for the first
|
||||
fraction of a second while the first window fills — the buffer holds only what has
|
||||
arrived.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p><em>Drag it onto a row.</em> Drop a second signal on another row, or the same
|
||||
<p><em>Drag its badge onto a row.</em> Drop a second signal on another row, or the same
|
||||
signal again for a second view of it. The colour is per signal, so it is the same one
|
||||
wherever it appears.</p>
|
||||
</item>
|
||||
@@ -154,8 +171,10 @@
|
||||
got.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p><em>Measure it</em> — the measurements pane computes a statistic of the visible
|
||||
window, and <gui>show on plot</gui> marks it as a ruler or a pair of markers.</p>
|
||||
<p><em>Measure it</em> — press <key>m</key>, or <gui>Edit</gui> beside
|
||||
<gui>Measurements</gui> in the dock. A measurement is a statistic of the visible
|
||||
window, its value is shown in the dock, and <gui>show on plot</gui> marks it as a
|
||||
ruler or a pair of markers.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p><em>Save the data</em> with <gui>Export visible range</gui>, which writes the
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>Press the pause button in the toolbar, or <key>Space</key>.</p>
|
||||
<p>Press the pause button in the header bar, or <key>Space</key>.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>Press it again to resume, which rebinds the live ring and puts the window back on
|
||||
|
||||
@@ -57,7 +57,7 @@
|
||||
<list>
|
||||
<item><p>What a configuration persists: the time window, the rows and each row's slot
|
||||
signals, the calibration, the trace colours, which signals were enabled, the math
|
||||
channels with their graphs, the measurements pane — and the startup settings: samples
|
||||
channels with their graphs, the measurements — and the startup settings: samples
|
||||
per signal, relative time and the packet capture's ring size.</p></item>
|
||||
<item><p>Signal identity is the <em>name</em> throughout, because a new CONFIG renumbers
|
||||
the channels.</p></item>
|
||||
|
||||
@@ -23,11 +23,15 @@
|
||||
<title>How to reach it</title>
|
||||
<steps>
|
||||
<item>
|
||||
<p>Open the side panel (<key>s</key>), which lists every signal with a switch.</p>
|
||||
<p>Click the <gui>+</gui> badge in the badge bar, or press <key>g</key>. The
|
||||
<gui>Signals</gui> page lists what can be added — the signals the source declares that
|
||||
are not acquired yet, each with a tick that acquires it. Past six acquired signals the
|
||||
badges fold into one <gui>N signals</gui> badge, and the page then lists every signal.</p>
|
||||
</item>
|
||||
<item>
|
||||
<p>The <gui>Signal list</gui> item in the overflow menu opens the editor where the
|
||||
unit and the calibration live.</p>
|
||||
<p>Once a signal is acquired its badge appears. Click it to open that signal's page: its
|
||||
colour, <gui>Plot on</gui> buttons for the rows, and <gui>Information</gui> and
|
||||
<gui>Calibrate</gui>, where the signal's details and its calibration live.</p>
|
||||
</item>
|
||||
</steps>
|
||||
</section>
|
||||
@@ -38,7 +42,7 @@
|
||||
<item><p>Signals start disabled, and enabling one is what starts acquiring it. A trigger
|
||||
on a signal nobody acquires can never fire, so arming a trigger enables its signal for
|
||||
you.</p></item>
|
||||
<item><p><gui>Calibrate</gui> in a signal's row menu opens the gain and offset it is
|
||||
<item><p><gui>Calibrate</gui> on a signal's page opens the gain and offset it is
|
||||
<em>currently</em> drawn through, so a trace already scaled by a gain of 2 shows 2 —
|
||||
pressing <gui>Apply</gui> confirms it rather than resetting it. A signal nobody
|
||||
calibrated shows the identity, 1 and 0.</p></item>
|
||||
@@ -51,12 +55,12 @@
|
||||
refuses to put it in a row rather than binding a trace that would read nothing for
|
||||
ever.</p></item>
|
||||
<item><p>A signal's colour follows the <em>signal</em>, not the slot, so the same signal
|
||||
on two rows is one colour and the side panel's chip identifies it unambiguously. A
|
||||
signal on no row gets a grey chip rather than none, so the panel's rows keep their
|
||||
height.</p></item>
|
||||
<item><p><em>Click a coloured chip to change that signal's colour.</em> A grey chip
|
||||
names no trace, so it is not clickable. The colour is saved with the session;
|
||||
<gui>Default colour</gui> in the signal's ⋯ menu gives the palette entry back.</p></item>
|
||||
on two rows is one colour, and the dot on its badge shows it. A signal on no row gets a
|
||||
grey dot rather than none.</p></item>
|
||||
<item><p><em>Change a signal's colour</em> with <gui>Change colour</gui> on its page; a
|
||||
signal on no row has no trace to colour, so the button is dimmed. The colour is saved
|
||||
with the session; <gui>Default colour</gui> on the same page gives the palette entry
|
||||
back.</p></item>
|
||||
</list>
|
||||
</section>
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
|
||||
<section id="reach">
|
||||
<title>How to reach it</title>
|
||||
<p>The bar is always visible under the plot. Click <gui>ⓘ</gui> for the detail popover.</p>
|
||||
<p>The bar is always visible at the foot of the window, under the badge bar. Click <gui>ⓘ</gui> for the detail popover.</p>
|
||||
</section>
|
||||
|
||||
<section id="knowing">
|
||||
|
||||
@@ -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