samples: usb: console: convert README to RST file
Convert README to RST file. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
This commit is contained in:
parent
c3f87d9247
commit
0f5490a004
2 changed files with 44 additions and 29 deletions
44
samples/subsys/usb/console/README.rst
Normal file
44
samples/subsys/usb/console/README.rst
Normal file
|
@ -0,0 +1,44 @@
|
|||
.. _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.
|
|
@ -1,29 +0,0 @@
|
|||
Title: USB Console Hello World
|
||||
|
||||
Description:
|
||||
|
||||
A simple Hello World example, with console output coming to USB UART. Primarily
|
||||
intended to show the required config options.
|
||||
|
||||
Usage
|
||||
-----
|
||||
Plug the board into a host device, for example, a PC running Linux.
|
||||
The board will be detected as a CDC_ACM serial device. To see the console output
|
||||
from the zephyr board, use a command similar to "minicom -D /dev/ttyACM0".
|
||||
You may need to stop modemmanager via "sudo stop modemmanager", if it is
|
||||
trying to access the device in the background.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Building and Running Project:
|
||||
|
||||
$ west build -b reel_board
|
||||
|
||||
Sample Output:
|
||||
|
||||
Hello World! x86
|
||||
Hello World! x86
|
||||
Hello World! x86
|
||||
Hello World! x86
|
||||
...
|
||||
...
|
Loading…
Add table
Add a link
Reference in a new issue