Wiki: correct the splitflap-os feature grid; give Vestaboard + MCP their own pages
Feature grid — I built it from splitflap-os's README, which undersells it. Rebuilt
from the code (csader/splitflap-os main, with feat/app-triggers, feat/schedules and
feature/custom-char-map all merged in):
- Event triggers, schedules and quiet hours: splitflap-os HAS these. Was "—", now ✅
for every splitflap-os configuration.
- Flap sets: splitflap-os reads each module's flap count and character set from the
firmware and encodes against them, so a non-64 reel works — but it can't *write*
one. Split the row into "custom character set" and "flap count other than 64", both
✅ (web UI) only where the Universal Firmware meets the gateway, ⚠️ for sfOS.
- REST API: it has Flask endpoints for its own UI but no documented API. Now ⚠️.
- Localization: verified against upstream main — no language/locale settings there.
Left as "—" with a footnote saying so; i18n exists in forks.
Vestaboard + MCP are companion features, not Home Assistant features. They now have
their own pages, and the HA page links to them instead of owning them:
- Vestaboard-API: enabling it, the endpoints (GET returns {"message": [[…]]}, POST
201, 401 is plain text), the {"text": …} extension, ha-vestaboard and rest_command.
- MCP-Server: the eleven tools, why read-before-write matters, connecting Claude Code
and Desktop, and worked examples of what you can ask for.
Both are linked from the Companion's new "Ways to drive it from outside" section.
2424021
Wiki: flaps & character sets page, WiFi/mDNS setup, HA install steps, real screenshots
- New page "Flaps & Character Sets": the N command, the 64-flap budget, and
validated 64-flap starter sets for 12 locales (each exactly 64 unique CP1252
glyphs) — framed as a suggestion, not a prescription. Linked from the sidebar,
the Home TOC, the feature grid, Module Firmware and the Companion's
localization section.
- Gateway: full first-boot WiFi flow via the fallback AP, and a "Finding it on
your network" section — mDNS is best-effort, so document finding the IP from
the router/serial and using that everywhere (incl. GATEWAY_URL). Same for the
Matrix Portal, whose AP is named after its hostname.
- Home Assistant: step-by-step install for both the App (repository URL, the two
channels, gateway_url, sidebar) and the HACS integration (custom repository of
type Integration, restart, config flow against the *companion's* URL), plus a
full options table. Mirrored as a condensed step 6 in the Quick Start.
- Correct the calibration-compatibility claim: the gateway's Calibration tab
issues only original-protocol commands (c o s t g w h d) against
original-layout EEPROM fields, so it works fully on the original firmware. The
only version gate in the gateway UI is the flap-set editor (v31+).
- Swap the mocked-up screenshots for real ones rendered from the actual UIs with
fake data; drop ha-device.png; de-boastify a few lines; fix four dead anchors.
ba07ac0
Add a configurations diagram (A-G at a glance) to Choosing a Configuration
Same visual language as the Home page's ecosystem diagram: one mini-stack per
configuration showing what runs where (content engine, bus master, modules), the
transport on each hop (USB-RS485 / MQTT / REST / RS-485), the firmware colour-coded
(green Universal, amber original, dashed = nothing runs there), and G outlined as the
recommended path. Legend covers the firmware colours and the Matrix Portal substitution.
d039357
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.
54e7512
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.
16e8bce
Hardware: modules mount on a DIN rail with pogo-pin contacts, not point-to-point wiring
The bus description said the modules were daisy-chained with a two-wire pair. In Adam's
design there is no wiring between modules at all: each clips onto a DIN rail, and four pogo
pins on its underside contact a conductor rail carrying 12 V, GND and the two RS-485
signals — mounting a module is connecting it. Fixed in Hardware (prose, diagram, module
parts list, what-you-need table), Quick Start, and the FAQ glossary.
4297a2e
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).
04841cf