2019-10-08 01:44:33 +08:00
|
|
|
.. kscan-sample:
|
|
|
|
|
|
|
|
|
|
KSCAN Interface
|
|
|
|
|
####################################
|
|
|
|
|
|
|
|
|
|
Overview
|
|
|
|
|
********
|
|
|
|
|
|
2020-03-14 02:02:31 +08:00
|
|
|
This sample demonstrates how to use the :ref:`KSCAN API <kscan_api>`.
|
2019-10-08 01:44:33 +08:00
|
|
|
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!
|
