Struct esp_wifi::esp_now::EspNowManager

source · 
pub struct EspNowManager<'d> { /* private fields */ }
Expand description

Manages the EspNow instance lifecycle while ensuring it remains active.

Implementations§

source§

impl EspNowManager<'_>

source

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

Set the wifi protocol.

This will set the wifi protocol to the desired protocol

§Arguments:
  • protocols - The desired protocols
source

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

Configures modem power saving

source

pub fn set_channel(&self, channel: u8) -> Result<(), EspNowError>

Set primary WiFi channel. Should only be used when using ESP-NOW without AP or STA.

source

pub fn version(&self) -> Result<u32, EspNowError>

Get the version of ESP-NOW.

source

pub fn add_peer(&self, peer: PeerInfo) -> Result<(), EspNowError>

Add a peer to the list of known peers.

source

pub fn remove_peer(&self, peer_address: &[u8; 6]) -> Result<(), EspNowError>

Remove the given peer.

source

pub fn modify_peer(&self, peer: PeerInfo) -> Result<(), EspNowError>

Modify a peer information.

source

pub fn peer(&self, peer_address: &[u8; 6]) -> Result<PeerInfo, EspNowError>

Get peer by MAC address.

source

pub fn fetch_peer(&self, from_head: bool) -> Result<PeerInfo, EspNowError>

Fetch a peer from peer list.

Only returns peers which address is unicast, for multicast/broadcast addresses, the function will skip the entry and find the next in the peer list.

source

pub fn peer_exists(&self, peer_address: &[u8; 6]) -> bool

Check is peer is known.

source

pub fn peer_count(&self) -> Result<PeerCount, EspNowError>

Get the number of peers.

source

pub fn set_pmk(&self, pmk: &[u8; 16]) -> Result<(), EspNowError>

Set the primary master key.

source

pub fn set_wake_window(&self, wake_window: u16) -> Result<(), EspNowError>

Set wake window for esp_now to wake up in interval unit.

Window is milliseconds the chip keep waked each interval, from 0 to 65535.

source

pub fn set_rate(&self, rate: WifiPhyRate) -> Result<(), EspNowError>

Configure ESP-NOW rate.

Trait Implementations§

source§

impl Drop for EspNowManager<'_>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'d> Freeze for EspNowManager<'d>

§

impl<'d> RefUnwindSafe for EspNowManager<'d>

§

impl<'d> Send for EspNowManager<'d>

§

impl<'d> Sync for EspNowManager<'d>

§

impl<'d> Unpin for EspNowManager<'d>

§

impl<'d> UnwindSafe for EspNowManager<'d>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.