zephyr/samples/subsys/usb/console
Benjamin Cabé e04cdb0d2f doc: usb: samples: improve commands formatting
use code literal formatting for commands in RST file

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
..
src usb: device_next: Rename usbd_contex to usbd_context 2024-06-03 06:43:20 -07:00
app.overlay samples: subsys: Remove label property from devicetree overlays 2022-07-19 10:30:20 +02:00
CMakeLists.txt samples: usb: use common sample USBD initialization 2023-12-13 17:52:00 +01:00
Kconfig samples: usb: use common sample USBD initialization 2023-12-13 17:52:00 +01:00
prj.conf samples: Explicitly disable boot USB device support init at boot 2023-01-10 12:21:10 +01:00
README.rst doc: usb: samples: improve commands formatting 2024-06-20 14:07:32 -04:00
sample.yaml boards: remove test feature usb_cdc 2024-05-29 07:32:41 +02:00
usbd_next_prj.conf samples: usb: use common sample USBD initialization 2023-12-13 17:52:00 +01:00

.. zephyr:code-sample:: usb-cdc-acm-console
   :name: Console over USB CDC ACM
   :relevant-api: _usb_device_core_api usbd_api uart_interface

   Output "Hello World!" to the console over USB CDC ACM.

Overview
********

A simple Hello World sample, with console output coming via CDC ACM UART.
Primarily intended to show the required config options.

Requirements
************

This project requires a USB device controller driver.

Building and Running
********************

This sample can be built for multiple boards, in this example we will build it
for the reel_board board:

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/usb/console
   :board: reel_board
   :goals: flash
   :compact:

Plug the board into a host device, for sample, a PC running Linux OS.
The board will be detected as a CDC_ACM serial device. To see the console output
from the sample, use a command similar to :command:`minicom -D /dev/ttyACM0`.

.. code-block:: console

   Hello World! arm
   Hello World! arm
   Hello World! arm
   Hello World! arm

Troubleshooting
===============

You may need to stop :program:`modemmanager` via :command:`sudo stop modemmanager`, if it is
trying to access the device in the background.