4 releases

0.2.1 Mar 6, 2024
0.2.0 Nov 13, 2023
0.1.1 Oct 3, 2020
0.1.0 Jul 24, 2019

#35 in Hardware support

Download history 1499/week @ 2023-12-06 1238/week @ 2023-12-13 900/week @ 2023-12-20 550/week @ 2023-12-27 1721/week @ 2024-01-03 2287/week @ 2024-01-10 2404/week @ 2024-01-17 1351/week @ 2024-01-24 1027/week @ 2024-01-31 1201/week @ 2024-02-07 1521/week @ 2024-02-14 1719/week @ 2024-02-21 2001/week @ 2024-02-28 2205/week @ 2024-03-06 2496/week @ 2024-03-13 2873/week @ 2024-03-20

9,820 downloads per month
Used in 60 crates (53 directly)

MIT license

37KB
744 lines

usbd-serial

CDC-ACM USB serial port implementation for usb-device.

CDC-ACM is a USB class that's supported out of the box by most operating systems and used for implementing modems and generic serial ports. The SerialPort class implements a stream-like buffered serial port that can be used similarly to a normal UART.

The crate also contains CdcAcmClass which is a lower-level implementation that has less overhead, but requires more care to use correctly.

Example

A full example requires the use of a hardware-driver, but the hardware independent part is as follows:

let mut serial = SerialPort::new(&usb_bus);

let mut usb_dev = UsbDeviceBuilder::new(&usb_bus, UsbVidPid(0x16c0, 0x27dd))
    .product("Serial port")
    .device_class(USB_CLASS_CDC)
    .build();

loop {
    if !usb_dev.poll(&mut [&mut serial]) {
        continue;
    }

    let mut buf = [0u8; 64];

    match serial.read(&mut buf[..]) {
        Ok(count) => {
            // count bytes were read to &buf[..count]
        },
        Err(UsbError::WouldBlock) => // No data received
        Err(err) => // An error occurred
    };

    match serial.write(&[0x3a, 0x29]) {
        Ok(count) => {
            // count bytes were written
        },
        Err(UsbError::WouldBlock) => // No data could be written (buffers full)
        Err(err) => // An error occurred
    };
}

Dependencies

~1.5MB
~29K SLoC