zephyr

History

Johann Fischer 77e0a9ef20 samples: usb: add message callback registration to the common code This allows samples to receive earlier notification immediately after initialization. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>		2024-03-22 10:10:42 +01:00
..
src	samples: usb: add message callback registration to the common code	2024-03-22 10:10:42 +01:00
app.overlay
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
README.rst	doc: Migrate subsys/ code samples to new Sphinx extension	2023-09-21 09:28:31 +02:00
sample.yaml	samples/subsys/usb/console: Remove platform_exclude	2023-11-16 09:37:59 +01:00
usbd_next_prj.conf	samples: usb: use common sample USBD initialization	2023-12-13 17:52:00 +01:00

README.rst

.. 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 "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 modemmanager via "sudo stop modemmanager", if it is
trying to access the device in the background.