Skip to content

Commit e26a46c

Browse files
committed
docs(arduino): add note to not use lv_examles library
fixes lvgl#4054
1 parent a19ad9b commit e26a46c

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

docs/get-started/platforms/arduino.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,14 @@ In the INO file you can see how to register a display and a touchpad for LVGL an
5252

5353
Note that, there is no dedicated INO file for every example. Instead, you can load an example by calling an `lv_example_...` function. For example `lv_example_btn_1()`.
5454

55-
**IMPORTANT**
55+
**IMPORTANT NOTE 1**
5656
Due to some the limitations of Arduino's build system you need to copy `lvgl/examples` to `lvgl/src/examples`. Similarly for the demos `lvgl/demos` to `lvgl/src/demos`.
5757

58+
59+
**IMPORTANT NOTE 2**
60+
Note that the `lv_examples` library is for LVGL v7 and you shouldn't install it for this version (since LVGL v8)
61+
as the examples and demos are now part of the main LVGL library.
62+
5863
## Debugging and logging
5964

6065
LVGL can display debug information in case of trouble.

examples/arduino/LVGL_Arduino/LVGL_Arduino.ino

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
/*Using LVGL with Arduino requires some extra steps:
2-
* Be sure to read the docs here: https://docs.lvgl.io/master/get-started/platforms/arduino.html */
2+
*Be sure to read the docs here: https://docs.lvgl.io/master/get-started/platforms/arduino.html */
33

44
#include <lvgl.h>
55
#include <TFT_eSPI.h>
66

77
/*To use the built-in examples and demos of LVGL uncomment the includes below respectively.
8-
*You also need to copy `lvgl/examples` to `lvgl/src/examples`. Similarly for the demos `lvgl/demos` to `lvgl/src/demos`.*/
9-
//#include <demos/lv_demos.h>
10-
//#include <examples/lv_examples.h>
8+
*You also need to copy `lvgl/examples` to `lvgl/src/examples`. Similarly for the demos `lvgl/demos` to `lvgl/src/demos`.
9+
Note that the `lv_examples` library is for LVGL v7 and you shouldn't install it for this version (since LVGL v8)
10+
as the examples and demos are now part of the main LVGL library. */
1111

1212
/*Change to your screen resolution*/
1313
static const uint16_t screenWidth = 480;

0 commit comments

Comments
 (0)