zephyr

History

Carles Cufi 72046a8abc doc: getting_started: Support multi-OS instructions In order to be able to document the build on Windows and UNIX systems, slight variations are required on the app commands that are used throughout the documentation system. This includes getting rid of the prompt symbol and providing commands for both UNIX and Windows operating systems. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>		2018-01-18 16:53:31 -05:00
..
src	kbuild: Removed KBuild	2017-11-08 20:00:22 -05:00
CMakeLists.txt	…
README.rst	doc: getting_started: Support multi-OS instructions	2018-01-18 16:53:31 -05:00
prj.conf	…
sample.yaml	samples: remove build_only from various samples	2017-12-28 20:24:29 -05: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.