zephyr/samples/subsys/console/getline
Anas Nashif 3405607d9e license: add missing licenses and copyright
We were missing license boilerplate in many files, add them

Jira: ZEP-1464

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-06-08 10:41:56 -04:00
..
src license: add missing licenses and copyright 2017-06-08 10:41:56 -04:00
Makefile subsys: console: Add pull-style console API support. 2017-04-01 20:44:17 +00:00
prj.conf subsys: console: Add pull-style console API support. 2017-04-01 20:44:17 +00:00
README.rst subsys: console: Add pull-style console API support. 2017-04-01 20:44:17 +00:00
testcase.ini samples: console: fixed filter and add CONFIG_ 2017-04-11 03:14:26 +00:00

.. _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:

.. code-block:: console

   $ cd samples/console/getline
   $ make BOARD=qemu_x86
   $ make BOARD=qemu_x86 run

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.)