From 27dc5849c3eaf4824d79938e7077abdbe2c82e24 Mon Sep 17 00:00:00 2001
From: grothedev <grothedev@gmail.com>
Date: Fri, 29 May 2026 21:34:16 -0400
Subject: updates from claude. need to review. archiving rust and cpp stuff,
 going completely TS

---
 web-timeplot/README.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 75 insertions(+), 6 deletions(-)

(limited to 'web-timeplot/README.md')

diff --git a/web-timeplot/README.md b/web-timeplot/README.md
index 491753a..25dfb80 100644
--- a/web-timeplot/README.md
+++ b/web-timeplot/README.md
@@ -10,20 +10,29 @@ TimePlot is now a clean restart: a small PixiJS time-series sandbox built around
 - Current real-time and plot-time labels
 - Hover tooltip for data points
 - Modular synthetic data input system
+- CSV replay sources
+- WebSocket live sources
+- Persisted workspace settings
 - Toggleable side panels for status, source config, app config, and help
 
 ## Getting started
 
 ```bash
-npm install
-npm run dev
+bun install
+bun run dev
 ```
 
 Production build:
 
 ```bash
-npm run build
-npm run preview
+bun run build
+bun run preview
+```
+
+Demo WebSocket source:
+
+```bash
+bun run ws:demo
 ```
 
 ## Controls
@@ -34,6 +43,55 @@ npm run preview
 - `G` — toggle grid
 - Hover plot — inspect nearest sample
 
+## Demo data
+
+Sample CSV replay files are included in [public/demo-data](public/demo-data):
+
+- [public/demo-data/telemetry-sweep.csv](public/demo-data/telemetry-sweep.csv)
+- [public/demo-data/chirp-ramp.csv](public/demo-data/chirp-ramp.csv)
+- [public/demo-data/step-bursts.csv](public/demo-data/step-bursts.csv)
+
+Use the `CSV replay` source type in the sidebar and upload one of those files.
+
+## WebSocket source
+
+TimePlot includes a local demo WebSocket server in [scripts/demo-websocket-server.mjs](scripts/demo-websocket-server.mjs).
+
+Start it with:
+
+```bash
+bun run ws:demo
+```
+
+Then set a signal source to `WebSocket` and use `ws://localhost:8080`.
+
+Optional environment variables:
+
+```bash
+PORT=8090 TIMEPLOT_PROFILE=chirp TIMEPLOT_INTERVAL_MS=50 bun run ws:demo
+```
+
+Supported demo profiles:
+
+- `telemetry`
+- `chirp`
+- `steps`
+- `burst`
+
+Protocol details and accepted message formats are documented in [WEBSOCKET_FORMAT.md](WEBSOCKET_FORMAT.md).
+
+## Persistence
+
+TimePlot persists core workspace settings in `localStorage`, including:
+
+- plot display settings
+- playback speed
+- panel visibility
+- graph routing and transforms
+- source configuration such as presets and WebSocket URLs
+
+CSV replay files themselves are not persisted in storage. After a reload, TimePlot remembers which CSV file was selected but asks you to reload the file data.
+
 ## Project structure
 
 ```text
@@ -46,8 +104,11 @@ src/
 │   └── time-controller.js  # real time + plot time transport
 ├── data/
 │   ├── base-source.js      # source interface
+│   ├── csv-replay-source.js
+│   ├── parse-replay-csv.js
 │   ├── source-registry.js  # source lifecycle + routing
-│   └── synthetic-wave-source.js
+│   ├── synthetic-wave-source.js
+│   └── websocket-source.js
 ├── plot/
 │   ├── plot-buffer.js      # bounded in-memory sample history
 │   └── timeplot-view.js    # Pixi rendering + hover picking
@@ -57,6 +118,12 @@ src/
 ├── main.js                 # compatibility shim to bootstrap
 ├── styles.css              # global UI styling
 └── utils-format.js         # display formatting helpers
+
+public/
+└── demo-data/              # sample CSV replay fixtures
+
+scripts/
+└── demo-websocket-server.mjs
 ```
 
 ## Design direction
@@ -68,10 +135,12 @@ This restart intentionally optimizes for a strong foundation instead of feature
 - the plot owns visualization only
 - DOM panels handle controls and diagnostics
 - app composition happens in one predictable bootstrap path
+- synthetic, file replay, and WebSocket sources share one source abstraction
+- core workspace configuration survives reloads
 
 ## Next good additions
 
-- real external data sources (WebSocket, REST replay, files)
+- richer external data sources (REST replay, binary streams, custom adapters)
 - richer panel layout system with docking/persistence
 - plot annotations and multiple stacked plots
 - configurable schemas for incoming data types
-- 
cgit v1.2.3