README.rst
1.. zephyr:code-sample:: usb-cdc-acm-console
2 :name: Console over USB CDC ACM
3 :relevant-api: _usb_device_core_api usbd_api
4
5 Output "Hello World!" to the console over USB CDC ACM.
6
7Overview
8********
9
10A simple Hello World sample, with console output coming via CDC ACM UART.
11Primarily intended to show the required config options.
12
13Requirements
14************
15
16This project requires a USB device controller driver.
17
18Building and Running
19********************
20
21This sample can be built for multiple boards, in this example we will build it
22for the reel_board board:
23
24.. zephyr-app-commands::
25 :zephyr-app: samples/subsys/usb/console
26 :board: reel_board
27 :goals: flash
28 :compact:
29
30Plug the board into a host device, for sample, a PC running Linux OS.
31The board will be detected as a CDC_ACM serial device. To see the console output
32from the sample, use a command similar to :command:`minicom -D /dev/ttyACM0`.
33
34.. code-block:: console
35
36 Hello World! arm
37 Hello World! arm
38 Hello World! arm
39 Hello World! arm
40
41Troubleshooting
42===============
43
44You may need to stop :program:`modemmanager` via :command:`sudo stop modemmanager`, if it is
45trying to access the device in the background.
46
