Documentation

Rivr Docs

Everything you need to know to get started, configure, and extend Rivr.

๐Ÿš€Quick Start

No ESP32 required to explore Rivr โ€” the host tools run entirely on Linux, macOS, or Windows. For hardware flashing, use the browser-based flasher or PlatformIO.

1

Try without hardware

Install Rust and run `cargo build -p rivr_host`. Compile .rivr programs and replay captured mesh traffic without any device.

2

Get supported hardware

Primary board: ESP32 DevKit + E22-900M30S (SX1262, +30 dBm). Also supported: LilyGo LoRa32 v2.1. Six variants in total.

3

Connect via USB

Plug your board into your computer with a data USB cable (not charge-only). Use Chrome or Edge 89+ on desktop.

4

Flash firmware

Open /flash in your browser, select your board, click Connect, then Flash Firmware. Or use `pio run -e client_esp32devkit_e22_900 -t upload`.

5

Monitor serial output

Open `pio device monitor` at 115200 baud. Run `rivr> supportpack` to export a @SUPPORTPACK diagnostic block.

โš  Public Beta

Wire protocol and DSL API may change between beta releases. Not yet recommended for unattended production deployments. Always attach a @SUPPORTPACK capture when filing a bug report.