zephyr/samples/subsys/usb/console/README.rst
Johann Fischer 0f5490a004 samples: usb: console: convert README to RST file
Convert README to RST file.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2021-08-23 18:53:47 -04:00

45 lines
1.0 KiB
ReStructuredText

.. _cdc-acm-console:
Console over CDC ACM UART Sample
################################
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.