mirror of
https://github.com/smittix/intercept.git
synced 2026-04-25 07:10:00 -07:00
93fb694e25
- Fix XSS: escape ASCII output in innerHTML via escapeHtml() - Fix deadlock: use put_nowait() for queue ops under ook_lock - Fix SSE leak: add ook to moduleDestroyMap so switching modes closes the EventSource - Fix RSSI: explicit null check preserves valid zero values in JSON export - Add frame cap: trim oldest frames at 5000 to prevent unbounded memory growth on busy bands - Validate timing params: wrap int() casts in try/except, return 400 instead of 500 on invalid input - Fix PWM hint: correct to short=0/long=1 matching rtl_433 OOK_PWM convention (UI, JS hints, and cheat sheet) - Fix inversion docstring: clarify fallback only applies when primary hex parse fails, not for valid decoded frames Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
576 lines
20 KiB
JavaScript
576 lines
20 KiB
JavaScript
/**
|
|
* Generic OOK Signal Decoder module.
|
|
*
|
|
* IIFE providing start/stop controls, SSE streaming, and a live-updating
|
|
* frame log with configurable bit order (MSB/LSB) and ASCII interpretation.
|
|
* The backend sends raw bits; all byte grouping and ASCII display is done
|
|
* here so bit order can be flipped without restarting the decoder.
|
|
*/
|
|
var OokMode = (function () {
|
|
'use strict';
|
|
|
|
var DEFAULT_FREQ_PRESETS = ['433.920', '315.000', '868.000', '915.000'];
|
|
var MAX_FRAMES = 5000;
|
|
|
|
var state = {
|
|
running: false,
|
|
initialized: false,
|
|
eventSource: null,
|
|
frames: [], // raw frame objects from SSE
|
|
frameCount: 0,
|
|
bitOrder: 'msb', // 'msb' | 'lsb'
|
|
filterQuery: '', // active hex/ascii filter
|
|
command: '', // the rtl_433 command being run
|
|
};
|
|
|
|
// ---- Initialization ----
|
|
|
|
function init() {
|
|
if (state.initialized) {
|
|
checkStatus();
|
|
return;
|
|
}
|
|
state.initialized = true;
|
|
renderPresets();
|
|
checkStatus();
|
|
}
|
|
|
|
function destroy() {
|
|
disconnectSSE();
|
|
}
|
|
|
|
// ---- Status ----
|
|
|
|
function checkStatus() {
|
|
fetch('/ook/status')
|
|
.then(function (r) { return r.json(); })
|
|
.then(function (data) {
|
|
if (data.running) {
|
|
state.running = true;
|
|
updateUI(true);
|
|
connectSSE();
|
|
} else {
|
|
state.running = false;
|
|
updateUI(false);
|
|
}
|
|
})
|
|
.catch(function () {});
|
|
}
|
|
|
|
// ---- Start / Stop ----
|
|
|
|
function start() {
|
|
if (state.running) return;
|
|
|
|
var remoteSDR = typeof getRemoteSDRConfig === 'function' ? getRemoteSDRConfig() : null;
|
|
if (remoteSDR === false) return;
|
|
|
|
var payload = {
|
|
frequency: document.getElementById('ookFrequency').value || '433.920',
|
|
gain: document.getElementById('ookGain').value || '0',
|
|
ppm: document.getElementById('ookPPM').value || '0',
|
|
device: document.getElementById('deviceSelect')?.value || '0',
|
|
sdr_type: document.getElementById('sdrTypeSelect')?.value || 'rtlsdr',
|
|
encoding: document.getElementById('ookEncoding').value || 'pwm',
|
|
short_pulse: document.getElementById('ookShortPulse').value || '300',
|
|
long_pulse: document.getElementById('ookLongPulse').value || '600',
|
|
reset_limit: document.getElementById('ookResetLimit').value || '8000',
|
|
gap_limit: document.getElementById('ookGapLimit').value || '5000',
|
|
tolerance: document.getElementById('ookTolerance').value || '150',
|
|
min_bits: document.getElementById('ookMinBits').value || '8',
|
|
deduplicate: document.getElementById('ookDeduplicate')?.checked || false,
|
|
bias_t: typeof getBiasTEnabled === 'function' ? getBiasTEnabled() : false,
|
|
};
|
|
if (remoteSDR) {
|
|
payload.rtl_tcp_host = remoteSDR.host;
|
|
payload.rtl_tcp_port = remoteSDR.port;
|
|
}
|
|
|
|
fetch('/ook/start', {
|
|
method: 'POST',
|
|
headers: { 'Content-Type': 'application/json' },
|
|
body: JSON.stringify(payload),
|
|
})
|
|
.then(function (r) { return r.json(); })
|
|
.then(function (data) {
|
|
if (data.status === 'started') {
|
|
state.running = true;
|
|
state.frames = [];
|
|
state.frameCount = 0;
|
|
updateUI(true);
|
|
connectSSE();
|
|
clearOutput();
|
|
showCommand(data.command || '');
|
|
} else {
|
|
alert('Error: ' + (data.message || 'Unknown error'));
|
|
}
|
|
})
|
|
.catch(function (err) {
|
|
alert('Failed to start OOK decoder: ' + err);
|
|
});
|
|
}
|
|
|
|
function stop() {
|
|
fetch('/ook/stop', { method: 'POST' })
|
|
.then(function (r) { return r.json(); })
|
|
.then(function () {
|
|
state.running = false;
|
|
updateUI(false);
|
|
disconnectSSE();
|
|
})
|
|
.catch(function () {});
|
|
}
|
|
|
|
// ---- SSE ----
|
|
|
|
function connectSSE() {
|
|
disconnectSSE();
|
|
var es = new EventSource('/ook/stream');
|
|
es.onmessage = function (e) {
|
|
try {
|
|
var msg = JSON.parse(e.data);
|
|
handleMessage(msg);
|
|
} catch (_) {}
|
|
};
|
|
es.onerror = function () {};
|
|
state.eventSource = es;
|
|
}
|
|
|
|
function disconnectSSE() {
|
|
if (state.eventSource) {
|
|
state.eventSource.close();
|
|
state.eventSource = null;
|
|
}
|
|
}
|
|
|
|
function handleMessage(msg) {
|
|
if (msg.type === 'ook_frame') {
|
|
handleFrame(msg);
|
|
} else if (msg.type === 'status') {
|
|
if (msg.status === 'stopped') {
|
|
state.running = false;
|
|
updateUI(false);
|
|
disconnectSSE();
|
|
}
|
|
} else if (msg.type === 'error') {
|
|
console.error('OOK error:', msg.text);
|
|
}
|
|
}
|
|
|
|
// ---- Frame handling ----
|
|
|
|
function handleFrame(msg) {
|
|
state.frames.push(msg);
|
|
state.frameCount++;
|
|
|
|
// Trim oldest frames when buffer exceeds cap
|
|
if (state.frames.length > MAX_FRAMES) {
|
|
state.frames.splice(0, state.frames.length - MAX_FRAMES);
|
|
var panel = document.getElementById('ookOutput');
|
|
if (panel && panel.firstChild) panel.removeChild(panel.firstChild);
|
|
}
|
|
|
|
var countEl = document.getElementById('ookFrameCount');
|
|
if (countEl) countEl.textContent = state.frameCount + ' frames';
|
|
var barEl = document.getElementById('ookStatusBarFrames');
|
|
if (barEl) barEl.textContent = state.frameCount + ' frames';
|
|
|
|
appendFrameEntry(msg, state.bitOrder);
|
|
}
|
|
|
|
// ---- Bit interpretation ----
|
|
|
|
/**
|
|
* Interpret a raw bit string as bytes and attempt ASCII.
|
|
* @param {string} bits - MSB-first bit string from backend
|
|
* @param {string} order - 'msb' | 'lsb'
|
|
* @returns {{hex: string, ascii: string, printable: string}}
|
|
*/
|
|
function interpretBits(bits, order) {
|
|
var hexChars = [];
|
|
var asciiChars = [];
|
|
var printableChars = [];
|
|
|
|
for (var i = 0; i + 8 <= bits.length; i += 8) {
|
|
var byteBits = bits.slice(i, i + 8);
|
|
if (order === 'lsb') {
|
|
byteBits = byteBits.split('').reverse().join('');
|
|
}
|
|
var byteVal = parseInt(byteBits, 2);
|
|
hexChars.push(byteVal.toString(16).padStart(2, '0'));
|
|
|
|
if (byteVal >= 0x20 && byteVal <= 0x7E) {
|
|
asciiChars.push(String.fromCharCode(byteVal));
|
|
printableChars.push(String.fromCharCode(byteVal));
|
|
} else {
|
|
asciiChars.push('.');
|
|
}
|
|
}
|
|
|
|
return {
|
|
hex: hexChars.join(''),
|
|
ascii: asciiChars.join(''),
|
|
printable: printableChars.join(''),
|
|
};
|
|
}
|
|
|
|
function appendFrameEntry(msg, order) {
|
|
var panel = document.getElementById('ookOutput');
|
|
if (!panel) return;
|
|
|
|
var interp = interpretBits(msg.bits, order);
|
|
var hasPrintable = interp.printable.length > 0;
|
|
|
|
var div = document.createElement('div');
|
|
div.className = 'ook-frame';
|
|
div.dataset.bits = msg.bits || '';
|
|
div.dataset.bitCount = msg.bit_count;
|
|
div.dataset.inverted = msg.inverted ? '1' : '0';
|
|
|
|
var color = hasPrintable ? '#00ff88' : 'var(--text-dim)';
|
|
var suffix = '';
|
|
if (msg.inverted) suffix += ' <span style="opacity:.5">(inv)</span>';
|
|
|
|
var rssiStr = (msg.rssi !== undefined && msg.rssi !== null)
|
|
? ' <span style="color:#666; font-size:10px">' + msg.rssi.toFixed(1) + ' dB SNR</span>'
|
|
: '';
|
|
|
|
div.innerHTML =
|
|
'<span style="color:var(--text-dim)">' + msg.timestamp + '</span>' +
|
|
' <span style="color:#888">[' + msg.bit_count + 'b]</span>' +
|
|
rssiStr + suffix +
|
|
'<br>' +
|
|
'<span style="padding-left:8em; color:' + color + '; font-family:var(--font-mono); font-size:10px">' +
|
|
'hex: ' + interp.hex +
|
|
'</span>' +
|
|
'<br>' +
|
|
'<span style="padding-left:8em; color:' + (hasPrintable ? '#aaffcc' : '#555') + '; font-family:var(--font-mono); font-size:10px">' +
|
|
'ascii: ' + (typeof escapeHtml === 'function' ? escapeHtml(interp.ascii) : interp.ascii) +
|
|
'</span>';
|
|
|
|
div.style.cssText = 'font-size:11px; padding: 4px 0; border-bottom: 1px solid #1a1a1a; line-height:1.6;';
|
|
|
|
// Apply current filter
|
|
if (state.filterQuery) {
|
|
var q = state.filterQuery;
|
|
if (!interp.hex.includes(q) && !interp.ascii.toLowerCase().includes(q)) {
|
|
div.style.display = 'none';
|
|
} else {
|
|
div.style.background = 'rgba(0,255,136,0.05)';
|
|
}
|
|
}
|
|
|
|
panel.appendChild(div);
|
|
if (typeof autoScroll === 'undefined' || autoScroll) {
|
|
panel.scrollTop = panel.scrollHeight;
|
|
}
|
|
}
|
|
|
|
// ---- Bit order toggle ----
|
|
|
|
function setBitOrder(order) {
|
|
state.bitOrder = order;
|
|
|
|
// Update button states
|
|
var msbBtn = document.getElementById('ookBitMSB');
|
|
var lsbBtn = document.getElementById('ookBitLSB');
|
|
if (msbBtn) msbBtn.style.background = order === 'msb' ? 'var(--accent)' : '';
|
|
if (msbBtn) msbBtn.style.color = order === 'msb' ? '#000' : '';
|
|
if (lsbBtn) lsbBtn.style.background = order === 'lsb' ? 'var(--accent)' : '';
|
|
if (lsbBtn) lsbBtn.style.color = order === 'lsb' ? '#000' : '';
|
|
|
|
// Re-render all stored frames
|
|
var panel = document.getElementById('ookOutput');
|
|
if (!panel) return;
|
|
panel.innerHTML = '';
|
|
state.frames.forEach(function (msg) {
|
|
appendFrameEntry(msg, order);
|
|
});
|
|
}
|
|
|
|
// ---- Output panel ----
|
|
|
|
function clearOutput() {
|
|
var panel = document.getElementById('ookOutput');
|
|
if (panel) panel.innerHTML = '';
|
|
state.frames = [];
|
|
state.frameCount = 0;
|
|
var countEl = document.getElementById('ookFrameCount');
|
|
if (countEl) countEl.textContent = '0 frames';
|
|
var barEl = document.getElementById('ookStatusBarFrames');
|
|
if (barEl) barEl.textContent = '0 frames';
|
|
|
|
// Hide output panel if not currently running (no frames to show)
|
|
if (!state.running) {
|
|
var outputPanel = document.getElementById('ookOutputPanel');
|
|
if (outputPanel) outputPanel.style.display = 'none';
|
|
}
|
|
}
|
|
|
|
function exportLog() {
|
|
var lines = ['timestamp,bit_count,rssi_db,hex_msb,ascii_msb,inverted'];
|
|
state.frames.forEach(function (msg) {
|
|
var interp = interpretBits(msg.bits, 'msb');
|
|
lines.push([
|
|
msg.timestamp,
|
|
msg.bit_count,
|
|
msg.rssi !== undefined && msg.rssi !== null ? msg.rssi : '',
|
|
interp.hex,
|
|
'"' + interp.ascii.replace(/"/g, '""') + '"',
|
|
msg.inverted,
|
|
].join(','));
|
|
});
|
|
var blob = new Blob([lines.join('\n')], { type: 'text/csv' });
|
|
var url = URL.createObjectURL(blob);
|
|
var a = document.createElement('a');
|
|
a.href = url;
|
|
a.download = 'ook_frames.csv';
|
|
a.click();
|
|
URL.revokeObjectURL(url);
|
|
}
|
|
|
|
function exportJSON() {
|
|
if (state.frames.length === 0) { alert('No frames to export'); return; }
|
|
var out = state.frames.map(function (msg) {
|
|
var interp = interpretBits(msg.bits, state.bitOrder);
|
|
return {
|
|
timestamp: msg.timestamp,
|
|
bit_count: msg.bit_count,
|
|
rssi: (msg.rssi !== undefined && msg.rssi !== null) ? msg.rssi : null,
|
|
hex: interp.hex,
|
|
ascii: interp.ascii,
|
|
inverted: msg.inverted,
|
|
bits: msg.bits,
|
|
};
|
|
});
|
|
var blob = new Blob([JSON.stringify(out, null, 2)], { type: 'application/json' });
|
|
var url = URL.createObjectURL(blob);
|
|
var a = document.createElement('a');
|
|
a.href = url;
|
|
a.download = 'ook_frames.json';
|
|
a.click();
|
|
URL.revokeObjectURL(url);
|
|
}
|
|
|
|
// ---- Command display ----
|
|
|
|
function showCommand(cmd) {
|
|
state.command = cmd;
|
|
var display = document.getElementById('ookCommandDisplay');
|
|
var text = document.getElementById('ookCommandText');
|
|
if (display && text && cmd) {
|
|
text.textContent = cmd;
|
|
display.style.display = 'block';
|
|
}
|
|
}
|
|
|
|
function copyCommand() {
|
|
if (state.command && navigator.clipboard) {
|
|
navigator.clipboard.writeText(state.command);
|
|
}
|
|
}
|
|
|
|
// ---- Modulation selector ----
|
|
|
|
function setEncoding(enc) {
|
|
document.getElementById('ookEncoding').value = enc;
|
|
|
|
// Update button highlight
|
|
['pwm', 'ppm', 'manchester'].forEach(function (e) {
|
|
var btn = document.getElementById('ookEnc_' + e);
|
|
if (!btn) return;
|
|
if (e === enc) {
|
|
btn.style.background = 'var(--accent)';
|
|
btn.style.color = '#000';
|
|
} else {
|
|
btn.style.background = '';
|
|
btn.style.color = '';
|
|
}
|
|
});
|
|
|
|
// Update timing hint
|
|
var hints = {
|
|
pwm: 'Short pulse = 0, long pulse = 1. Most common for ISM OOK.',
|
|
ppm: 'Short gap = 0, long gap = 1. Pulse position encoding.',
|
|
manchester: 'Rising edge = 1, falling edge = 0. Self-clocking.',
|
|
};
|
|
var hint = document.getElementById('ookEncodingHint');
|
|
if (hint) hint.textContent = hints[enc] || '';
|
|
}
|
|
|
|
function setFreq(mhz) {
|
|
var el = document.getElementById('ookFrequency');
|
|
if (el) el.value = mhz;
|
|
}
|
|
|
|
// ---- Frequency presets (localStorage) ----
|
|
|
|
function loadPresets() {
|
|
var saved = localStorage.getItem('ookFreqPresets');
|
|
return saved ? JSON.parse(saved) : DEFAULT_FREQ_PRESETS.slice();
|
|
}
|
|
|
|
function savePresets(presets) {
|
|
localStorage.setItem('ookFreqPresets', JSON.stringify(presets));
|
|
}
|
|
|
|
function renderPresets() {
|
|
var container = document.getElementById('ookPresetButtons');
|
|
if (!container) return;
|
|
var presets = loadPresets();
|
|
container.innerHTML = presets.map(function (freq) {
|
|
return '<button class="preset-btn" onclick="OokMode.setFreq(\'' + freq + '\')" ' +
|
|
'oncontextmenu="OokMode.removePreset(\'' + freq + '\'); return false;" ' +
|
|
'title="Right-click to remove">' + freq + '</button>';
|
|
}).join('');
|
|
}
|
|
|
|
function addPreset() {
|
|
var input = document.getElementById('ookNewPresetFreq');
|
|
if (!input) return;
|
|
var freq = input.value.trim();
|
|
if (!freq || isNaN(parseFloat(freq))) {
|
|
alert('Enter a valid frequency (MHz)');
|
|
return;
|
|
}
|
|
var presets = loadPresets();
|
|
if (presets.indexOf(freq) === -1) {
|
|
presets.push(freq);
|
|
savePresets(presets);
|
|
renderPresets();
|
|
}
|
|
input.value = '';
|
|
}
|
|
|
|
function removePreset(freq) {
|
|
if (!confirm('Remove preset ' + freq + ' MHz?')) return;
|
|
var presets = loadPresets().filter(function (p) { return p !== freq; });
|
|
savePresets(presets);
|
|
renderPresets();
|
|
}
|
|
|
|
function resetPresets() {
|
|
if (!confirm('Reset to default presets?')) return;
|
|
savePresets(DEFAULT_FREQ_PRESETS.slice());
|
|
renderPresets();
|
|
}
|
|
|
|
/**
|
|
* Apply a timing preset — fills all six pulse timing fields at once.
|
|
* @param {number} s Short pulse (µs)
|
|
* @param {number} l Long pulse (µs)
|
|
* @param {number} r Reset/gap limit (µs)
|
|
* @param {number} g Gap limit (µs)
|
|
* @param {number} t Tolerance (µs)
|
|
* @param {number} b Min bits
|
|
*/
|
|
function setTiming(s, l, r, g, t, b) {
|
|
var fields = {
|
|
ookShortPulse: s,
|
|
ookLongPulse: l,
|
|
ookResetLimit: r,
|
|
ookGapLimit: g,
|
|
ookTolerance: t,
|
|
ookMinBits: b,
|
|
};
|
|
Object.keys(fields).forEach(function (id) {
|
|
var el = document.getElementById(id);
|
|
if (el) el.value = fields[id];
|
|
});
|
|
}
|
|
|
|
// ---- Auto bit-order suggestion ----
|
|
|
|
/**
|
|
* Count printable chars for MSB and LSB across all stored frames,
|
|
* then switch to whichever produces more readable output.
|
|
*/
|
|
function suggestBitOrder() {
|
|
if (state.frames.length === 0) return;
|
|
var msbCount = 0, lsbCount = 0;
|
|
state.frames.forEach(function (msg) {
|
|
msbCount += interpretBits(msg.bits, 'msb').printable.length;
|
|
lsbCount += interpretBits(msg.bits, 'lsb').printable.length;
|
|
});
|
|
var best = msbCount >= lsbCount ? 'msb' : 'lsb';
|
|
setBitOrder(best);
|
|
var label = document.getElementById('ookSuggestLabel');
|
|
if (label) {
|
|
var winner = best === 'msb' ? msbCount : lsbCount;
|
|
label.textContent = best.toUpperCase() + ' (' + winner + ' printable)';
|
|
label.style.color = '#00ff88';
|
|
}
|
|
}
|
|
|
|
// ---- Pattern search / filter ----
|
|
|
|
/**
|
|
* Show only frames whose hex or ASCII interpretation contains the query.
|
|
* Clears filter when query is empty.
|
|
* @param {string} query
|
|
*/
|
|
function filterFrames(query) {
|
|
state.filterQuery = query.toLowerCase().trim();
|
|
var q = state.filterQuery;
|
|
var panel = document.getElementById('ookOutput');
|
|
if (!panel) return;
|
|
var divs = panel.querySelectorAll('.ook-frame');
|
|
divs.forEach(function (div) {
|
|
if (!q) {
|
|
div.style.display = '';
|
|
div.style.background = '';
|
|
return;
|
|
}
|
|
var bits = div.dataset.bits || '';
|
|
var interp = interpretBits(bits, state.bitOrder);
|
|
var match = interp.hex.includes(q) || interp.ascii.toLowerCase().includes(q);
|
|
div.style.display = match ? '' : 'none';
|
|
div.style.background = match ? 'rgba(0,255,136,0.05)' : '';
|
|
});
|
|
}
|
|
|
|
// ---- UI ----
|
|
|
|
function updateUI(running) {
|
|
var startBtn = document.getElementById('ookStartBtn');
|
|
var stopBtn = document.getElementById('ookStopBtn');
|
|
var indicator = document.getElementById('ookStatusIndicator');
|
|
var statusText = document.getElementById('ookStatusText');
|
|
|
|
if (startBtn) startBtn.style.display = running ? 'none' : '';
|
|
if (stopBtn) stopBtn.style.display = running ? '' : 'none';
|
|
if (indicator) indicator.style.background = running ? '#00ff88' : 'var(--text-dim)';
|
|
if (statusText) statusText.textContent = running ? 'Listening' : 'Standby';
|
|
|
|
// Keep output panel visible if there are frames to review (even after stopping)
|
|
var outputPanel = document.getElementById('ookOutputPanel');
|
|
if (outputPanel) {
|
|
var showPanel = running || state.frames.length > 0;
|
|
outputPanel.style.display = showPanel ? 'flex' : 'none';
|
|
}
|
|
}
|
|
|
|
// ---- Public API ----
|
|
|
|
return {
|
|
init: init,
|
|
destroy: destroy,
|
|
start: start,
|
|
stop: stop,
|
|
setFreq: setFreq,
|
|
addPreset: addPreset,
|
|
removePreset: removePreset,
|
|
resetPresets: resetPresets,
|
|
renderPresets: renderPresets,
|
|
setEncoding: setEncoding,
|
|
setTiming: setTiming,
|
|
setBitOrder: setBitOrder,
|
|
suggestBitOrder: suggestBitOrder,
|
|
filterFrames: filterFrames,
|
|
clearOutput: clearOutput,
|
|
exportLog: exportLog,
|
|
exportJSON: exportJSON,
|
|
copyCommand: copyCommand,
|
|
};
|
|
})();
|