csi-webserver

Default host-side CSI server executable. Discovers ESP32 boards over USB, bridges esp-csi-cli-rs firmware to HTTP/WebSocket clients, and optionally writes Parquet session dumps.

Built on the csi-webserver-core library.

Documentation

Document	Contents
CRATES.md	crates.io package summary
API.md	Full HTTP/WebSocket API reference
MIGRATION.md	Upgrade notes from older layouts
Library README	Embedding the server in your own app

Prerequisites

Flash the ESP32 with esp-csi-cli-rs before starting the server.

Supported chips: ESP32, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-S3.

Install

cargo install csi-webserver
csi-webserver --help

Run from source

From the workspace root:

cargo run -p csi-webserver
cargo run -p csi-webserver -- --interface 127.0.0.1 --port 3000 --baud-rate 921600
cargo run -p csi-webserver -- --device lab1=/dev/ttyUSB0 --scan-interval-ms 1000

Quick start

csi-webserver

curl -sS "http://127.0.0.1:3000/api/devices"
curl -sS "http://127.0.0.1:3000/api/devices/<id>/info"
curl -sS -X POST "http://127.0.0.1:3000/api/devices/<id>/control/start"

WebSocket: ws://127.0.0.1:3000/api/devices/<id>/ws

See API.md for every endpoint, payload, and status code.

CLI options

csi-webserver [OPTIONS]

      --interface <INTERFACE>       Bind address [default: 0.0.0.0]
      --port <PORT>                 TCP port [default: 3000]
      --baud-rate <BAUD_RATE>       UART baud [env: CSI_BAUD_RATE] [default: 115200]
      --device <ALIAS=PORT_OR_MAC>  Stable device id override (repeatable)
      --scan-interval-ms <MS>       Hotplug rescan interval [default: 2000]

Output modes

Mode	WebSocket	Parquet dump
stream (default)	yes	no
dump	no	yes
both	yes	yes

Set via POST /api/devices/{id}/config/output-mode — see API.md.

Environment variables

Variable	Default	Description
CSI_SERIAL_PORT	auto-detect	Pin one serial port
CSI_BAUD_RATE	115200	Serial baud rate
RUST_LOG	csi_webserver_core=debug	Tracing filter

License

Apache-2.0. See LICENSE.