capabilities: surface descriptor (led-matrix | lcd), family-wide v3.17
v3.16: FATFS backup/self-restore + settings export/import
fix timer/alarms wire fields (min/sec/stop, active, array-of-slots) -- documented from the code this time
v3.14-v3.15: timer/alarms, log tail, gestures (claps/taps), SSE gesture events, dim schedule + gesture settings
Reset-cause ring (status.resets) + on-card event log /logs/gateway.log
Documentation review: current-firmware-only, Matrix Gateway naming, full feature coverage
- every old-firmware version tag/caveat removed across all pages (headings
de-tagged with inbound anchors fixed in lockstep); Matrix-Gateway's intro
changelog replaced with current-state prose
- naming: Matrix Portal -> Matrix Gateway (wire strings/repo URLs kept)
- accuracy: capabilities sample matches fw 3.13 (opsBin boolean, compositing,
33 ops, 12 effects, conditional feature tokens, no api/effectParams/ha);
opsb endpoint + stream record 0x06 documented; scope/spectro/maze added;
Weather Sky references replaced (merged into Weather); BTC min-wall,
Photo Frame badge, Livestream badge, broken images -> gallery raw URLs
- new-feature coverage: icon_svg + interactive manifest rows, takeover /
quiet-in-attract / taps+presses in the games section, paginate +
get_ha_states helpers, dependency list (httpx2, Pillow, babel, dateutil),
can_* flag inventory, OpenAPI discovery (gateways + companion)
microSD streaming (anim/wav), spectrogram, brightness schedule (fw 3.13)
Strip legacy-client language: one honest version, effectParams removed, opsBin level framing (fw 3.12)
Wiki: microSD (browse/mkdir/recursive delete), oscilloscope, depth-4 PSRAM framebuffer (fw 3.10-3.11)
v3.7.0: onboard SHTC3 temp/humidity sensor (/api/environment, environment token)
Gateway-API: /api/sound Quiet-Time silence + master enable/volume (v3.6.1)
v3.6.0: /api/sound (tones/chimes), gradient radial/angle/dither
Gateway-API: /api/events also carries status events since fw 3.2
Matrix Gateway 3.0/3.0.1: SSE events, display-state mode+flaps, MQTT/HA removal, QOI transitions, UTF-8 text, ops throughput; document the v2.2 files/brightness/reboot surface
Matrix Gateway v3.0: native esp_http_server, SSE live preview, raw-body uploads, MQTT/HA removed
Wiki: rewrite backward-looking phrasing in present tense
Drop 'as it always did / was', 'no longer', 'it did not always work that way'
and similar comparisons to prior behaviour — they only make sense to readers who
saw earlier versions. State the current behaviour as simply how it works.
Matrix Gateway + canvas: bring the wiki up to firmware 1.24 / companion 2.8
- New Canvas API page (full /api/canvas/* reference) + sidebar entry.
- Gateway-API: Matrix send paths are /api/frames/* (not /api/rs485/*); module
rows are {id, flapIndex, flapChar}; MQTT frames/tx + frames/send, rx removed;
maintenance is SplitFlap-only; panel.depth in status; canvas/effects/effectParams
in capabilities; features list corrected.
- Matrix-Gateway: frames are one-way (no v/A queries, no replies, no serials);
no module registry; canvas section rewritten to point at the Canvas page;
bit-depth auto-clamp note for large panels.
- Built-in-Apps / Writing-Apps: six effects with hue/density, new Animation and
Ticker apps, QOI, and the canvas helper's ticker/anim/paste methods.
RS-485 SplitFlap Gateway content left unchanged (correct as-is).
mDNS names carry the board id: splitflap-gw-xxxxxx.local
Firmware 3.11 gives the SplitFlap Gateway the suffixed hostname the
Matrix Gateway always had (plain splitflap-gw collides the moment a
second gateway joins the LAN). Every page that named the old address
now shows the suffixed form and says where to find yours: the boot log
and the router's device list.
Two gateways, two names — plus Provisioning and Calibration get their own pages
SplitFlap Gateway drives real modules; Matrix Gateway draws a simulated
wall on an LED matrix. The Gateway and Matrix-Portal-Gateway pages are
renamed (redirect stubs left at the old names), 21 pages re-worded, and
both diagrams regenerated with the new labels — the configurations
diagram also aligns all seven Modules boxes on one row.
New: Module provisioning (the full process — the SplitFlap Gateway's
Provision tab and bare-metal provision.py in detail, splitflap-os's
built-in equivalent acknowledged without detail) and Module calibration
(the CALIBRATION_GUIDE ported: the three quantities, the golden order,
nudge vs exact offset, per-flap tuning, the wizard and whole-board pass,
the control reference). Linked from the sidebar's Build-it section,
Home, Module-Firmware and the SplitFlap Gateway tab tour.
Gateway API: 'ESP32 only' was no distinction — both gateways are ESP32s
The Matrix Portal is an ESP32-S3, so labeling the RS-485 product 'the
ESP32' told readers nothing. Labels are now RS-485 gateway / Matrix
Portal, with a terminology note where the two products are introduced.
The motion capability: the wall states how it moves
Gateway-API documents the new /api/capabilities motion key (Gateway 3.10+,
Matrix Portal 1.12+); Writing-Apps' caps table gains instant — the flag an
app gates any ticking display on; Compatibility lists it with the other
caps fields.
Wiki: five reference pages close the repo-doc gaps; provisioning is in splitflap-os now
A census of all four repos found documentation living only in repo READMEs;
the wiki now carries it:
- Bus Protocol — the RS-485 wire reference: frames, addressing, every module
command with reply grammars and result codes, EEPROM layout, boot sequence.
- Gateway API — REST + MQTT for both gateways, /api/capabilities set
arithmetic, the companion registration + settings-blob contract.
- Companion without Home Assistant — Docker, the install script, the full
COMPANION_* configuration reference, settings storage & disaster recovery.
- Languages & Localization — every language surface and how to contribute one.
- Serial Bridge — splitflap-os over the gateway's MQTT via a virtual PTY,
including Mosquitto setup.
Corrections: splitflap-os now provisions from its own UI (provision.py is
optional, three pages updated); Multiple Displays documents the network scan;
Gateway links its API reference; Home lists all 22 pages + release-notes
links; sidebar gains Reference entries; Built-in Apps adds the Binary Clock
and the Matrix-Portal-only seconds options. Every GitHub link curl-verified.