Struct UsbSerialDriver

pub struct UsbSerialDriver<'d>(/* private fields */);

USB-SERIAL driver

Implementations

impl<'d> UsbSerialDriver<'d>

pub fn new( usb_serial: impl Peripheral<P = USB_SERIAL> + 'd, _usb_d_min: impl Peripheral<P = UsbDMinGpio>, _usb_d_plus: impl Peripheral<P = UsbDPlusGpio>, config: &Config, ) -> Result<Self, EspError>

Create a new USB Serial driver

Arguments

• usb_serial: The USB Serial peripheral
• config: The driver configuration
• usb_d_min: The USB D- GPIO pin
• usb_d_plus: The USB D+ GPIO pin

pub fn is_connected(&self) -> bool

Check if the USB Serial is connected

pub fn read( &mut self, buf: &mut [u8], timeout: TickType_t, ) -> Result<usize, EspError>

Read bytes into a slice

Arguments

• buf: The buffer to read into
• timeout: The timeout in ticks

Returns

The number of bytes read or an error if the operation failed or the timeout was reached

pub fn write( &mut self, bytes: &[u8], timeout: TickType_t, ) -> Result<usize, EspError>

Write bytes from a slice

Arguments

• bytes: The bytes to write
• timeout: The timeout in ticks

Returns

The number of bytes written or an error if the operation failed or the timeout was reached

Trait Implementations

impl Drop for UsbSerialDriver<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl ErrorType for UsbSerialDriver<'_>

type Error = EspIOError

Error type of all the IO operations on this type.

impl Read for UsbSerialDriver<'_>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_exact( &mut self, buf: &mut [u8], ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl Write for UsbSerialDriver<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written.

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

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl Write for UsbSerialDriver<'_>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a [char] into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the [write!] macro with implementors of this trait.

impl Write<u8> for UsbSerialDriver<'_>

type Error = EspError

Write error

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

Ensures that none of the previously written words are still buffered

fn write(&mut self, byte: u8) -> Result<(), Self::Error>

Writes a single word to the serial interface

impl Send for UsbSerialDriver<'_>