Skip to content

Commit

Permalink
doc: samples: lvgl: add details to lvgl demos readme
Browse files Browse the repository at this point in the history
LVGL demos in this folder are all based on pointer input devices,
not any input devices types.

Signed-off-by: Eve Redero <eve.redero@gmail.com>
  • Loading branch information
everedero committed Feb 13, 2024
1 parent ebbf672 commit ad72911
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion samples/modules/lvgl/demos/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,27 @@ A sample showcasing upstream LVGL demos.
* Widgets
Shows how the widgets look like out of the box using the built-in material theme.

More details can be found in `LVGL demos Readme`_.

Requirements
************

* A board with display, ideally with 480x272 resolution or higher.
* A pointer input device: touchpad, mouse, or touch screen capable display, compatible with :dtcompatible:`zephyr,lvgl-pointer-input`.

Note that other input devices types are not demonstrated in these demos, namely keyboards, keypads (:dtcompatible:`zephyr,lvgl-button-input`), rotary encoders (:dtcompatible:`zephyr,lvgl-encoder-input`) and hardware buttons (:dtcompatible:`zephyr,lvgl-button-input`).

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

These demos can be built as follows:
Example building for :ref:`mimxrt1060_evk`:

.. zephyr-app-commands::
:zephyr-app: samples/modules/lvgl/demos
:board: mimxrt1060_evk
:goals: build flash

These demos can be built for simulated display environment as follows:

.. zephyr-app-commands::
:zephyr-app: samples/modules/lvgl/demos
Expand Down Expand Up @@ -59,3 +71,11 @@ These demos can be built as follows:
:gen-args: -DCONFIG_LV_Z_DEMO_WIDGETS=y
:goals: run
:compact:

Alternatively, if building from a 64-bit host machine, the previous target
board argument may also be replaced by ``native_sim_64``.

References
**********

.. _LVGL demos Readme: https://github.com/lvgl/lvgl/blob/master/demos/README.md

0 comments on commit ad72911

Please sign in to comment.