zephyr

History

Gerard Marull-Paretas 93b63df762 samples, tests: convert string-based twister lists to YAML lists Twister now supports using YAML lists for all fields that were written as space-separated lists. Used twister_to_list.py script. Some artifacts on string length are due to how ruamel dumps content. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>		2023-05-10 09:52:37 +02:00
..
boards	samples: drivers: kscan: Replace prj_<board> files with overlays	2023-03-20 10:18:32 +01:00
src	samples, tests, boards: Switch main return type from void to int	2023-04-14 07:49:41 +09:00
CMakeLists.txt
prj.conf
README.rst
sample.yaml	samples, tests: convert string-based twister lists to YAML lists	2023-05-10 09:52:37 +02: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 twister, 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!