src.nth.io/

summaryrefslogtreecommitdiff
path: root/scrypted/diagnostic.ts
diff options
context:
space:
mode:
authorLuke Hoersten <[email protected]>2026-07-17 19:49:47 -0500
committerLuke Hoersten <[email protected]>2026-07-17 19:49:47 -0500
commit3821512b18be69cad002faf77f1e5844bda13c95 (patch)
tree885f61c3c76f5e4dc4f8d16050da6bc96abe032d /scrypted/diagnostic.ts
parent2a4b8296d71f25e5a29a07ea6cc9f3ac31676c48 (diff)
scrypted: mdns discovery — browse, host choices, auto-heal
Browse for _scrypted-viewport._tcp with a plain dgram socket on an EPHEMERAL port: per RFC 6762 §6.7 a query from a non-5353 source port is a legacy unicast query and responders reply unicast to that port — verified in the ESP-IDF responder (mdns_send.c answers to the querier's addr/port whenever src_port != 5353). No :5353 bind means no conflict with Scrypted's own HomeKit mDNS or a host avahi-daemon, and it works under Docker host-networking or native alike. One response packet carries PTR+SRV+TXT+A (RFC 6763 §12.1), so parsing is per-packet with no follow-up queries; the wire codec (name compression included) is ~150 lines, no dependencies. Surfaced three ways: - add-device form: host field is a combobox listing discovered viewports as "ip — name (vX, WxH)"; manual entry still works and only the address token is stored. - child settings page: same choices on the existing host field. - auto-heal: when a /config register fails, re-browse and match by MAC (seeded from /state and discovery; survives renames) then by name; on a hit at a new address, rewrite host and retry once. Runs only on register failure, so it's rate-limited to the 5-min cycle and removes the need for a DHCP reservation. Browses are best-effort ([] on any failure) and cached 30s so settings re-renders don't spam the LAN. diagnostic.ts gains the same browse as a paste-and-run probe that validates dgram + multicast reachability from inside the real Scrypted sandbox before trusting the feature.
Diffstat (limited to 'scrypted/diagnostic.ts')
-rw-r--r--scrypted/diagnostic.ts139
1 files changed, 138 insertions, 1 deletions
diff --git a/scrypted/diagnostic.ts b/scrypted/diagnostic.ts
index e7a3ba3..29beb4f 100644
--- a/scrypted/diagnostic.ts
+++ b/scrypted/diagnostic.ts
@@ -1,7 +1,17 @@
// Paste into the diagnostic / probe Scrypted script. Save + Run.
-// Tells us which Node/mDNS modules the scriptedEval sandbox lets us
+//
+// Probe 1: which Node/mDNS modules the scriptedEval sandbox lets us
// require() — drives whether the auto-discovery feature can use a
// proper library or has to fall back to raw multicast UDP.
+//
+// Probe 2: one-shot mDNS browse for `_scrypted-viewport._tcp` using the
+// exact dgram legacy-unicast approach the main plugin uses (ephemeral
+// source port; responders reply unicast per RFC 6762 §6.7). Validates,
+// from inside the real sandbox: (a) dgram works, (b) multicast TX
+// reaches the LAN, (c) the firmware answers. Expected output: one `rx`
+// line + one parsed line per viewport on the LAN. Zero `rx` lines from
+// a Docker install usually means bridge networking — switch the
+// container to host networking.
declare const require: any;
@@ -22,3 +32,130 @@ for (const mod of [
console.log(` ${mod.padEnd(16)} -> ${e?.code || "ERR"}: ${e?.message || e}`);
}
}
+
+// ---- Probe 2: mDNS browse (same code path as the plugin's mdnsBrowse) ----
+
+const MDNS_SERVICE = "_scrypted-viewport._tcp.local";
+
+function buildMdnsQuery(): Buffer {
+ const labels = MDNS_SERVICE.split(".");
+ let qnameLen = 1;
+ for (const l of labels) qnameLen += 1 + l.length;
+ const buf = Buffer.alloc(12 + qnameLen + 4);
+ buf.writeUInt16BE(Date.now() & 0xffff, 0);
+ buf.writeUInt16BE(1, 4);
+ let off = 12;
+ for (const l of labels) {
+ buf.writeUInt8(l.length, off++);
+ buf.write(l, off, "ascii");
+ off += l.length;
+ }
+ buf.writeUInt8(0, off++);
+ buf.writeUInt16BE(12, off); // PTR
+ buf.writeUInt16BE(1, off + 2); // IN
+ return buf;
+}
+
+function readDnsName(msg: Buffer, off: number): { name: string; next: number } {
+ const parts: string[] = [];
+ let next = -1, jumps = 0;
+ while (off < msg.length) {
+ const len = msg[off];
+ if (len === 0) { if (next < 0) next = off + 1; break; }
+ if ((len & 0xc0) === 0xc0) {
+ if (next < 0) next = off + 2;
+ if (++jumps > 16) break;
+ off = ((len & 0x3f) << 8) | msg[off + 1];
+ continue;
+ }
+ parts.push(msg.subarray(off + 1, off + 1 + len).toString("ascii"));
+ off += 1 + len;
+ }
+ return { name: parts.join("."), next: next < 0 ? off : next };
+}
+
+function parseMdnsResponse(msg: Buffer): any[] {
+ try {
+ if (msg.length < 12) return [];
+ const qd = msg.readUInt16BE(4);
+ const total = msg.readUInt16BE(6) + msg.readUInt16BE(8) + msg.readUInt16BE(10);
+ let off = 12;
+ for (let i = 0; i < qd; i++) off = readDnsName(msg, off).next + 4;
+ const ptrs: string[] = [];
+ const srvs = new Map<string, { target: string; port: number }>();
+ const txts = new Map<string, Record<string, string>>();
+ const addrs = new Map<string, string>();
+ for (let i = 0; i < total && off < msg.length; i++) {
+ const rec = readDnsName(msg, off);
+ off = rec.next;
+ if (off + 10 > msg.length) break;
+ const type = msg.readUInt16BE(off);
+ const rdlen = msg.readUInt16BE(off + 8);
+ off += 10;
+ if (off + rdlen > msg.length) break;
+ const key = rec.name.toLowerCase();
+ if (type === 12 && key === MDNS_SERVICE) {
+ ptrs.push(readDnsName(msg, off).name);
+ } else if (type === 33) {
+ srvs.set(key, { target: readDnsName(msg, off + 6).name,
+ port: msg.readUInt16BE(off + 4) });
+ } else if (type === 16) {
+ const kv: Record<string, string> = {};
+ for (let t = off; t < off + rdlen; ) {
+ const l = msg[t];
+ const s = msg.subarray(t + 1, t + 1 + l).toString("utf8");
+ const eq = s.indexOf("=");
+ if (eq > 0) kv[s.slice(0, eq)] = s.slice(eq + 1);
+ t += 1 + l;
+ }
+ txts.set(key, kv);
+ } else if (type === 1 && rdlen === 4) {
+ addrs.set(key, `${msg[off]}.${msg[off + 1]}.${msg[off + 2]}.${msg[off + 3]}`);
+ }
+ off += rdlen;
+ }
+ const out: any[] = [];
+ for (const inst of ptrs) {
+ const key = inst.toLowerCase();
+ const srv = srvs.get(key);
+ const txt = txts.get(key) || {};
+ const ip = srv ? addrs.get(srv.target.toLowerCase()) : undefined;
+ if (!srv || !ip) continue;
+ out.push({ inst, ip, port: srv.port, hostname: srv.target, txt });
+ }
+ return out;
+ } catch { return []; }
+}
+
+(async () => {
+ console.log("------ mdns browse probe (_scrypted-viewport._tcp) ------");
+ try {
+ const dgram = require("dgram");
+ const sock = dgram.createSocket({ type: "udp4", reuseAddr: true });
+ let rx = 0, parsed = 0;
+ sock.on("error", (e: Error) => console.log(` socket error: ${e.message}`));
+ sock.on("message", (msg: Buffer, rinfo: any) => {
+ rx++;
+ console.log(` rx ${rinfo.address}:${rinfo.port} ${msg.length}B`);
+ for (const v of parseMdnsResponse(msg)) {
+ parsed++;
+ console.log(` -> ${v.ip}:${v.port} name=${v.txt.name} mac=${v.txt.mac ?? "(pre-mac fw)"} ` +
+ `v=${v.txt.version} ${v.txt.resolution} ${v.txt.orientation} host=${v.hostname}`);
+ }
+ });
+ const query = buildMdnsQuery();
+ const send = () => { try { sock.send(query, 5353, "224.0.0.251"); } catch (e: any) { console.log(` send failed: ${e?.message}`); } };
+ sock.bind(0, () => {
+ console.log(` bound ephemeral port ${sock.address().port}; querying 224.0.0.251:5353 ...`);
+ send();
+ });
+ setTimeout(send, 400);
+ setTimeout(() => {
+ try { sock.close(); } catch {}
+ console.log(` browse done: ${rx} response packet(s), ${parsed} viewport record(s)`);
+ if (rx === 0) console.log(" (0 responses: if Scrypted runs in Docker, check it uses host networking)");
+ }, 1500);
+ } catch (e: any) {
+ console.log(` probe failed: ${e?.message || e}`);
+ }
+})();