:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: zephyr,input-double-tap
.. _dtbinding_zephyr_input_double_tap:

zephyr,input-double-tap
#######################

.. sidebar:: Overview

   :Name: ``zephyr,input-double-tap``
   :Vendor: :ref:`The Zephyr Project <dt_vendor_zephyr>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=zephyr,input-double-tap>` using
               this compatible
   :Driver: :zephyr_file:`subsys/input/input_double_tap.c`

Description
***********



.. code-block:: none

   Input double tap pseudo-device

   Listens for key events as an input and produces key events as output
   corresponding to double taps.

   Can be optionally be associated to a specific device to listen for events
   only from that device.

   Example configuration:

   #include <zephyr/dt-bindings/input/input-event-codes.h>

   double_tap {
           input = <&buttons>;
           compatible = "zephyr,input-double-tap";
           input-codes = <INPUT_KEY_0>, <INPUT_KEY_1>;
           double-tap-codes = <INPUT_KEY_A>, <INPUT_KEY_B>;
           double-tap-delay-ms = <300>;
   };

Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``input``
           - ``phandle``
           - .. code-block:: none

                Input device phandle, if not specified listen for input from all devices.



         * - ``input-codes``
           - ``array``
           - .. code-block:: none

                Array of input event key codes (INPUT_KEY_* or INPUT_BTN_*).



             This property is **required**.

         * - ``double-tap-codes``
           - ``array``
           - .. code-block:: none

                Array of key codes to be generated for double taps (INPUT_KEY_* or INPUT_BTN_*).



             This property is **required**.

         * - ``double-tap-delay-ms``
           - ``int``
           - .. code-block:: none

                Maximum time delay between taps to register a double tap, in milliseconds.


             This property is **required**.



   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "zephyr,input-double-tap" compatible.

      (None)