README.rst
1.. zephyr:code-sample:: lvgl-multi-display
2 :name: LVGL Multi-display
3 :relevant-api: display_interface
4
5 Run different LVGL demos on multiple displays.
6
7Overview
8********
9
10A sample showcasing LVGL multi-display support in Zephyr.
11
12By default, it runs the Music demo on the first display, and the Widgets demo on the other ones
13(order as defined in the "displays" property of "zephyr,displays" compatible node in deviceTree).
14Which demos are run can be changed by modifying the value of CONFIG_LV_Z_DEMO_FIRST_DISP## and
15CONFIG_LV_Z_DEMO_OTHER_DISPS## Kconfig symbols.
16
17Music
18 The music player demo shows what kind of modern, smartphone-like user interfaces can be
19 created on LVGL.
20Benchmark
21 The benchmark demo tests the performance in various cases. For example rectangle, border,
22 shadow, text, image blending, image transformation, blending modes, etc.
23Stress
24 A stress test for LVGL. It contains a lot of object creation, deletion, animations, styles
25 usage, and so on. It can be used if there is any memory corruption during heavy usage or any
26 memory leaks.
27Widgets
28 Shows how the widgets look like out of the box using the built-in material theme.
29
30More details on the demos can be found in `LVGL demos Readme`_.
31
32Requirements
33************
34
35* A board with two displays or more, ideally with 480x272 resolution or higher.
36
37Building and Running
38********************
39
40This sample can be built for simulated display environment on Linux as follows:
41
42.. zephyr-app-commands::
43 :zephyr-app: samples/modules/lvgl/multi_display
44 :host-os: unix
45 :board: native_sim/native/64
46 :goals: run
47 :compact:
48
49References
50**********
51
52.. target-notes::
53
54.. _LVGL demos Readme: https://github.com/zephyrproject-rtos/lvgl/blob/zephyr/demos/README.md
55
