zephyr

History

Anas Nashif 70758c4374 tests: fix test identifiers The seasonal overhaul of test identifiers aligning the terms being used and creating a structure. This is hopefully the last time we do this, plan is to document the identifiers and enforce syntax. The end-goal is to be able to generate a testsuite description from the existing tests and sync it frequently with the testsuite in Testrail. Signed-off-by: Anas Nashif <anas.nashif@intel.com>		2019-12-09 15:53:44 -05:00
..
src	cleanup: include/: move misc/printk.h to sys/printk.h	2019-06-27 22:55:49 -04:00
CMakeLists.txt	license: cleanup: add SPDX Apache-2.0 license identifier	2019-04-07 08:45:22 -04:00
prj.conf
README.rst	doc: add how to exit from QEMU in samples	2019-09-02 12:06:08 -04:00
sample.yaml	tests: fix test identifiers	2019-12-09 15:53:44 -05:00

README.rst

.. _console_getline_sample:

console_getline() Sample Application
####################################

Overview
********

This example shows how to use :cpp:func:`console_getline()` function.
Similar to the well-known ANSI C gets() and fgets() functions,
:cpp:func:`console_getline()` either returns the next available input
line or blocks waiting for one. Using this function, it should be fairly
easy to port existing ANSI C, POSIX, or Linux applications which process
console input line by line. The sample also allows to see details of how
a line is returned by the function.

If you are interested in character by character console input, see
:ref:`console_getchar_sample`.


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

UART console is required to run this simple.


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

The easiest way to run this sample is using QEMU:

.. zephyr-app-commands::
   :zephyr-app: samples/subsys/console/getline
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

Now start pressing keys on a keyboard, followed by Enter. The input line
will be printed back, with a hex code of the last character, to show that
line does not include any special "end of line" characters (like LF, CR,
etc.)
Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.