: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,lvgl-encoder-input
.. _dtbinding_zephyr_lvgl_encoder_input:

zephyr,lvgl-encoder-input
#########################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`modules/lvgl/input/lvgl_encoder_input.c`.

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



.. code-block:: none

   LVGL encoder indev pseudo-device

   Listens for button/encoder input events and routes the
   lv_indev_data_t to the underlying encoder lv_indev_t managed by LVGL.

   Example configuration:

   encoder {
           compatible = "zephyr,lvgl-encoder-input";
           rotation-input-code = <INPUT_REL_Y>;
           button-input-code = <INPUT_KEY_0>;
   };

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

         * - ``rotation-input-code``
           - ``int``
           - .. code-block:: none

                Input event code associated with rotation (INPUT_REL_*).



             This property is **required**.

         * - ``button-input-code``
           - ``int``
           - .. code-block:: none

                Input event key code for encoder button (INPUT_KEY_* or INPUT_BTN_*).



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

                Input device phandle.





   .. 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,lvgl-encoder-input" compatible.

      (None)