Skip to main content

Crate esp_idf_improv_wifi

Crate esp_idf_improv_wifi 

Source
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§

packet

Structs§

DeviceInfo
Static device metadata configured at initialization.
ImprovWifi
Main ImprovWiFi protocol handler, generic over transport.
ImprovWifiBuilder
Builder for configuring an ImprovWifi handler.
WifiCredentials
Parsed Wi-Fi credentials from a WIFI_SETTINGS command.
WifiNetwork
A scanned Wi-Fi network.

Enums§

Command
RPC command types from client to device.
ImprovError
Protocol error conditions sent to the client.
ImprovState
Provisioning state machine states.
PacketType
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.