Martino FerrariandClaude Opus 4.6
1627abcd4a
Converts every --buffer-mb / buffer_mb mention to --buffer-samples / buffer_samples, records the unit change as a deviation (README, SPECS, CLAUDE.md), documents the buffer: and planner: dump lines and the new Preferences row, and updates the help pages and the help-shot script. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
76 lines
3.5 KiB
Plaintext
76 lines
3.5 KiB
Plaintext
<page xmlns="http://projectmallard.org/1.0/"
|
||
type="topic" style="task"
|
||
id="source">
|
||
|
||
<info>
|
||
<link type="guide" xref="index#main"/>
|
||
<link type="seealso" xref="sessions"/>
|
||
<desc>How udpscope is pointed at a source: the command line, the startup chooser, and
|
||
opening an exported waveform instead of a live stream.</desc>
|
||
<credit type="author copyright">
|
||
<name>Martino Ferrari</name>
|
||
</credit>
|
||
</info>
|
||
|
||
<title>Choosing a source</title>
|
||
|
||
<p>A source is a host and a port, optionally reached through a multicast group on a named
|
||
interface. Pass it on the command line, or let udpscope ask.</p>
|
||
|
||
<section id="reach">
|
||
<title>How to reach it</title>
|
||
<steps>
|
||
<item>
|
||
<p>Run with <cmd>--server</cmd> and the app connects straight away.</p>
|
||
</item>
|
||
<item>
|
||
<p>Run <em>without</em> <cmd>--server</cmd> and a chooser appears first: one row per
|
||
stored <em>configuration</em> (<code>host:port · name</code>, its note, and the
|
||
settings it carries), newest first, plus a <gui>New host…</gui> form that takes the
|
||
address <em>and</em> the configuration it belongs to — its name and note, the
|
||
<gui>samples per signal</gui>, and whether time is relative or absolute. A row's pencil
|
||
button opens the same form on that configuration, pre-filled, and changes to its name
|
||
or address move it (the old file is deleted).</p>
|
||
</item>
|
||
<item>
|
||
<p>The second page, <gui>Waveforms</gui>, opens an <em>exported</em> run instead of a
|
||
live source: the files opened before (newest first; one that has since been deleted is
|
||
marked <em>missing</em>) and an <gui>Open…</gui> button for a new one. The same file
|
||
can be opened straight from the command line with <cmd>--open FILE</cmd>. A waveform
|
||
is a source that never arrives — no socket, no acquisition, no starvation notice — and
|
||
every instrument works on it: cursors, measurements, math channels and another export.
|
||
Only <file>.npy</file> files are read.</p>
|
||
</item>
|
||
</steps>
|
||
|
||
<p>The chooser runs before any buffer is allocated and before any socket is opened, so
|
||
declining it costs nothing.</p>
|
||
</section>
|
||
|
||
<section id="knowing">
|
||
<title>Worth knowing</title>
|
||
<list>
|
||
<item><p>The list is the sessions that <em>named a signal</em>. A session whose streamer
|
||
was down stores empty slot names and is filtered out, which is what keeps the list the
|
||
sources you actually configured rather than every port you have ever typed.</p></item>
|
||
<item><p>A stored row reconnects the way it was reached. The multicast group and the
|
||
interface are written inside the session file, because the file's name
|
||
(<file>host_port.toml</file>) cannot carry them.</p></item>
|
||
<item><p><cmd>--multicast</cmd> still needs <cmd>--server</cmd>: the CONFIG message is
|
||
fetched from the server, not from the group.</p></item>
|
||
<item><p>The <gui>×</gui> beside a row deletes that session file. Nothing else is
|
||
removed.</p></item>
|
||
</list>
|
||
</section>
|
||
|
||
<section id="example">
|
||
<title>Example</title>
|
||
<p><cmd>udpscope</cmd> with two stored sessions lists
|
||
<code>127.0.0.1:8000 plots=1 signals=3</code> and
|
||
<code>10.0.0.5:8001 plots=2 signals=4 multicast=239.1.2.3 interface=10.0.0.9</code>.
|
||
Activating the first reports <code>[sources] picked 127.0.0.1:8000</code> and continues
|
||
into the scope with that session's layout already loaded.</p>
|
||
</section>
|
||
|
||
</page>
|