Skip to content

Commit f7d043d

Browse files
Reuvenruvnet
andcommitted
docs: fix Docker commands to use CSI_SOURCE environment variable
The Docker image uses CSI_SOURCE env var to select the data source, not command-line arguments appended after the image name. Fixed: - ESP32 mode examples now use -e CSI_SOURCE=esp32 - Training mode example now uses --entrypoint override - Added CSI_SOURCE value table in Docker section Fixes #226 Co-Authored-By: claude-flow <ruv@ruv.net>
1 parent ff91d4e commit f7d043d

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/user-guide.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,17 @@ docker pull ruvnet/wifi-densepose:latest
7878

7979
Multi-architecture image (amd64 + arm64). Works on Intel/AMD and Apple Silicon Macs. Contains the Rust sensing server, Three.js UI, and all signal processing.
8080

81+
**Data source selection:** Use the `CSI_SOURCE` environment variable to select the sensing mode:
82+
83+
| Value | Description |
84+
|-------|-------------|
85+
| `auto` | (default) Probe for ESP32 on UDP 5005, fall back to simulation |
86+
| `esp32` | Receive real CSI frames from ESP32 devices over UDP |
87+
| `simulated` | Generate synthetic CSI frames (no hardware required) |
88+
| `wifi` | Host Wi-Fi RSSI (not available inside containers) |
89+
90+
Example: `docker run -e CSI_SOURCE=esp32 -p 3000:3000 -p 5005:5005/udp ruvnet/wifi-densepose:latest`
91+
8192
### From Source (Rust)
8293

8394
```bash
@@ -267,8 +278,8 @@ Real Channel State Information at 20 Hz with 56-192 subcarriers. Required for po
267278
# From source
268279
./target/release/sensing-server --source esp32 --udp-port 5005 --http-port 3000 --ws-port 3001
269280

270-
# Docker
271-
docker run -p 3000:3000 -p 3001:3001 -p 5005:5005/udp ruvnet/wifi-densepose:latest --source esp32
281+
# Docker (use CSI_SOURCE environment variable)
282+
docker run -p 3000:3000 -p 3001:3001 -p 5005:5005/udp -e CSI_SOURCE=esp32 ruvnet/wifi-densepose:latest
272283
```
273284

274285
The ESP32 nodes stream binary CSI frames over UDP to port 5005. See [Hardware Setup](#esp32-s3-mesh) for flashing instructions.
@@ -679,9 +690,11 @@ Download the dataset files and place them in a `data/` directory.
679690
./target/release/sensing-server --train --dataset data/ --dataset-type mmfi --epochs 100 --save-rvf model.rvf
680691
681692
# Via Docker (mount your data directory)
693+
# Note: Training mode requires overriding the default entrypoint
682694
docker run --rm \
683695
-v $(pwd)/data:/data \
684696
-v $(pwd)/output:/output \
697+
--entrypoint /app/sensing-server \
685698
ruvnet/wifi-densepose:latest \
686699
--train --dataset /data --epochs 100 --export-rvf /output/model.rvf
687700
```
@@ -885,8 +898,8 @@ Binary size: 777 KB (24% free in the 1 MB app partition).
885898
# From source
886899
./target/release/sensing-server --source esp32 --udp-port 5005 --http-port 3000 --ws-port 3001
887900
888-
# Docker
889-
docker run -p 3000:3000 -p 3001:3001 -p 5005:5005/udp ruvnet/wifi-densepose:latest --source esp32
901+
# Docker (use CSI_SOURCE environment variable)
902+
docker run -p 3000:3000 -p 3001:3001 -p 5005:5005/udp -e CSI_SOURCE=esp32 ruvnet/wifi-densepose:latest
890903
```
891904
892905
See [ADR-018](../docs/adr/ADR-018-esp32-dev-implementation.md), [ADR-029](../docs/adr/ADR-029-ruvsense-multistatic-sensing-mode.md), and [Tutorial #34](https://github.com/ruvnet/RuView/issues/34).

0 commit comments

Comments
 (0)