Struct esp_idf_svc::wifi::BlockingWifi

pub struct BlockingWifi<T> { /* private fields */ }

Wraps a WifiDriver or EspWifi, and offers strictly synchronous (blocking) function calls for their functionality.

Implementations

impl<T> BlockingWifi<T>

where T: Wifi<Error = EspError> + NonBlocking,

pub fn wrap(wifi: T, event_loop: EspSystemEventLoop) -> Result<Self, EspError>

pub fn wifi(&self) -> &T

Returns the underlying WifiDriver or EspWifi

pub fn wifi_mut(&mut self) -> &mut T

Returns the underlying WifiDriver or EspWifi, as mutable

pub fn get_capabilities(&self) -> Result<EnumSet<Capability>, EspError>

As per WifiDriver::get_capabilities()

pub fn get_configuration(&self) -> Result<Configuration, EspError>

As per WifiDriver::get_configuration()

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

As per WifiDriver::set_configuration()

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

As per WifiDriver::is_started()

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

As per WifiDriver::is_connected()

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

As per WifiDriver::start(), but as a blocking call that returns once the wifi driver has started.

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

As per WifiDriver::stop(), but as a blocking call that returns once the wifi driver has stopped.

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

As per WifiDriver::connect(), but as a blocking call that returns once the wifi driver is connected.

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

As per WifiDriver::disconnect(), but as a blocking call that returns once the wifi driver has disconnected.

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

As per WifiDriver::scan_n()

pub fn scan(&mut self) -> Result<Vec<AccessPointInfo>, EspError>

As per WifiDriver::scan()

pub fn wifi_wait_while<F: Fn() -> Result<bool, EspError>>( &self, matcher: F, timeout: Option<Duration>, ) -> Result<(), EspError>

Performs a blocking wait until certain condition provided by the user in the form of a matcher callback becomes false. Most often than not that condition would be related to the state of the Wifi driver. In other words, whether the driver is started, stopped, (dis)connected and so on.

Note that the waiting is not done internally using busy-looping and/or timeouts. Rather, the condition (matcher) is evaluated initially, and if it returns true, it is re-evaluated each time the ESP IDF C Wifi driver posts a Wifi event on the system event loop. The reasoning behind this is that changes to the state of the Wifi driver are always accompanied by posting Wifi events.

pub fn start_wps( &mut self, config: &WpsConfig<'_>, ) -> Result<WpsStatus, EspError>

Start WPS and perform a blocking wait until it connects, fails or times out. A WpsStatus is returned that contains the success status of the WPS connection. When the credentials of only one access point are received, the WiFi driver configuration will automatically be set to that access point. If multiple credentials were received, a WpsStatus::Success will be returned with a vector containing those credentials. The caller must then handle those credentials and set the configuration manually.

impl<T> BlockingWifi<T>

where T: NetifStatus,

pub fn is_up(&self) -> Result<bool, EspError>

As per EspWifi::is_up().

pub fn wait_netif_up(&self) -> Result<(), EspError>

Waits until the underlaying network interface is up.

pub fn ip_wait_while<F: Fn() -> Result<bool, EspError>>( &self, matcher: F, timeout: Option<Duration>, ) -> Result<(), EspError>

As BlockingWifi::wifi_wait_while(), but for EspWifi events related to the IP layer, instead of WifiDriver events on the data link layer.

Trait Implementations

impl<T> NetifStatus for BlockingWifi<T>

where T: NetifStatus,

fn is_up(&self) -> Result<bool, EspError>

impl<T> Wifi for BlockingWifi<T>

where T: Wifi<Error = EspError> + NonBlocking,

type Error = EspError

fn get_capabilities(&self) -> Result<EnumSet<Capability>, Self::Error>

fn get_configuration(&self) -> Result<Configuration, Self::Error>

fn set_configuration(&mut self, conf: &Configuration) -> Result<(), Self::Error>

fn is_started(&self) -> Result<bool, Self::Error>

fn is_connected(&self) -> Result<bool, Self::Error>

fn start(&mut self) -> Result<(), Self::Error>

fn stop(&mut self) -> Result<(), Self::Error>

fn connect(&mut self) -> Result<(), Self::Error>

fn disconnect(&mut self) -> Result<(), Self::Error>

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

fn scan(&mut self) -> Result<Vec<AccessPointInfo>, Self::Error>