Struct Interface 

pub struct Interface { /* private fields */ }

Available on crate feature wifi only.

Wi-Fi interface.

This implements the embassy-net-driver trait for up to three latest versions of that crate. While that crate isn’t stable we make an exception here from the API Guidelines in exposing unstable dependencies.

Each interface mode (station, access point) is a singleton — only one instance of each can exist at a time. Create interfaces via Interface::station() or Interface::access_point() before or after calling WifiController::new(). Dropping the interface releases the singleton so it can be created again.

Implementations

impl Interface

pub fn station() -> Self

Creates the station-mode interface.

Panics

Panics if a station interface already exists. Use try_station() for a non-panicking alternative.

pub fn try_station() -> Option<Self>

Tries to create the station-mode interface.

Returns None if a station interface already exists.

pub fn access_point() -> Self

Creates the access-point-mode interface.

Panics

Panics if an access-point interface already exists. Use try_access_point() for a non-panicking alternative.

pub fn try_access_point() -> Option<Self>

Tries to create the access-point-mode interface.

Returns None if an access-point interface already exists.

pub fn mac_address(&self) -> [u8; 6]

Retrieves the MAC address of the Wi-Fi device.

Example

let _controller = esp_radio::wifi::WifiController::new(peripherals.WIFI, Default::default())?;

let station = esp_radio::wifi::Interface::station();
let mac = station.mac_address();

println!("Station MAC: {:02x?}", mac);

Trait Implementations

impl Debug for Interface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Driver for Interface

type RxToken<'a> = WifiRxToken where Self: 'a

A token to receive a single network packet.

type TxToken<'a> = WifiTxToken where Self: 'a

A token to transmit a single network packet.

fn receive( &mut self, cx: &mut Context<'_>, ) -> Option<(Self::RxToken<'_>, Self::TxToken<'_>)>

Construct a token pair consisting of one receive token and one transmit token.

fn transmit(&mut self, cx: &mut Context<'_>) -> Option<Self::TxToken<'_>>

Construct a transmit token.

fn link_state(&mut self, cx: &mut Context<'_>) -> LinkState

Get the link state.

fn capabilities(&self) -> Capabilities

Get a description of device capabilities.

fn hardware_address(&self) -> HardwareAddress

Get the device’s hardware address.

impl Drop for Interface

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Interface

impl Format for Interface

where InterfaceType: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Hash for Interface

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given [Hasher].

impl PartialEq for Interface

fn eq(&self, other: &Interface) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Interface