Martino Ferrari
706d247b58
The slide-over's header already prints the open page's title beside its Close button, so the signal page's body carried the name twice and a "Back to signals" button that only repeated navigation the header owns. Both are gone. The header's title is now the **numbered** name -- `<n>. <name>`, `measure_channel_number()`'s number, the same one the signal badges and the measurements pane use -- so the panel says *which acquired channel* it is and not only what it is called. `slideover_set_title()` retitles a page in place (the open one included): the number follows the stream's channel numbering, and the page is refilled whenever the model's signal list changes. Probe: `[signalpage]` reads `title='1. sine' title_ok=1` (the header text against the numbered name) and `no_dup=1` (no "Back to signals" button and no `title-3` label in the body); the old `back_to_list` reading is gone with the button. Help, README and the probe doc follow.
81 lines
4.1 KiB
Plaintext
81 lines
4.1 KiB
Plaintext
<page xmlns="http://projectmallard.org/1.0/"
|
|
type="topic" style="task"
|
|
id="signals">
|
|
|
|
<info>
|
|
<link type="guide" xref="index#main"/>
|
|
<link type="seealso" xref="layout"/>
|
|
<desc>How the source's CONFIG becomes channels, what enabling a signal starts, and how a
|
|
signal's scale and offset are calibrated.</desc>
|
|
<credit type="author copyright">
|
|
<name>Martino Ferrari</name>
|
|
</credit>
|
|
</info>
|
|
|
|
<title>Signals and calibration</title>
|
|
|
|
<p>The source's CONFIG message describes its signals: a name, a unit and a type. udpscope
|
|
turns each enabled signal into a <em>channel</em> — a ring of values beside the shared time
|
|
ring — and a channel is what a trace plots. Calibration is a scale and an offset applied at
|
|
ingest.</p>
|
|
|
|
<section id="reach">
|
|
<title>How to reach it</title>
|
|
<steps>
|
|
<item>
|
|
<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>Once a signal is acquired its badge appears. Click it to open that signal's page: its
|
|
title carries the signal's name and its channel number (<code>2. sine</code>), and its
|
|
details follow — <gui>Unit</gui>, <gui>Gain</gui> and <gui>Offset</gui>,
|
|
each with a pencil button that edits that one value, then the type, size, range, sample
|
|
rate and timing the stream declared — its colour and <gui>Plot on</gui> buttons for the
|
|
rows.</p>
|
|
</item>
|
|
</steps>
|
|
</section>
|
|
|
|
<section id="knowing">
|
|
<title>Worth knowing</title>
|
|
<list>
|
|
<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>A signal's page shows the gain and offset it is <em>currently</em> drawn
|
|
through, so a trace already scaled by a gain of 2 reads 2. The pencil beside a number opens
|
|
an editor for that number only, at its current value —
|
|
pressing <gui>Apply</gui> confirms it rather than resetting it. A signal nobody
|
|
calibrated shows the identity, 1 and 0. The unit can be renamed the same way (an empty
|
|
entry restores the one the stream declares); the new name is used in the readouts, the
|
|
measurements and the export, and is remembered with the session.</p></item>
|
|
<item><p>Calibration is applied <em>at ingest</em>, so changing it re-plans the buffer
|
|
and drops the history. So does enabling or disabling a signal, and so does a new
|
|
CONFIG. An empty plot for a second after one of those is the ring refilling, not a
|
|
fault.</p></item>
|
|
<item><p>The stream's first signal is usually its <em>timestamp</em>, and that one is
|
|
never acquired. It cannot be plotted, measured or used as a math source, and udpscope
|
|
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 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>
|
|
|
|
<section id="example">
|
|
<title>Example</title>
|
|
<p>A source declaring <code>time</code>, <code>sine</code>, <code>ramp</code> and
|
|
<code>noise</code> yields three plottable signals. Enable all three and the exit dump
|
|
reads <code>3 signals, 3 channels</code>; <code>time</code> is not among them.</p>
|
|
</section>
|
|
|
|
</page>
|