embassy-net-esp-hosted

Crates

git

Versions

default

Flavors

Skip to main content

Control

Struct Control 

Source
pub struct Control<'a> { /* private fields */ }
Expand description

Handle for managing the network and WiFI state.

Implementations§

Source§

impl<'a> Control<'a>

Source

pub async fn init(&mut self) -> Result<(), Error>

Initialize device.

Source

pub fn hardware_address(&self) -> HardwareAddress

Get hardware address

Use after init method successful execution

This method may be used to update interface hardware address if you have initialized network stack before this device

use embassy_net::wire::HardwareAddress;
iface.set_hardware_addr(HardwareAddress::from_driver(ctl.hardware_address()).unwrap());
Source

pub fn reset(&self)

Reset ESP and initialzation state

init should be executed again after reset

Source

pub async fn get_status(&mut self) -> Result<Status, Error>

Get the current status.

Source

pub async fn scan<const N: usize>( &mut self, result: &mut Vec<Network, N>, ) -> Result<(), Error>

Scan for available networks.

Source

pub async fn connect(&mut self, ssid: &str, password: &str) -> Result<(), Error>

Connect to the network identified by ssid using the provided password.

Source

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

Disconnect from any currently connected network.

Source

pub async fn get_fw_version(&mut self) -> Result<FwVersion, Error>

Return the firmware version of the device.

Source

pub async fn ota_begin(&mut self) -> Result<(), Error>

Initiate a firmware update.

Source

pub async fn ota_write(&mut self, data: &[u8]) -> Result<(), Error>

Write slice of firmware to a device.

ota_begin must be called first.

The slice is split into chunks that can be sent across the ioctl protocol to the wifi adapter.

Source

pub async fn ota_end(&mut self) -> Result<(), Error>

End the OTA session.

ota_begin must be called first.

NOTE: Will reset the wifi adapter after 5 seconds.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Control<'a>

§

impl<'a> !Send for Control<'a>

§

impl<'a> !Sync for Control<'a>

§

impl<'a> !UnwindSafe for Control<'a>

§

impl<'a> Freeze for Control<'a>

§

impl<'a> Unpin for Control<'a>

§

impl<'a> UnsafeUnpin for Control<'a>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = !

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

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

Performs the conversion.
Source§

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

Source§

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

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

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

Performs the conversion.