README.rst
1.. zephyr:code-sample:: usb-cdc-acm-bridge
2 :name: USB CDC-ACM bridge
3 :relevant-api: uart_interface
4
5 Use USB CDC-ACM driver to implement a serial port bridge.
6
7Overview
8********
9
10This sample app demonstrates use of a USB CDC-ACM to bridge a standard hardware
11UART on a supported board.
12
13Requirements
14************
15
16This project requires an USB device driver, which is available for multiple
17boards supported in Zephyr.
18
19The board has to have an USB interface as well as hardware UART, the device
20node for the hardware UART is board specific so each supported board needs an
21explicit overlay.
22
23Building and Running
24********************
25
26Reel Board
27===========
28
29To see the console output of the app, open a serial port emulator and
30attach it to the USB to TTL Serial cable. Build and flash the project:
31
32.. zephyr-app-commands::
33 :zephyr-app: samples/subsys/usb/cdc_acm_bridge
34 :board: reel_board
35 :goals: flash
36 :compact:
37
38Running
39=======
40
41Plug the board into a host device, for example, a PC running Linux, the board
42should enumerate as a CDC-ACM device, the CDC-ACM input and output should be
43echoed back to the real UART, and configuration changes to the CDC-ACM uart
44such as bitrate will be propagated to the hardware port.
45
46If the hardware port is connected to an on-board debugger then the output
47should be echoed between the two ports, if it's connected to some pins on the
48boards the pins can be shorted together to test that the driver is working
49correctly.
50
