Expand description
ImprovWiFi serial provisioning protocol for esp-idf-svc.
This crate implements the Improv WiFi serial provisioning protocol, allowing devices to receive Wi-Fi credentials over a serial (UART) connection from a browser or provisioning tool.
§Architecture
The core protocol logic is transport-agnostic — it operates on any
std::io::Read + Write stream. An optional esp-idf-svc feature flag
provides a UART transport adapter for ESP32.
Re-exports§
pub use packet::ParseError;
Modules§
Structs§
- Device
Info - Static device metadata configured at initialization.
- Improv
Wifi - Main
ImprovWiFiprotocol handler, generic over transport. - Improv
Wifi Builder - Builder for configuring an
ImprovWifihandler. - Wifi
Credentials - Parsed Wi-Fi credentials from a
WIFI_SETTINGScommand. - Wifi
Network - A scanned Wi-Fi network.
Enums§
- Command
- RPC command types from client to device.
- Improv
Error - Protocol error conditions sent to the client.
- Improv
State - Provisioning state machine states.
- Packet
Type - Improv serial packet types on the wire.
Constants§
- DEFAULT_
BAUD_ RATE - Default UART baud rate for Improv serial.
- HEADER
- Packet header bytes: “IMPROV”.
- MAX_
DATA_ LENGTH - Maximum packet data length (1-byte length field).
- PROTOCOL_
VERSION - Improv serial protocol version.