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

docs: FiWiManager example path; drop hub_manager references 

Use FiWiManager in remote_ssh.env.example. Remove obsolete hub_manager
mentions from design and CLI docs.

Made-with: Cursor
This commit is contained in:
Robert McMahon 2026-03-30 18:18:50 -07:00
parent a030549f61
commit e9ddcd7b2b
3 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/fiwi-cli.md
View File

@ -8,8 +8,6 @@ This document lists how to invoke the Fi-Wi CLI from a shell. For architecture,
python3 /path/to/fiwi.py [options] <command> [arguments…] python3 /path/to/fiwi.py [options] <command> [arguments…]
``` ```
`hub_manager.py` in the same directory is **deprecated** and prints a warning; use `fiwi.py`.
## Global options ## Global options
| Option / env | Meaning | | Option / env | Meaning |

1
docs/fiwi-design.md
View File

@ -12,7 +12,6 @@ The Fi-Wi stack ties together **Acroname / BrainStem USB hubs**, a **patch panel
|--------|------| |--------|------|
| `fiwi.py` | Entry point; configures `fiwi.paths` with the install directory, then runs `fiwi.cli.main`. | | `fiwi.py` | Entry point; configures `fiwi.paths` with the install directory, then runs `fiwi.cli.main`. |
| `fiwi/` | Library: harness, SSH transport, fiber map I/O, USB/wireless probes, diagnostics. | | `fiwi/` | Library: harness, SSH transport, fiber map I/O, USB/wireless probes, diagnostics. |
| `hub_manager.py` | Deprecated shim; forwards to the same CLI as `fiwi.py`. |
| `fiber_map.json` | Lives next to `fiwi.py` (see `fiwi.paths`). Operator-edited or calibrate-produced. | | `fiber_map.json` | Lives next to `fiwi.py` (see `fiwi.paths`). Operator-edited or calibrate-produced. |
| `remote_ssh.env` / `.fiwi_remote` | Optional dotenv next to the install; merged into process env for SSH defaults (see `SshNodeConfig`). | | `remote_ssh.env` / `.fiwi_remote` | Optional dotenv next to the install; merged into process env for SSH defaults (see `SshNodeConfig`). |

2
remote_ssh.env.example
View File

@ -7,7 +7,7 @@
# realpath /path/to/fiwi.py # realpath /path/to/fiwi.py
FIWI_REMOTE_PYTHON=/home/pi/venv/bin/python3 FIWI_REMOTE_PYTHON=/home/pi/venv/bin/python3
FIWI_REMOTE_SCRIPT=/home/pi/UmberHubManager/fiwi.py FIWI_REMOTE_SCRIPT=/home/pi/FiWiManager/fiwi.py
# Optional: comma-separated hosts for hybrid panel calibrate (with local hubs in one run): # Optional: comma-separated hosts for hybrid panel calibrate (with local hubs in one run):
# FIWI_CALIBRATE_REMOTES=pi@192.168.1.50,pi@192.168.1.51 # FIWI_CALIBRATE_REMOTES=pi@192.168.1.50,pi@192.168.1.51