Restore 22 pages + 23 images deleted by mistake in 3b9277a (2026-07-30)
Commit 3b9277a ("Binary ops: one format, no version framing") was pushed from
an incomplete working copy of the wiki: alongside its intended 11-line edit to
Canvas-Ops-Reference.md it recorded deletions of every page not in that copy --
22 pages (Home, Quick-Start, Provisioning, Calibration, FAQ, Hardware, ...) and
23 screenshots. _Sidebar.md still linked all of them, so 22 of 28 nav links 404'd.
Restored verbatim from 3b9277a's parent. Additions only; the 8 pages that
evolved since 2026-07-30 are left at their current content.
Binary ops: one format, no version framing
The library is the companion's own — 'vendored snapshot' retired
Some apps originated in splitflap-os and have been enhanced since; many
more were created here. Using-splitflap-os said the companion ships a
vendored snapshot of csader's library; it and every remaining 'vendored'
phrasing across the wiki now say built-in / its own library.
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.
The companion has its own app library — the csader relationship, stated honestly
The ecosystem graphic claimed the companion 'runs the splitflap-os app
library (csader)'; it ships its OWN library and speaks the splitflap-os
plugin format. Regenerated, and the framing aligned across the wiki:
splitflap-os is an acknowledged alternative content engine (A/B/E/F);
apps written for it drop in and run here — that inbound direction stays
a hard contract; apps written here MAY run there, without the injected
helpers and unoptimized, with no guarantees. Compatibility's goal
paragraph now says exactly that.
Also: Writing-Apps documents the grown get_weather surface (sky tokens,
days=N forecast + hourly, air=True with labels and canonical bands), and
Built-in Apps gains the countdown's per-unit colour-bar panel and the
weather app's forecast/AQI/UV/pollen in their rows.
Drop the Serial Bridge page: splitflap-os speaks MQTT natively now
The virtual-PTY bridge existed so a serial-only splitflap-os could ride the
gateway's MQTT. splitflap-os has since gained native MQTT support, so the
E/F configurations are just a transport setting in splitflap-os itself —
no bridge, no PTY, nothing to install. Using-splitflap-os says so; Home
and the sidebar drop the entry.
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.
Wiki: Writing Apps + Compatibility move in from the repo, fact-checked against the code
Every claim audited against the companion source; the wrong ones fixed:
loop_delay default is 8, 'id' is a fallback not an override, lowercase
colour codes are animation-only, the real date app (i18n, rows>=4),
per-app anim_speed/anim_style, the full catalog-globals list, global_key
is ignored, /sports_search is the only sports endpoint, a trigger shows
the first page only, the safety audit also blocks threads/processes,
and app directories are NOT importable (single-module apps only).
Sidebar gains an 'Extend it' section; external repo-doc links become
wiki links.
Configurations: splitflap-os-through-the-Gateway becomes first-class (E/F); library-divergence and app-upload fixes
Two combinations were demoted to a footnote and belong in the grid: the Gateway owning the
bus with splitflap-os providing content over MQTT, on either firmware (E: original, F:
Universal). The grid is now seven columns with sections regrouped by driver (A/B direct
sfOS, C/D gateway alone, E/F sfOS-through-gateway, G companion ★), and 'Switching later'
covers the new moves (A/B -> E/F).
Also, per review: the companion's apps are described as a vendored SNAPSHOT of the
splitflap-os library that may diverge over time — not 'the same app library'; softened the
same claim on Home/Companion/Using-splitflap-os. New grid row for uploading your own apps
from the browser (companion). And the click-to-type compose grid is correctly credited to
splitflap-os as well as the companion — it was wrongly annotated as companion-only.
Add 'Choosing a Configuration': every viable firmware × driver mix, with a feature grid
The stack is swappable at two joints — module firmware (Adam's original vs Universal) and
the driver (splitflap-os on a Pi, the Gateway alone, or Gateway + Companion). The new page
describes each viable combination (including splitflap-os through the Gateway over MQTT,
and the Matrix Portal substitution), a ~20-row feature grid across the five main configs,
footnotes for the depends-on-firmware cases, and how to migrate between configs without
redoing work. Universal → Gateway → Companion is called out as the most featureful path.
splitflap-os facts (playlists, calibration tools, both-firmware compatibility, MQTT
gateway mode, no scheduler/triggers per its README) checked against csader/splitflap-os.
Wired into the sidebar, Home TOC, Quick Start and the splitflap-os page; the splitflap-os
page's 'targets its own environment' line corrected to the fuller picture.
Comprehensive combined wiki for the whole SplitFlap ecosystem
Ties together all the projects — hardware (Adam G Makes), Universal Firmware, Gateway,
Matrix Portal Gateway, Companion (+ HA add-on and HACS integration), and splitflap-os — into
one guided flow from parts to a message on the wall, with optional steps clearly marked.
Pages: Home (ecosystem + TOC), Quick Start (end-to-end, two paths), Hardware, Module
Firmware, Gateway, Matrix Portal Gateway, Companion, Home Assistant (five surfaces), Using
splitflap-os, FAQ & Glossary, plus a sidebar. Includes made-up-data UI mockups (ecosystem
diagram, companion Apps tab, gateway Modules tab, HA device).