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
@@ -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
|
||||
|
||||
Reference in new issue
Block a user