zephyr

History

Marc Herbert 2cd51a33ce samples: make find_package(Zephyr...) REQUIRED This provides a better error message when building with CMake and forgetting ZEPHYR_BASE or not registering Zephyr in the CMake package registry. See parent commit for more details (split from parent for better readability). Signed-off-by: Marc Herbert <marc.herbert@intel.com>		2020-05-29 10:47:25 +02:00
..
src	tests: drivers: fixes for failing tests	2020-04-24 09:49:46 -05:00
CMakeLists.txt	samples: make find_package(Zephyr...) REQUIRED	2020-05-29 10:47:25 +02:00
prj.conf	samples: drivers: kscan: Add kscan sample application	2019-10-16 13:29:21 -07:00
prj_mec15xxevb_assy6853.conf	samples: drivers: kscan: Add kscan sample application	2019-10-16 13:29:21 -07:00
README.rst	doc: reference: Clean up and restructure a bit	2020-03-18 11:47:24 +01:00
sample.yaml	tests: fix test identifiers	2019-12-09 15:53:44 -05:00

README.rst

.. kscan-sample:

KSCAN Interface
####################################

Overview
********

This sample demonstrates how to use the :ref:`KSCAN API <kscan_api>`.
Callbacks are registered that will write to the console indicating KSCAN events.
These events indicate key presses and releases.

Building and Running
********************

The sample can be built and executed on boards supporting a Keyboard Matrix.
Please connect a Keyboard Matrix to exercise the functionality. You need to
obtain the right keymap from the vendor because they vary across different
manufactures.

Sample output
=============

.. code-block:: console

   KSCAN test with a Keyboard matrix
   Note: You are expected to see several callbacks
   as you press and release keys!