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

docs(readme): broaden tagline; add planned SPC (Hotelling, Shewhart) section 

Made-with: Cursor
This commit is contained in:
Robert McMahon 2026-04-10 18:57:15 -07:00
parent a7759317f1
commit 46b0ca4ffc
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,6 +1,6 @@
# FiWiControl
Tools and libraries for managing and testing Umber Fi‑Wi networks.
Tools, libraries and statistical software for automating, managing, monitoring and testing Umber Fi‑Wi networks.
**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`.
@ -10,6 +10,10 @@ This repository ships that distribution (**`fiwicontrol`** on PyPI / `pip`) with
2. **`fiwicontrol.lab`** — USB discovery (Acroname / Monsoon) and **`configs/*.ini`** inventory load + verify. Imports **`fiwicontrol.commands`** for SSH discovery only.
3. **`fiwicontrol.power`** — **`Power`** (``.on()`` / ``.off()`` / ``.voltage()`` / …) via **`AcronamePower`** and **`MonsoonPower`**, plus a small CLI (**`--discovery-json`**, **`--list-power-devices`**, **`--verify-inventory`** with **`-c`**). Re-exports **`fiwicontrol.lab`** discovery/inventory for compatibility. May import **`fiwicontrol.commands`** and **`fiwicontrol.lab`**; the reverse is forbidden.
## Statistical process control (planned)
The project is intended to grow **statistical process control (SPC)** support—for example **Hotelling**-style multivariate monitoring and **Shewhart** control charts—for lab and field metrics tied to Fi‑Wi rigs. That code is **not** in the tree yet; today’s packages focus on automation, inventory, and power/USB control as described above.
**Layout**
```