zephyr

History

Benjamin Cabé f6a4217a88 doc: driver: samples: Update driver samples to use new Sphinx extension Migrated existing driver samples to use the new code-sample directive and role. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>		2023-09-22 09:21:43 +02:00
..
src
CMakeLists.txt
prj.conf
README.rst	doc: driver: samples: Update driver samples to use new Sphinx extension	2023-09-22 09:21:43 +02:00
sample.yaml	samples, tests: convert string-based twister lists to YAML lists	2023-05-10 09:52:37 +02:00

README.rst

.. zephyr:code-sample:: kscan-touch
   :name: KSCAN touch panel
   :relevant-api: kscan_interface

   Use the KSCAN API to interface with a touch panel.

Overview
********

This sample demonstrates how to interface with a touch panel. When touches are
detected a log message is output on the console.

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

The sample can be built and executed on boards with a touch panel for example
stm32f746g_disco or mimxrt1060_evk. The boards dts file should contain an alias
to kscan0

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

.. code-block:: console

   KSCAN test for touch panels.
   Note: You are expected to see several callbacks
   as you touch the screen.