zephyr

History

Reto Schneider 7eabab2f5d samples, tests: Use semi-accurate project names When using an IDE (e.g. Eclipse, Qt Creator), the project name gets displayed. This greatly simplifies the navigation between projects when having many of them open at the same time. Naming every project "NONE" defeats this functionality. This patch tries to use sensible project names while not duplicating too much of what is already represented in the path. This is done by using the name of the directory the relevant CMakeLists.txt file is stored in. To ensure unique project names in the samples (and again, in the tests folder) folder, small manual adjustments have been done. Signed-off-by: Reto Schneider <code@reto-schneider.ch>		2018-10-27 21:31:25 -04:00
..
src	samples: console: add print statements for user	2018-07-13 08:48:40 -04:00
CMakeLists.txt	samples, tests: Use semi-accurate project names	2018-10-27 21:31:25 -04: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	tests/samples: cleanup tags	2018-10-16 09:17:51 -04:00

README.rst

.. _console_getchar_sample:

console_getchar() Sample Application
####################################

Overview
********

This example shows how to use :cpp:func:`console_getchar()` function.
Similar to the well-known ANSI C getchar() function,
:cpp:func:`console_getchar()` either returns the next available input
character 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 character by character. The sample also allows to
see key/character codes as returned by the function.

If you are interested in line by line console input, see
:ref:`console_getline_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/getchar
   :host-os: unix
   :board: qemu_x86
   :goals: run
   :compact:

Now start pressing keys on a keyboard, and they will be printed both as
hex values and in character form. Be sure to press Enter, Up/Down, etc.
key to check what control characters are produced for them.