Flesh out PLAN.md with two-architecture implementation detail #2
4 changed files with 33 additions and 22 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -175,3 +175,6 @@ cython_debug/
|
|||
# Superpowers brainstorm companion working dir
|
||||
.superpowers/
|
||||
|
||||
|
||||
# Local wiki checkout (separate git repo)
|
||||
docs/wiki/
|
||||
|
|
|
|||
52
README.md
52
README.md
|
|
@ -1,31 +1,39 @@
|
|||
# claude-gauge
|
||||
|
||||
Hardware instrument cluster displaying Claude Code session telemetry.
|
||||
Hardware instrument cluster displaying Claude Code session telemetry
|
||||
in real time.
|
||||
|
||||
Three analog needle gauges (5h fuel, tokens/min tach, 7d fuel) plus
|
||||
an annunciator row of model-indicator and warning lamps, driven by
|
||||
an ESP32 polling a local Python daemon. The daemon reads either
|
||||
Claude Code's native OpenTelemetry feed through a Prometheus stack
|
||||
(architecture A) or `ccusage` CLI aggregates with a direct JSONL
|
||||
tail for the tach (architecture B). Firmware and cluster are
|
||||
identical across both.
|
||||

|
||||
|
||||
Fighter-jet / race-car aesthetic. Physical-first: all the deep
|
||||
stats live in Grafana (A) or ccusage's own surfaces (B). The dial
|
||||
on the desk is the ambient summary.
|
||||
Four analog needle gauges (5h fuel, tokens/min tach, thinking ratio,
|
||||
cache hit) plus an annunciator row of model-indicator and warning
|
||||
lamps, driven by an ESP32 polling a local Python daemon. The daemon
|
||||
reads either Claude Code's native OpenTelemetry feed through a
|
||||
Prometheus stack (architecture A) or `ccusage` CLI aggregates with a
|
||||
direct JSONL tail for the tach (architecture B). Firmware and
|
||||
cluster are identical across both.
|
||||
|
||||
See [PLAN.md](PLAN.md) for:
|
||||
Fighter-jet / race-car aesthetic. Physical-first: the deep stats
|
||||
live in Grafana (A) or `ccusage` (B); the dial on the desk is the
|
||||
ambient summary.
|
||||
|
||||
* Instrument cluster layout and annunciator semantics
|
||||
* Architecture A: Docker Compose stack, Claude Code env config,
|
||||
PromQL queries, daemon sketch
|
||||
* Architecture B: ccusage subprocess integration, watchdog tail,
|
||||
daemon sketch
|
||||
* Hardware: X27.168 steppers, SwitecX25 library, ESP32 wiring,
|
||||
enclosure notes
|
||||
* Six-phase plan from daemon MVP through enclosure V1
|
||||
* Full metrics brainstorm for later phases
|
||||
## Documentation
|
||||
|
||||
Full documentation is in the [wiki](https://forgejo.labbity.unbiasedgeek.com/archeious/claude-gauge/wiki):
|
||||
|
||||
* **Home** — overview and cluster at a glance
|
||||
* **Architecture** — two-architecture tradeoff, daemon contract
|
||||
* **DataSources** — Docker Compose + PromQL (A), `ccusage` +
|
||||
watchdog (B)
|
||||
* **Hardware** — X27.168 steppers, ESP32 wiring, firmware,
|
||||
enclosure
|
||||
* **Roadmap** — phases, shipped, deferred
|
||||
* **Ideas** — exotic enclosure variants, metrics brainstorm,
|
||||
parked thoughts
|
||||
|
||||
Working notes live in [PLAN.md](PLAN.md). Session records and
|
||||
in-flight thinking happen there; the wiki is the curated surface.
|
||||
|
||||
## Status
|
||||
|
||||
Scaffolded. Phase A pending architecture decision and first issue.
|
||||
Scaffolded. Phase A pending architecture decision.
|
||||
|
|
|
|||
BIN
docs/images/exotic-dashes.png
Normal file
BIN
docs/images/exotic-dashes.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.3 MiB |
BIN
docs/images/monitor-dash.png
Normal file
BIN
docs/images/monitor-dash.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.7 MiB |
Loading…
Reference in a new issue