Fork 0
mirror of https://github.com/zephyrproject-rtos/lvgl.git synced 2024-07-13 10:26:09 +02:00
Go to file
Fabio Baltieri a76caad0aa
Merge pull request #53 from ycsin/pr/zephyr_header_autoconf
zephyr: prefix `autoconf.h` with `zephyr/`
2024-05-25 16:58:57 +01:00
.github fix(ci): workaround ASAN error in CI with Ubuntu 22.04 image (#5867) 2024-03-20 08:29:26 +01:00
demos chore: code formatting 2024-03-20 08:29:26 +01:00
docs docs: fixed some typos (#5502) 2024-03-20 08:29:25 +01:00
env_support zephyr: prefix autoconf.h with zephyr/ 2024-05-24 14:15:59 +08:00
examples update code formatter 2024-03-20 08:29:26 +01:00
scripts docs: fix typo 2024-01-22 09:51:20 +00:00
src chore(group):avoid null pointer access (#5864) 2024-03-20 08:29:26 +01:00
tests chore: code formatting 2024-03-20 08:29:26 +01:00
zephyr zephyr: Move gluecode back to zephyr main repository 2023-08-15 09:07:07 +00:00
.codecov.yml ci(codecov) hide statuses on commits for now 2021-08-26 09:35:22 -04:00
.editorconfig merge master 2021-01-23 23:50:00 +01:00
.gitignore feat(ime_pinyin): add API to use Pinyin IME(Chinese input) (#3408) 2023-06-22 21:54:33 +02:00
.pre-commit-config.yaml feat(script): add pre-commit configuration for code formatting (#3092) 2023-06-22 21:48:26 +02:00
CMakeLists.txt arch(env): arch(env): move the cmake folder into the env_support folder 2022-01-19 22:14:04 +01:00
component.mk update to work with Arduino (#2200) 2021-05-03 20:26:10 +02:00
idf_component.yml fix(esp): fix ESP-IDF pedantic builds (backport v8.3) (#4135) 2023-06-22 21:56:25 +02:00
Kconfig chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
library.json chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
library.properties chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
LICENCE.txt docs(license) update company name and year 2021-06-18 11:05:33 +02:00
lv_conf_template.h chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
lvgl.h chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
lvgl.mk chore(make): add lv_ prefix to examples/examples.mk and src/extra/extra.mk (#3187) 2023-06-22 21:53:33 +02:00
lvgl.pc.in chore(cmsis-pack): prepare for release v8.4.0 2024-03-20 08:29:26 +01:00
README.md docs(README): fix broken link 2023-06-22 21:54:34 +02:00
README_pt_BR.md docs(readme): add version portuguese brazilian (#3349) 2023-06-22 21:54:25 +02:00
README_zh.md docs(readme): add version portuguese brazilian (#3349) 2023-06-22 21:54:25 +02:00
SConscript arch(env): move rt-thread into env_support folder (#3025) 2022-01-19 22:10:54 +01:00

LVGL - Light and Versatile Graphics Library

LVGL provides everything you need to create an embedded GUI with easy-to-use graphical elements, beautiful visual effects and a low memory footprint.

Website · Docs · Forum · Services · Interactive examples

English | 中文 | Português do Brasil

Table of content



  • Powerful building blocks: buttons, charts, lists, sliders, images, etc.
  • Advanced graphics engine: animations, anti-aliasing, opacity, smooth scrolling, blending modes, etc
  • Supports various input devices: touchscreen, mouse, keyboard, encoder, buttons, etc.
  • Supports multiple displays
  • Hardware independent, can be use with any microcontroller and display
  • Scalable to operate with little memory (64 kB Flash, 16 kB RAM)
  • Multi-language support with UTF-8 handling, CJK, Bidirectional and Arabic script support
  • Fully customizable graphical elements via CSS-like styles
  • Powerful layouts inspired by CSS: Flexbox and Grid
  • OS, External memory and GPU are supported but not required. (built in support for STM32 DMA2D, SWM341 DMA2D, and NXP PXP and VGLite)
  • Smooth rendering even with a single frame buffer
  • Written in C and compatible with C++
  • Micropython Binding exposes LVGL API in Micropython
  • Simulator to develop on PC without embedded hardware
  • 100+ simple Examples
  • Documentation and API references online and in PDF


Basically, every modern controller (which is able to drive a display) is suitable to run LVGL. The minimal requirements are:

Name Minimal Recommended
Architecture 16, 32 or 64 bit microcontroller or processor
Clock > 16 MHz > 48 MHz
Flash/ROM > 64 kB > 180 kB
Static RAM > 16 kB > 48 kB
Draw buffer > 1 × hor. res. pixels > 1/10 screen size
Compiler C99 or newer

Note that the memory usage might vary depending on the architecture, compiler and build options.

Supported platforms

LVGL is completely platform independent and can be used with any MCU that fulfills the requirements. Just to mention some platforms:

LVGL is also available as:

Get started

This list shows the recommended way of learning the library:

  1. Check the Online demos to see LVGL in action (3 minutes)
  2. Read the Introduction page of the documentation (5 minutes)
  3. Get familiar with the basics on the Quick overview page (15 minutes)
  4. Set up a Simulator (10 minutes)
  5. Try out some Examples
  6. Port LVGL to a board. See the Porting guide or check the ready to use Projects
  7. Read the Overview page to get a better understanding of the library (2-3 hours)
  8. Check the documentation of the Widgets to see their features and usage
  9. If you have questions go to the Forum
  10. Read the Contributing guide to see how you can help to improve LVGL (15 minutes)


For more examples see the examples folder.

LVGL button with label example


lv_obj_t * btn = lv_btn_create(lv_scr_act());                   /*Add a button to the current screen*/
lv_obj_set_pos(btn, 10, 10);                                    /*Set its position*/
lv_obj_set_size(btn, 100, 50);                                  /*Set its size*/
lv_obj_add_event_cb(btn, btn_event_cb, LV_EVENT_CLICKED, NULL); /*Assign a callback to the button*/

lv_obj_t * label = lv_label_create(btn);                        /*Add a label to the button*/
lv_label_set_text(label, "Button");                             /*Set the labels text*/
lv_obj_center(label);                                           /*Align the label to the center*/

void btn_event_cb(lv_event_t * e)


Learn more about Micropython.

def btn_event_cb(e):

# Create a Button and a Label
btn = lv.btn(lv.scr_act())
btn.set_pos(10, 10)
btn.set_size(100, 50)
btn.add_event_cb(btn_event_cb, lv.EVENT.CLICKED, None)

label = lv.label(btn)


LVGL Kft was established to provide a solid background for LVGL library. We offer several type of services to help you in UI development:

  • Graphics design
  • UI implementation
  • Consulting/Support

For more information see https://lvgl.io/services Feel free to contact us if you have any questions.


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 hosting your own project under the LVGL organization.

For a detailed description of contribution opportunities visit the Contributing section of the documentation.