jessey
305b6c4497
Planning docs (SPEC, ARCHITECTURE, MODULES, ROADMAP, DECISIONS) with decisions D1-D15 settled: RigDoctor name, Python 3 + Qt/PySide6 stack (core/CLI/daemon stdlib-only), Ubuntu + NVIDIA first, .deb packaging, read-only + suggestions, GUI + tray modules, stress module dropped. First code: the M1 sensor core (stdlib-only) and a CLI. - core engine: Reading/Sample model, Sampler, hwmon reader - self-probing sources (NVIDIA first): nvidia-smi GPU, coretemp/k10temp CPU, /proc/meminfo + DDR5 SPD memory, NVMe storage - CLI: snapshot (text/JSON), monitor, sources; record/report stubbed - stdlib unittest smoke tests Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
57 lines
3.5 KiB
Markdown
57 lines
3.5 KiB
Markdown
# RigDoctor — Module Catalog (DRAFT v0.2)
|
|
|
|
Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
|
|
|
> Final module set (D14). **M7 (stress/repro) was dropped (D7).** M10/M11 are the GUI and
|
|
> tray modules (D10/D11). GPU scope reads "all (NVIDIA first)" — NVIDIA is implemented first,
|
|
> others via the vendor abstraction (D4).
|
|
|
|
| ID | Module | Bundle | Key deps | GPU scope | Priority | Status |
|
|
|----|--------|--------|----------|-----------|----------|--------|
|
|
| M1 | Sensor core | Essential | none (nvidia-smi, sysfs) | all (NVIDIA first) | P0 | ⬜ |
|
|
| M3 | Crash-capture logger | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | ⬜ |
|
|
| M4 | Health report (log scan) | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | ⬜ |
|
|
| M2 | Live monitor (TUI) | Monitoring | none (stdlib curses) | all | P1 | ⬜ |
|
|
| M8 | Alerting | Monitoring | libnotify (opt) | all | P2 | ⬜ |
|
|
| M5 | System inventory | Diagnostics | none (opt: lm-sensors, dmidecode) | all | P1 | ⬜ |
|
|
| M6 | Gaming env checks | Diagnostics | none | all | P2 | ⬜ |
|
|
| M10 | Desktop GUI | Desktop UI | **python3-pyside6** | all | P2 | ⬜ |
|
|
| M11 | Tray / menu-bar applet | Desktop UI | **python3-pyside6** (+ AppIndicator on GNOME) | all | P2 | ⬜ |
|
|
| M9 | Installer | (meta) | none | all | P1 | ⬜ |
|
|
| ~~M7~~ | ~~Stress / repro~~ | — | — | — | — | ❌ dropped (D7) |
|
|
|
|
## Notes per module
|
|
- **M1 Sensor core** — the foundation everything else samples from. Stdlib-only. Abstracts
|
|
NVIDIA/AMD/Intel + hwmon behind one interface; **ship the NVIDIA + hwmon path first**.
|
|
- **M3 Crash-capture logger** — the highest-value piece for the seed use case. `fsync` per
|
|
sample; GPU-lost detection via query timeout; bounded rotation; `systemd --user` service
|
|
with a **user-selectable trigger mode** (always-on / game-launch / manual — D6).
|
|
- **M4 Health report** — turns scattered logs into a prioritized, plain-language findings
|
|
list with **suggested** fixes (read-only, D9). Reuses M1 for a live snapshot. Also powers
|
|
the **guided diagnostic session** (with M3): pick a game → focused capture → scan →
|
|
findings (see SPEC §4).
|
|
- **M2 Live monitor** — depends on M1; the terminal "HWMonitor for Linux" face. Stdlib-only.
|
|
- **M5 / M6 Diagnostics** — inventory export + gaming-env checks; M6 flags risky settings and
|
|
suggests the fix command but does not apply it (D9).
|
|
- **M8 Alerting** — threshold/event notifications; integrates with the tray applet (M11).
|
|
- **M10 Desktop GUI** — PySide6 graphical front-end over the core engine (dashboard, log
|
|
browser, report viewer, logger controls). Optional; adds the Qt dependency.
|
|
- **M11 Tray applet** — `QSystemTrayIcon` menu-bar applet. Dropdown shows live M1 readouts
|
|
(CPU temp, GPU temp, memory used/total, status dot) and is led by a **Run Diagnostic**
|
|
action (the guided diagnostic session), plus Open dashboard / Start-Stop recording /
|
|
Snapshot / Quit (D13). Optional; shares the Qt dependency with M10.
|
|
- **M9 Installer** — interactive wizard layered on the `.deb` (D8); apt-first dependency
|
|
resolution; enables the logger service and trigger mode.
|
|
|
|
## Bundles (final — D14)
|
|
- **Essential:** M1 + M3 + M4 *(the MVP, NVIDIA-only — D5)*
|
|
- **Monitoring:** M2 + M8
|
|
- **Diagnostics:** M5 + M6
|
|
- **Desktop UI:** M10 + M11 *(adds PySide6)*
|
|
|
|
## MVP candidate — *confirmed (D5)*
|
|
**M1 + M3 + M4 (Essential), NVIDIA-only, CLI-first.** Gives a working tool that captures the
|
|
GPU crash and explains the logs — deliverable before the installer, GUI/tray, or multi-vendor
|
|
work.
|
|
</content>
|