zephyr

History

Maksim Masalski d7468bf836 samples: Add fixtures for samples interacting with keyboard and mouse Two samples require interacting with keyboard and mouse, and that means necessary to provide correct fixture before run of that samples in sanitycheck system. To skip or run the sample according to the provided fixture in map-file necessary to add fixture definitions into sample.yaml files Signed-off-by: Maksim Masalski <maksim.masalski@intel.com>		2020-09-08 17:24:38 -04:00
..
src	device: Const-ify all device driver instance pointers	2020-09-02 13:48:13 +02:00
CMakeLists.txt	samples: make find_package(Zephyr...) REQUIRED	2020-05-29 10:47:25 +02:00
README.rst	samples: Add fixtures for samples interacting with keyboard and mouse	2020-09-08 17:24:38 -04:00
prj.conf	…
prj_mec15xxevb_assy6853.conf	…
sample.yaml	samples: Add fixtures for samples interacting with keyboard and mouse	2020-09-08 17:24:38 -04: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.
It requires a correct fixture setup. 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).
For the correct execution of that sample in sanitycheck, add into boards's
map-file next fixture settings::

      - fixture: fixture_connect_keyboard

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!