Skip to content

Reference

Formal specifications — vocabulary, wire format, REST endpoints, event channels, file formats. The byte-level / interface-level truth that backs the narrative docs.

  • Glossary — canonical terminology used across every other doc.
  • Wire protocol — packet headers, opcode bodies, per-direction rules, framing, gateway state machine.
  • Opcodes (CONTROL / OFFSET / SYNC) — pragmatic "when do I use which opcode?" explanation that sits alongside the wire-level spec.
  • Region & Channels — shipped EU868 / US915 channel tables, table-shape schema, separation rule, compliance disclaimer.
  • Deterministic WLED effects — which effects render identically across nodes when only the timebase is synced (prerequisite for offset mode).
  • Broadcast ruleset — two-stage filter pipeline (wire recv3 → per-opcode groupId) and per-opcode accept matrix.
  • Wire timing — per-packet wall-clock breakdown from host enqueue through USB to RF transmit.
  • WLED OTA gate matrix — the four gates WLED's /update handler runs (same-subnet, settings-PIN, OTA-lock, release-name) and the five firmware-side options to ship same-subnet=false.
  • Scene file format — on-disk shape of scenes.json (action kinds, params, flags-overrides).
  • Web API — REST endpoints exposed by the host (consumed by the WebUI; sometimes by external scripts).
  • SSE channels & state scopes — the Server-Sent-Events stream the WebUI subscribes to, plus the state-scope tokens that determine which UI elements refresh.