olimex-shielddocs

Reference

Browser modules (JavaScript)

What a page imports: the playback helpers, the fail-safe session recorder and the <signal-panel> element. Exported declarations and the comment above each.

languagejavascriptpathappsmodules3public symbols13

Modules

API reference

Read from the source without importing or running it.

apps/server/session-recorder

session-recorder.js — the browser half of the durability contract.

class

FailsafeStore

source
class FailsafeStore

L3 — the browser failsafe. Survives the server going away entirely.

class

SessionRecorder

source
class SessionRecorder

SessionRecorder — L2 + L3 + L4 behind one object.

Full documentation

Usage: const rec = new SessionRecorder({ app: 'attend-to-send', name: 'arm-a-01', base: '' }); const pre = await rec.preflight(); // L2 disk self-test — CHECK THIS before a long run await rec.start({ csvHeader: 'idx,uv', meta }); await rec.update(record, csvRows, 'block-3'); await rec.finish(record);

function

downloadRecovered

source
function downloadRecovered(obj, filename)

Download a recovered record as a file. Nothing is auto-deleted; the operator decides.

apps/web/playback

playback.js -- play a recorded session back against its own tag track.

function

indexAt

source
function indexAt(t, rate, n)

Seconds -> sample index, clamped to the record.

function

envelope

source
function envelope(values, cols)

Min/max envelope with cols columns. Returns [{min, max}] -- every sample lands in a column.

function

nextTag

source
function nextTag(tags, t)

The tag after / before time t (strictly), or null.

function

prevTag

source
function prevTag(tags, t)
function

robustRange

source
function robustRange(values)

Robust vertical scale for a window: median-centred, 1st..99th percentile span. A single blink should not flatten the rest of the trace, and an autoscale that chases it does.

function

fmtTime

source
function fmtTime(t)
class

Player

source
class Player

apps/web/signal-panel/signal-panel

signal-panel.js -- ONE live-signal panel, for every page that reads the shared bridge.

const

betaBadge

source
const betaBadge = ()
function

alphaSnrOf

source
function alphaSnrOf(q)

The alpha-SNR part of the bridge's plausibility check, whatever shape it arrives in: a bare number (alpha_snr), or a sub-result object carrying experimental. Null if absent.

class

SignalPanel

source
class SignalPanel extends HTMLElement
Generated from polarizetech/olimex-shield at 98158d0 by automatic-documentation-site 0.2.1, on polarize-ui v0.5.15. Nothing on this page is written by hand; edit the source it names.