zephyr

History

Johann Fischer 5914131852 samples: usb: clean up legacy USB CDC ACM console sample Remove the configuration for the new USB device stack, as there is now a separate sample that demonstrates how to use it with Kconfig option CONFIG_CDC_ACM_SERIAL_INITIALIZE_AT_BOOT. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>		2025-02-12 02:22:18 +01:00
..
src	samples: usb: clean up legacy USB CDC ACM console sample	2025-02-12 02:22:18 +01:00
app.overlay
CMakeLists.txt
prj.conf
README.rst	samples: usb: fix API references	2024-07-10 14:36:46 +02:00
sample.yaml	boards: remove test feature usb_cdc	2024-05-29 07:32:41 +02:00

README.rst

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

   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.