csi-webserver

csi-webserver is a host-side HTTP and WebSocket server for ESP32 CSI collection. It reads CSI frames from an ESP32 over USB serial and forwards them to:

• WebSocket clients (/api/ws)
• Session dump files (csi_dump_YYYYMMDD_HHmmss.bin)
• Or both at the same time

This crate is intended to be run as an executable service.

Install

cargo install csi-webserver

Run

csi-webserver --interface 0.0.0.0 --port 3000

CLI options

csi-webserver [OPTIONS]

Options:
      --interface <INTERFACE>  Network interface to bind to [default: 0.0.0.0]
      --port <PORT>            TCP port to listen on [default: 3000]
      --baud-rate <BAUD_RATE>  UART baud rate to the ESP32 [env: CSI_BAUD_RATE]
                               [default: 115200]
  -h, --help                   Print help
  -V, --version                Print version

Firmware requirement

Flash the ESP32 with esp-csi-cli-rs first:

• https://github.com/csi-rs/esp-csi-cli-rs

Supported board families:

• ESP32
• ESP32-C3
• ESP32-C5
• ESP32-C6
• ESP32-S3

Quick start

# 1) Start the server
csi-webserver

# 2) Verify the device is running esp-csi-cli-rs
curl -sS "http://127.0.0.1:3000/api/info"

# 3) Set log mode
curl -sS -X POST "http://127.0.0.1:3000/api/config/log-mode" \
  -H "Content-Type: application/json" \
  -d '{"mode":"array-list"}'

# 4) Start an indefinite collection session
curl -sS -X POST "http://127.0.0.1:3000/api/control/start"

# 5) Read runtime status
curl -sS "http://127.0.0.1:3000/api/control/status"

# 6) Stop the collection
curl -sS -X POST "http://127.0.0.1:3000/api/control/stop"

Pass {"duration": <secs>} to /api/control/start for a timed run.

Output modes

Switch at runtime with POST /api/config/output-mode.

Environment variables

Full references

• HTTP API reference: https://github.com/csi-rs/csi-webserver-rs/blob/main/API.md
• Repository README: https://github.com/csi-rs/csi-webserver-rs/blob/main/README.md
• Generated Rust docs: https://docs.rs/csi-webserver

License

Apache-2.0.