#no-std #usb-device

no-std usbd-serial

USB CDC-ACM serial port class for use with usb-device

2 releases

0.1.1 Oct 3, 2020
0.1.0 Jul 24, 2019

#84 in Encoding

Download history 93/week @ 2020-07-04 167/week @ 2020-07-11 707/week @ 2020-07-18 705/week @ 2020-07-25 546/week @ 2020-08-01 528/week @ 2020-08-08 492/week @ 2020-08-15 409/week @ 2020-08-22 1142/week @ 2020-08-29 738/week @ 2020-09-05 606/week @ 2020-09-12 1051/week @ 2020-09-19 1093/week @ 2020-09-26 825/week @ 2020-10-03 1051/week @ 2020-10-10 1615/week @ 2020-10-17

2,764 downloads per month
Used in less than 22 crates

MIT license

29KB
558 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

~175KB