zephyr

History

Niranjhana N ed72015dbe samples: console: add print statements for user Add print statements to let user know what kind of input the test is waiting for. Signed-off-by: Niranjhana N <niranjhana.n@intel.com>		2018-07-13 08:48:40 -04:00
..
src	samples: console: add print statements for user	2018-07-13 08:48:40 -04:00
CMakeLists.txt	Introduce cmake-based rewrite of KBuild	2017-11-08 20:00:22 -05:00
prj.conf	subsys: console: Factor out fifo-based console input abstraction	2018-06-20 15:59:12 -04:00
README.rst	doc: getting_started: Support multi-OS instructions	2018-01-18 16:53:31 -05:00
sample.yaml	samples: remove build_only from various samples	2017-12-28 20:24:29 -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.)