rjmcmahon
/
FiWiControl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(html): static Fi-Wi L4S spec for local browser viewing 

- Replace Fi-Wi-L4S.php (session_start preamble) with Fi-Wi-L4S.html
- README: .html path and note to open file locally

Made-with: Cursor
This commit is contained in:
Robert McMahon 2026-04-10 20:24:59 -07:00
parent a4b99f70d6
commit ed8020ecc3
2 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -2,7 +2,7 @@
Tools, libraries and statistical software for automating, managing, monitoring and testing Umber Fi‑Wi networks.
**Where it runs:** FiWiControl is built to run **on the Umber concentrator** — the Fi‑Wi control plane described in the architecture spec (**`html/Fi-Wi-L4S.php`** in this repo) — for **lab and customer** automation. Day-to-day development still uses **workstation** installs and **lab rigs** (e.g. Raspberry Pi) as in **`docs/install.md`**.
**Where it runs:** FiWiControl is built to run **on the Umber concentrator** — the Fi‑Wi control plane described in the architecture spec (**`html/Fi-Wi-L4S.html`** in this repo; open that file in a browser for local viewing) — for **lab and customer** automation. Day-to-day development still uses **workstation** installs and **lab rigs** (e.g. Raspberry Pi) as in **`docs/install.md`**.
**Naming:** The **Git repository** and checkout directory are **FiWiControl** (mixed case). The **Python distribution** and **import package** are **`fiwicontrol`** (all lowercase, PEP 8) — same project, different casing rules for Git vs Python. Use **`fiwicontrol`** for `pip install` / `import`, not `FiWiControl`.
@ -16,7 +16,7 @@ This repository ships that distribution (**`fiwicontrol`** on PyPI / `pip`) with
## Relationship to the Fi‑Wi architecture spec
The spec (**`html/Fi-Wi-L4S.php`**) describes the **Fi‑Wi system**: the **Umber concentrator** as the centralized **control, queueing, and time** plane, **RRHs** on the **PCIe / fronthaul** fabric, and the **L4S-oriented** latency model that depends on that split. FiWiControl does not implement the datapath or MAC; it is the **concentrator-resident (and dev-workstation) Python layer** that **manages and validates** the deployed system around that architecture.
The spec (**`html/Fi-Wi-L4S.html`**) describes the **Fi‑Wi system**: the **Umber concentrator** as the centralized **control, queueing, and time** plane, **RRHs** on the **PCIe / fronthaul** fabric, and the **L4S-oriented** latency model that depends on that split. FiWiControl does not implement the datapath or MAC; it is the **concentrator-resident (and dev-workstation) Python layer** that **manages and validates** the deployed system around that architecture.
Concretely, it is how we keep **what we think is connected** aligned with **what is actually cabled and powered**: **INI inventory and verification** (**`fiwicontrol.lab`**, **`fiwicontrol.power`**), **scripted remote work** over the same **SSH / `ush`** paths we use in production (**`fiwicontrol.commands`**), **programmable power and USB** so bring-up and PCIe **hot-plug** sequences are repeatable, **async iperf flows** for load and measurement against RRHs or lab stand-ins (**`fiwicontrol.flows`**), and **SPC** when we need statistical discipline across long campaigns (**`fiwicontrol.spc`**). Read the spec for **why** the topology and timing model look the way they do; read this repo and **`docs/`** for **how** we install, verify, and operate it day to day.
@ -56,7 +56,7 @@ FiWiControl/
├── README.md
├── pyproject.toml
├── html/
│ └── Fi-Wi-L4S.php
│ └── Fi-Wi-L4S.html
├── docs/
│ ├── install.md
│ ├── node-control-asyncio-design.md

4
html/Fi-Wi-L4S.php → html/Fi-Wi-L4S.html
View File

@ -1,7 +1,3 @@
<?php
// Public technical page – no auth required, but keep session for consistency
session_start();
?>
<!DOCTYPE html>
<html lang="en">
<head>