Struct esp_wifi::wifi::WifiController

pub struct WifiController<'d> { /* private fields */ }

A wifi controller

Implementations

impl WifiController<'_>

pub async fn scan_n_async<const N: usize>( &mut self, ) -> Result<(Vec<AccessPointInfo, N>, usize), WifiError>

Async version of crate::wifi::WifiController’s scan_n method

pub async fn scan_with_config_async<const N: usize>( &mut self, config: ScanConfig<'_>, ) -> Result<(Vec<AccessPointInfo, N>, usize), WifiError>

An async wifi network scan with caller-provided scanning options.

pub async fn start_async(&mut self) -> Result<(), WifiError>

Async version of crate::wifi::WifiController’s start method

pub async fn stop_async(&mut self) -> Result<(), WifiError>

Async version of crate::wifi::WifiController’s stop method

pub async fn connect_async(&mut self) -> Result<(), WifiError>

Async version of crate::wifi::WifiController’s connect method

pub async fn disconnect_async(&mut self) -> Result<(), WifiError>

Async version of crate::wifi::WifiController’s Disconnect method

pub async fn wait_for_event(&mut self, event: WifiEvent)

Wait for one WifiEvent.

pub async fn wait_for_events( &mut self, events: EnumSet<WifiEvent>, clear_pending: bool, ) -> EnumSet<WifiEvent>

Wait for one of multiple WifiEvents. Returns the events that occurred while waiting.

pub async fn wait_for_all_events( &mut self, events: EnumSet<WifiEvent>, clear_pending: bool, )

Wait for multiple WifiEvents.

impl<'d> WifiController<'d>

pub fn take_sniffer(&self) -> Option<Sniffer>

Attempts to take the sniffer, returns Some(Sniffer) if successful, otherwise None.

pub fn set_protocol( &mut self, protocols: EnumSet<Protocol>, ) -> Result<(), WifiError>

Set the wifi protocol.

This will set the wifi protocol to the desired protocol, the default for this is: WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N

Arguments:

• protocols - The desired protocols

Example:

wifi_controller.set_protocol(Protocol::P802D11BGNLR.into());

pub fn set_power_saving(&mut self, ps: PowerSaveMode) -> Result<(), WifiError>

Configures modem power saving

pub fn is_sta_enabled(&self) -> Result<bool, WifiError>

Checks if Wi-Fi is enabled as a station.

pub fn is_ap_enabled(&self) -> Result<bool, WifiError>

Checks if Wi-Fi is enabled as an access p.

pub fn scan_with_config_sync<const N: usize>( &mut self, config: ScanConfig<'_>, ) -> Result<(Vec<AccessPointInfo, N>, usize), WifiError>

A blocking wifi network scan with caller-provided scanning options.

pub fn scan_n<const N: usize>( &mut self, ) -> Result<(Vec<AccessPointInfo, N>, usize), WifiError>

A blocking wifi network scan with default scanning options.

pub fn start(&mut self) -> Result<(), WifiError>

Starts the WiFi controller.

pub fn stop(&mut self) -> Result<(), WifiError>

Stops the WiFi controller.

pub fn connect(&mut self) -> Result<(), WifiError>

Connects the WiFi controller to a network.

pub fn disconnect(&mut self) -> Result<(), WifiError>

Disconnects the WiFi controller from a network.

impl WifiController<'_>

pub fn capabilities(&self) -> Result<EnumSet<Capability>, WifiError>

Get the supported capabilities of the controller.

pub fn configuration(&self) -> Result<Configuration, WifiError>

Get the currently used configuration.

pub fn set_configuration( &mut self, conf: &Configuration, ) -> Result<(), WifiError>

Set the configuration, you need to use Wifi::connect() for connecting to an AP.

This will replace any previously set configuration

pub fn is_started(&self) -> Result<bool, WifiError>

Checks if the WiFi controller has started.

This function should be called after the start method to verify if the WiFi has started successfully.

pub fn is_connected(&self) -> Result<bool, WifiError>

Checks if the WiFi controller is connected to a configured network.

This function should be called after the connect method to verify if the connection was successful.

Trait Implementations

impl Drop for WifiController<'_>

fn drop(&mut self)

Executes the destructor for this type.