zephyr/samples/subsys/input/input_dump/README.rst
Benjamin Cabé 4f1cd0e428 doc: Migrate subsys/ code samples to new Sphinx extension
This migrates the subsys code samples to the new Sphinx code-sample
extension, making it easier to find relevant samples when browsing
API reference.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-21 09:28:31 +02:00

29 lines
649 B
ReStructuredText

.. zephyr:code-sample:: input-dump
:name: Input dump
:relevant-api: input_events
Print all input events.
Overview
********
The Input Dump sample prints any input event using the :ref:`input` APIs.
Requirements
************
The samples works on any board with an input driver defined in the board devicetree.
Building and Running
********************
Build and flash as follows, changing ``nrf52dk_nrf52832`` for your board:
.. zephyr-app-commands::
:zephyr-app: samples/subsys/input/input_dump
:board: nrf52dk_nrf52832
:goals: build flash
:compact:
After starting, the sample will print any input event in the console.