Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: samples: lvgl: add details to lvgl demos readme #68950

Merged
merged 1 commit into from
Mar 12, 2024
Merged

doc: samples: lvgl: add details to lvgl demos readme #68950

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion samples/modules/lvgl/demos/README.rst
View file
Open in desktop
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-keypad-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/zephyrproject-rtos/lvgl/blob/zephyr/demos/README.md
Loading