3 unstable releases

0.2.0 Nov 13, 2023
0.1.1 Oct 3, 2020
0.1.0 Jul 24, 2019

#39 in Hardware support

Download history 1441/week @ 2023-11-04 2130/week @ 2023-11-11 2154/week @ 2023-11-18 2303/week @ 2023-11-25 1755/week @ 2023-12-02 1452/week @ 2023-12-09 1161/week @ 2023-12-16 803/week @ 2023-12-23 1180/week @ 2023-12-30 2333/week @ 2024-01-06 1666/week @ 2024-01-13 2658/week @ 2024-01-20 1317/week @ 2024-01-27 961/week @ 2024-02-03 1442/week @ 2024-02-10 1666/week @ 2024-02-17

5,554 downloads per month
Used in 60 crates (53 directly)

MIT license

34KB
666 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

~2.5MB
~49K SLoC