zephyr

History

Torsten Rasmussen 407b49b35c cmake: use find_package to locate Zephyr Using find_package to locate Zephyr. Old behavior was to use $ENV{ZEPHYR_BASE} for inclusion of boiler plate code. Whenever an automatic run of CMake happend by the build system / IDE then it was required that ZEPHYR_BASE was defined. Using ZEPHYR_BASE only to locate the Zephyr package allows CMake to cache the base variable and thus allowing subsequent invocation even if ZEPHYR_BASE is not set in the environment. It also removes the risk of strange build results if a user switchs between different Zephyr based project folders and forgetting to reset ZEPHYR_BASE before running ninja / make. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>		2020-03-27 16:23:46 +01:00
..
src
CMakeLists.txt	cmake: use find_package to locate Zephyr	2020-03-27 16:23:46 +01: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_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.
Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.