2021-01-11 21:28:00 +08:00
< h1 align = "center" > LVGL - Light and Versatile Graphics Library< / h1 >
2019-08-07 15:39:35 +08:00
2019-08-07 15:41:01 +08:00
< p align = "center" >
2020-05-19 17:35:18 +08:00
< img src = "https://lvgl.io/assets/images/img_1.png" >
2019-02-01 02:13:26 +08:00
< / p >
2019-02-01 04:23:56 +08:00
< p align = "center" >
2021-01-11 21:28:00 +08:00
LVGL provides everything you need to create embedded GUI with easy-to-use graphical elements, beautiful visual effects and low memory footprint.
2019-02-01 04:23:56 +08:00
< / p >
2017-11-29 18:41:34 +08:00
2019-02-01 02:13:26 +08:00
< h4 align = "center" >
2021-01-11 21:28:00 +08:00
< a href = "https://lvgl.io" > Website < / a > ·
< a href = "https://lvgl.io/demos" > Online demo< / a > ·
< a href = "https://lvgl.github.io/lv_examples/" > Nightly demos< / a > ·
< a href = "https://docs.lvgl.io/" > Docs< / a > ·
2020-07-14 23:15:30 +08:00
< a href = "https://forum.lvgl.io" > Forum< / a >
2019-02-01 02:13:50 +08:00
< / h4 >
2019-01-31 21:01:56 +08:00
2019-07-19 14:07:53 +08:00
---
## Features
2020-07-14 23:15:30 +08:00
* Powerful [building blocks ](https://docs.lvgl.io/latest/en/html/widgets/index.html ): buttons, charts, lists, sliders, images, etc.
2020-06-18 22:13:04 +08:00
* Advanced graphics: animations, anti-aliasing, opacity, smooth scrolling
2020-07-14 23:15:30 +08:00
* Use [various input devices ](https://docs.lvgl.io/latest/en/html/overview/indev.html ): touchscreen, mouse, keyboard, encoder, buttons, etc.
* Use [multiple displays ](https://docs.lvgl.io/latest/en/html/overview/display.html ): e.g. monochrome and color display
2020-06-18 22:13:04 +08:00
* Hardware independent to use with any microcontroller or display
* Scalable to operate with little memory (64 kB Flash, 10 kB RAM)
2020-07-14 23:15:30 +08:00
* Multi-language support with UTF-8 handling, Bidirectional and Arabic script support
* Fully customizable graphical elements via [CSS-like styles ](https://docs.lvgl.io/latest/en/html/overview/style.html )
2020-06-18 22:13:04 +08:00
* OS, External memory and GPU are supported but not required
2020-07-14 23:15:30 +08:00
* Smooth rendering even with a [single frame buffer ](https://docs.lvgl.io/latest/en/html/porting/display.html )
2020-06-18 22:13:04 +08:00
* Written in C for maximal compatibility (C++ compatible)
* Micropython Binding exposes [LVGL API in Micropython ](https://blog.lvgl.io/2019-02-20/micropython-bindings )
2020-07-14 23:15:30 +08:00
* [Simulator ](https://docs.lvgl.io/latest/en/html/get-started/pc-simulator.html ) to develop on PC without embedded hardware
* [Examples ](lv_examples ) and tutorials for rapid development
* [Documentation ](http://docs.lvgl.io/ ) and API references
2016-06-15 17:40:04 +08:00
2020-07-14 23:36:41 +08:00
## Requirements
2020-06-18 22:13:04 +08:00
Basically, every modern controller (which is able to drive a display) is suitable to run LVGL. The minimal requirements are:
2020-07-14 23:36:41 +08:00
< table >
< tr >
< td > < strong > Name< / strong > < / td >
< td > < strong > Minimal< / strong > < / td >
< td > < strong > Recommended< / strong > < / td >
< / tr >
< tr >
< td > < strong > Architecture< / strong > < / td >
< td colspan = "2" > 16, 32 or 64 bit microcontroller or processor< / td >
< / tr >
< tr >
< td > < strong > Clock< / strong > < / td >
< td > > 16 MHz < / td >
< td > > 48 MHz< / td >
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Flash/ROM< / strong > < / td >
< td > > 64 kB < / td >
2020-07-15 14:55:27 +08:00
< td > > 180 kB< / td >
2020-07-14 23:36:41 +08:00
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Static RAM< / strong > < / td >
< td > > 2 kB < / td >
< td > > 4 kB< / td >
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Stack< / strong > < / td >
< td > > 2 kB < / td >
< td > > 8 kB< / td >
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Heap< / strong > < / td >
< td > > 2 kB < / td >
2020-08-01 04:13:46 +08:00
< td > > 8 kB< / td >
2020-07-14 23:36:41 +08:00
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Display buffer< / strong > < / td >
< td > > 1 × < em > hor. res.< / em > pixels < / td >
< td > > 10 × < em > hor. res.< / em > pixels < / td >
< / tr >
2021-01-11 21:28:00 +08:00
2020-07-14 23:36:41 +08:00
< tr >
< td > < strong > Compiler< / strong > < / td >
< td colspan = "2" > C99 or newer < / td >
< / tr >
< / table >
2019-07-19 14:07:53 +08:00
*Note that the memory usage might vary depending on the architecture, compiler and build options.*
2019-01-29 22:41:07 +08:00
2020-06-18 22:13:04 +08:00
Just to mention some platforms:
2020-07-14 23:06:33 +08:00
- STM32F1, STM32F3, STM32F4, STM32F7, STM32L4, STM32L5, STM32H7
2019-01-29 22:41:07 +08:00
- Microchip dsPIC33, PIC24, PIC32MX, PIC32MZ
2020-06-18 22:13:04 +08:00
- NXP: Kinetis, LPC, iMX, iMX RT
2020-05-15 20:43:45 +08:00
- [Linux frame buffer ](https://blog.lvgl.io/2018-01-03/linux_fb ) (/dev/fb)
2020-07-15 14:55:27 +08:00
- [Raspberry Pi ](http://www.vk3erw.com/index.php/16-software/63-raspberry-pi-official-7-touchscreen-and-littlevgl )
2020-05-15 20:43:45 +08:00
- [Espressif ESP32 ](https://github.com/lvgl/lv_port_esp32 )
2020-07-14 23:06:33 +08:00
- [Infineon Aurix ](https://github.com/lvgl/lv_port_aurix )
- Nordic NRF52 Bluetooth modules
2020-07-15 14:55:27 +08:00
- Quectel modems
2019-01-29 22:41:07 +08:00
2020-06-18 22:13:04 +08:00
## Get started
2020-07-14 23:06:33 +08:00
This list shows the recommended way of learning the library:
2020-06-18 22:13:04 +08:00
1. Check the [Online demos ](https://lvgl.io/demos ) to see LVGL in action (3 minutes)
2. Read the [Introduction ](https://docs.lvgl.io/latest/en/html/intro/index.html ) page of the documentation (5 minutes)
2020-07-14 23:06:33 +08:00
3. Get familiar with the basics on the [Quick overview ](https://docs.lvgl.io/latest/en/html/get-started/quick-overview.html ) page (15 minutes)
2020-06-18 22:13:04 +08:00
4. Set up a [Simulator ](https://docs.lvgl.io/latest/en/html/get-started/pc-simulator.html ) (10 minutes)
5. Try out some [Examples ](https://github.com/lvgl/lv_examples/ )
6. Port LVGL to a board. See the [Porting ](https://docs.lvgl.io/latest/en/html/porting/index.html ) guide or check the ready to use [Projects ](https://github.com/lvgl?q=lv_port_&type=&language= )
2020-07-15 14:55:27 +08:00
7. Read the [Overview ](https://docs.lvgl.io/latest/en/html/overview/index.html ) page to get a better understanding of the library (2-3 hours)
2020-06-18 22:13:04 +08:00
8. Check the documentation of the [Widgets ](https://docs.lvgl.io/latest/en/html/widgets/index.html ) to see their features and usage
2020-07-14 23:06:33 +08:00
9. If you have questions go to the [Forum ](http://forum.lvgl.io/ )
2021-01-11 21:28:00 +08:00
10. Read the [Contributing ](https://docs.lvgl.io/latest/en/html/contributing/index.html ) guide to see how you can help to improve LVGL (15 minutes)
2019-07-19 14:07:53 +08:00
2021-01-11 21:28:00 +08:00
## Examples
2019-07-19 14:07:53 +08:00
2020-06-18 22:29:18 +08:00
For more examples see the [lv_examples ](https://github.com/lvgl/lv_examples ) repository.
2019-07-19 14:07:53 +08:00
### Button with label
2019-01-31 06:05:21 +08:00
```c
2020-09-24 01:24:00 +08:00
lv_obj_t * btn = lv_btn_create(lv_scr_act(), NULL); /*Add a button to the current screen*/
2019-01-31 06:05:21 +08:00
lv_obj_set_pos(btn, 10, 10); /*Set its position*/
lv_obj_set_size(btn, 100, 50); /*Set its size*/
2019-07-05 07:05:03 +08:00
lv_obj_set_event_cb(btn, btn_event_cb); /*Assign a callback to the button*/
2019-07-19 14:07:53 +08:00
2019-01-31 06:05:21 +08:00
lv_obj_t * label = lv_label_create(btn, NULL); /*Add a label to the button*/
lv_label_set_text(label, "Button"); /*Set the labels text*/
2019-07-19 14:07:53 +08:00
...
2019-07-05 07:05:03 +08:00
void btn_event_cb(lv_obj_t * btn, lv_event_t event)
2019-01-31 06:05:21 +08:00
{
2019-07-05 07:05:03 +08:00
if(event == LV_EVENT_CLICKED) {
printf("Clicked\n");
}
2019-01-31 06:05:21 +08:00
}
```
2020-06-18 22:19:57 +08:00
2019-01-31 06:05:21 +08:00
2020-06-18 22:13:04 +08:00
### LVGL from Micropython
2020-07-28 18:18:42 +08:00
Learn more about [Micropython ](https://docs.lvgl.io/latest/en/html/get-started/micropython.html ).
2019-02-24 17:20:37 +08:00
```python
# Create a Button and a Label
scr = lv.obj()
btn = lv.btn(scr)
btn.align(lv.scr_act(), lv.ALIGN.CENTER, 0, 0)
label = lv.label(btn)
label.set_text("Button")
# Load the screen
lv.scr_load(scr)
```
2019-07-19 14:07:53 +08:00
## Contributing
2020-07-14 23:06:33 +08:00
LVGL is an open project and contribution is very welcome. There are many ways to contribute from simply speaking about your project, through writing examples, improving the documentation, fixing bugs to hosing your own project under in LVGL.
2020-06-18 22:13:04 +08:00
For a detailed description of contribution opportunities visit the [Contributing ](https://docs.lvgl.io/latest/en/html/contributing/index.html ) section of the documentation.
2021-05-15 07:11:51 +08:00
