Struct esp8266_at_driver::Esp8266Driver

source ·

pub struct Esp8266Driver<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize>where
    T: Read + Write,
    ENABLE: OutputPin,
    RESET: OutputPin,{ /* private fields */ }

Expand description

Instance of the Esp8266 driver.

Configure MAX_SOCKETS to the max number of connections you expect to be making at the same time.

Implementations

source

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
 T: Read + Write,
 ENABLE: OutputPin,
 RESET: OutputPin,

source

pub fn new(transport: T, enable: ENABLE, reset: RESET) -> Self

Create a new instance of the Esp8266 driver using the provided transport. The transport is usually the UART peripheral when used on a microcontroller.

The ENABLE pin is used to enable the adapter. The RESET pin is used to reset the adapter.

source

pub async fn run(&'a self, ssid: &'a str, psk: &'a str) -> Result<(), DriverError>

Run the driver task using the specified WiFi AP settings.

The adapter will be initialized/reset, and the driver will attempt to join the network.

Trait Implementations

source

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> TcpConnect for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
 T: Read + Write,
 ENABLE: OutputPin,
 RESET: OutputPin,

type Error = DriverError

Error type returned on connect failure.

type Connection<'m>
where
Self: 'm = Esp8266Socket<'m, T>

Type holding state of a TCP connection. Should close the connection when dropped.

type ConnectFuture<'m>
where
Self: 'm = impl Future<Output = Result<<Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Connection<'m>, <Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Error>> + 'm

Future returned by connect function.

source

fn connect<'m>(&'m self, remote: SocketAddr) -> Self::ConnectFuture<'m>

Connect to the given remote host and port. Read more

Auto Trait Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !RefUnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Send for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Sync for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Unpin for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
 ENABLE: Unpin,
 RESET: Unpin,
 T: Unpin,

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> UnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
 ENABLE: UnwindSafe,
 RESET: UnwindSafe,
 T: UnwindSafe + RefUnwindSafe,

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct esp8266_at_driver::Esp8266Driver

Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
    T: Read + Write,
    ENABLE: OutputPin,
    RESET: OutputPin,

pub fn new(transport: T, enable: ENABLE, reset: RESET) -> Self

pub async fn run(&'a self, ssid: &'a str, psk: &'a str) -> Result<(), DriverError>

Trait Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> TcpConnect for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
    T: Read + Write,
    ENABLE: OutputPin,
    RESET: OutputPin,

type Error = DriverError

type Connection<'m>
where
Self: 'm = Esp8266Socket<'m, T>

type ConnectFuture<'m>
where
Self: 'm = impl Future<Output = Result<<Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Connection<'m>, <Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Error>> + 'm

fn connect<'m>(&'m self, remote: SocketAddr) -> Self::ConnectFuture<'m>

Auto Trait Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !RefUnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Send for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Sync for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Unpin for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
    ENABLE: Unpin,
    RESET: Unpin,
    T: Unpin,

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> UnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
    ENABLE: UnwindSafe,
    RESET: UnwindSafe,
    T: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct esp8266_at_driver::Esp8266Driver

Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where T: Read + Write, ENABLE: OutputPin, RESET: OutputPin,

pub fn new(transport: T, enable: ENABLE, reset: RESET) -> Self

pub async fn run(&'a self, ssid: &'a str, psk: &'a str) -> Result<(), DriverError>

Trait Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> TcpConnect for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where T: Read + Write, ENABLE: OutputPin, RESET: OutputPin,

type Error = DriverError

type Connection<'m>where Self: 'm = Esp8266Socket<'m, T>

type ConnectFuture<'m>where Self: 'm = impl Future<Output = Result<<Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Connection<'m>, <Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Error>> + 'm

fn connect<'m>(&'m self, remote: SocketAddr) -> Self::ConnectFuture<'m>

Auto Trait Implementations

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !RefUnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Send for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> !Sync for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Unpin for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where ENABLE: Unpin, RESET: Unpin, T: Unpin,

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> UnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where ENABLE: UnwindSafe, RESET: UnwindSafe, T: UnwindSafe + RefUnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
T: Read + Write,
ENABLE: OutputPin,
RESET: OutputPin,

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> TcpConnect for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
T: Read + Write,
ENABLE: OutputPin,
RESET: OutputPin,

type Connection<'m>
where
Self: 'm = Esp8266Socket<'m, T>

type ConnectFuture<'m>
where
Self: 'm = impl Future<Output = Result<<Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Connection<'m>, <Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS> as TcpConnect>::Error>> + 'm

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> Unpin for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
ENABLE: Unpin,
RESET: Unpin,
T: Unpin,

impl<'a, T, ENABLE, RESET, const MAX_SOCKETS: usize> UnwindSafe for Esp8266Driver<'a, T, ENABLE, RESET, MAX_SOCKETS>where
ENABLE: UnwindSafe,
RESET: UnwindSafe,
T: UnwindSafe + RefUnwindSafe,

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

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

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

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

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

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