zephyr

History

Anas Nashif 70758c4374 tests: fix test identifiers The seasonal overhaul of test identifiers aligning the terms being used and creating a structure. This is hopefully the last time we do this, plan is to document the identifiers and enforce syntax. The end-goal is to be able to generate a testsuite description from the existing tests and sync it frequently with the testsuite in Testrail. Signed-off-by: Anas Nashif <anas.nashif@intel.com>		2019-12-09 15:53:44 -05:00
..
src	cleanup: include/: move misc/printk.h to sys/printk.h	2019-06-27 22:55:49 -04:00
CMakeLists.txt	license: cleanup: add SPDX Apache-2.0 license identifier	2019-04-07 08:45:22 -04:00
README.rst	doc: add how to exit from QEMU in samples	2019-09-02 12:06:08 -04:00
prj.conf	subsys: console: Factor out fifo-based console input abstraction	2018-06-20 15:59:12 -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`.