diff --git a/docs/get-started/arduino.md b/docs/get-started/arduino.md index c382b6295..a7e945b40 100644 --- a/docs/get-started/arduino.md +++ b/docs/get-started/arduino.md @@ -5,17 +5,16 @@ # Arduino -The [core LVGL library](https://github.com/lvgl/lvgl) and the [examples](https://github.com/lvgl/lv_examples) are directly available as Arduino libraries. +The [core LVGL library](https://github.com/lvgl/lvgl) and the [demos](https://github.com/lvgl/lv_demos) are directly available as Arduino libraries. Note that you need to choose a powerful enough board to run LVGL and your GUI. See the [requirements of LVGL](https://docs.lvgl.io/latest/en/html/intro/index.html#requirements). For example ESP32 is a good candidate to create your UI with LVGL. -## Get the LVGL Ardunio library +## Get the LVGL Arduino library LVGL can be installed via the Arduino IDE Library Manager or as a .ZIP library. -It will also install [lv_exmaples](https://github.com/lvgl/lv_examples) which contains a lot of examples and demos to try LVGL. ## Set up drivers @@ -32,26 +31,18 @@ LVGL has its own configuration file called `lv_conf.h`. When LVGL is installed t 1. Go to directory of the installed Arduino libraries 2. Go to `lvgl` and copy `lv_conf_template.h` as `lv_conf.h` into the Arduino Libraries directory next to the `lvgl` library folder. 3. Open `lv_conf.h` and change the first `#if 0` to `#if 1` -4. Set the resolution of your display in `LV_HOR_RES_MAX` and `LV_VER_RES_MAX` -5. Set the color depth of you display in `LV_COLOR_DEPTH` -6. Set `LV_TICK_CUSTOM 1` - -## Configure the examples -`lv_examples` can be configures similarly to LVGL but it's configuration file is called `lv_ex_conf.h`. -1. Go to directory of the installed Arduino libraries -2. Go to `lv_examples` and copy `lv_ex_template.h` as `lv_ex_conf.h` next to the `lv_examples` folder. -3. Open `lv_ex_conf.h` and change the first `#if 0` to `#if 1` -4. Enable the demos you want to use. (The small examples starting with `lv_ex_...()` are always enabled.) +4. Set the color depth of you display in `LV_COLOR_DEPTH` +5. Set `LV_TICK_CUSTOM 1` ## Initialize LVGL and run an example -Take a look at [LVGL_Arduino.ino](https://github.com/lvgl/lvgl/blob/master/examples/LVGL_Arduino.ino) to see how to initialize LVGL. +Take a look at [LVGL_Arduino.ino](https://github.com/lvgl/lvgl/blob/master/examples/arduino/LVGL_Arduino/LVGL_Arduino.ino) to see how to initialize LVGL. TFT_eSPI is used as the display driver. In the INO file you can see how to register a display and a touch pad for LVGL and call an example. -Note that, there is no dedicated INO file for every example but you can call functions like `lv_ex_btn1()` or `lv_ex_slider1()` to run an example. -For the full list of examples see the [README of lv_examples](https://github.com/lvgl/lv_examples/blob/master/README.md). +Note that, there is no dedicated INO file for every example but you can call functions like `lv_example_btn_1()` or `lv_example_slider_1()` to run an example. +Most of the examples are available in the [`lvgl/examples`](https://github.com/lvgl/lvgl/tree/master/examples) folder. Some are also available in [`lv_demos`](https://github.com/lvgl/lv_demos), which needs to be installed and configured separately. ## Debugging and logging