2019-01-30 03:59:14 +08:00
# LittlevGL - Free Open-source Embedded GUI Library [](https://twitter.com/intent/tweet?text=LittlevGL%20is%20a%20free%20and%20open%20source%20embedded%20GUI%20library%20with%20easy-to-use%20graphical%20elements,%20beautiful%20visual%20effects%20and%20low%20memory%20footprint.&url=https://littlevgl.com/&via=kisvegabor&hashtags=littlevgl,embedded,gui,free,opensource)
2019-01-29 20:51:49 +08:00
2019-01-30 03:57:46 +08:00
2019-01-29 22:41:07 +08:00
2019-01-30 03:57:46 +08:00
2016-06-15 17:40:04 +08:00
2019-01-29 21:10:41 +08:00
**LittlevGL provides everything you need to create a Graphical User Interface (GUI) on embedded systems with easy-to-use graphical elements, beautiful visual effects and low memory footprint.**
2017-11-29 18:41:34 +08:00
2019-01-29 22:41:07 +08:00
:star: **Star the project if you like it!** :star:
**[Website](https://littlevgl.com) · [Live demo ](https://littlevgl.com/live-demo ) · [Simulator ](https://docs.littlevgl.com/#PC-simulator ) · [Docs ](https://docs.littlevgl.com/ ) · [Blog ](https://blog.littlevgl.com/ )**
2018-12-27 06:35:18 +08:00
2019-01-29 20:51:49 +08:00
### Features
2018-09-24 17:42:13 +08:00
* **Powerful building blocks** buttons, charts, lists, sliders, images, etc.
* **Advanced graphics** with animations, anti-aliasing, opacity, smooth scrolling
* **Various input devices** touch pad, mouse, keyboard, encoder, buttons, etc.
* **Multi-language support** with UTF-8 encoding
* **Fully customizable** graphical elements
* **Hardware independent** to use with any microcontroller or display
* **Scalable** to operate with little memory (50 kB Flash, 10 kB RAM)
* **OS, External memory and GPU** supported but not required
* **Single frame buffer** operation even with advances graphical effects
* **Written in C** for maximal compatibility
* **Simulator** to develop on PC without embedded hardware
* **Tutorials, examples, themes** for rapid development
* **Documentation** and API references online
2016-06-15 17:40:04 +08:00
2019-01-29 22:41:07 +08:00
### Supported devices
2019-01-30 04:33:18 +08:00
Basically, every modern controller - which is able to drive a display - is suitable to run LittlevGL. The minimal requirements:
2019-01-29 22:46:30 +08:00
- **16, 32 or 64-bit** microcontroller or processor
- **> 16 MHz** clock speed
2019-01-30 04:33:18 +08:00
- **> 8 kB RAM for static data** and ** > 2 KB RAM for dynamic data** (graphical objects)
- **$gt; 64 kB flash** (program memory)
- **Optionally ~1/10 screen sized memory** for buffered drawing (on 240 ×
2019-01-29 22:41:07 +08:00
2019-01-30 03:57:46 +08:00
Just to mention some **platforms** :
2019-01-29 22:42:59 +08:00
- STM32F1, STM32F3, [STM32F4 ](https://blog.littlevgl.com/2017-07-15/stm32f429_disco_port ), [STM32F7 ](https://github.com/littlevgl/stm32f746_disco_no_os_sw4stm32 )
2019-01-29 22:41:07 +08:00
- Microchip dsPIC33, PIC24, PIC32MX, PIC32MZ
- NXP Kinetis, LPC, iMX
- [Linux frame buffer ](https://blog.littlevgl.com/2018-01-03/linux_fb ) (/dev/fb)
- [Raspberry PI ](http://www.vk3erw.com/index.php/16-software/63-raspberry-pi-official-7-touchscreen-and-littlevgl )
2019-01-30 03:57:46 +08:00
- [Espressif ESP32 ](https://github.com/littlevgl/esp32_ili9431 )
2019-01-29 22:41:07 +08:00
- Nordic nrf52
- Quectell M66
### Quick start in a simulator
Try LittlevGL in a simulator on you PC without any embedded hardware. Choose a project with your favourite IDE:
| Eclipse | CodeBlock | Visual Studio | PlatfomIO | Qt Creator |
|-------------|----------- |---------------|-----------|------------|
| [](https://github.com/littlevgl/pc_simulator_sdl_eclipse) | [](https://github.com/littlevgl/pc_simulator_win_codeblocks) | [](https://github.com/littlevgl/visual_studio_2017_sdl_x64) | [](https://github.com/littlevgl/pc_simulator_sdl_platformio) | [](https://blog.littlevgl.com/2019-01-03/qt-creator) |
| Cross-platform< br > with SDL | Native Windows | Cross-platform< br > with SDL | Cross-platform< br > with SDL | Cross-platform< br > with SDL |
### Porting to an embedded hardware
In the most simple case you need to do 5 things:
2018-09-17 19:05:41 +08:00
1. Call `lv_tick_inc(x)` every `x` milliseconds in a Timer or Task (`x` should be between 1 and 10)
2018-03-10 14:47:28 +08:00
2. Register a function which can **copy a pixel array** to an area of the screen.
2017-12-21 08:06:11 +08:00
3. Register a function which can **read an input device** . (E.g. touch pad)
2019-01-29 22:41:07 +08:00
4. Copy `lv_conf_templ.h` as `lv_conf.h` next to `lvgl` and set at least `LV_HOR_RES` , `LV_VER_RES` and `LV_COLOR_DEPTH` .
2018-08-27 01:24:41 +08:00
5. Call `lv_task_handler()` periodically every few milliseconds.
2019-01-29 22:50:29 +08:00
2019-01-17 19:18:09 +08:00
For a detailed description visit https://docs.littlevgl.com/#Porting
2018-03-10 14:47:28 +08:00
Or check the [Porting tutorial ](https://github.com/littlevgl/lv_examples/blob/master/lv_tutorial/0_porting/lv_tutorial_porting.c )
2017-11-29 18:32:38 +08:00
2019-01-29 22:41:07 +08:00
### Contributing
To ask questions and discuss topics we use [GitHub's Issue tracker ](https://github.com/littlevgl/lvgl/issues ).
You contribute in several ways:
- **Answer other's question** click the Watch button on the top to get notified about the issues
- **Report and/or fix bugs** using the issue tracker in Pull-request
- **Suggest and/or implement new features** using the issue tracker in Pull-request
- **Improve and/or translate the documentation** learn more [here ](https://github.com/littlevgl/docs )
- **Write a blog post about your experiences** learn more [here ](https://github.com/littlevgl/blog )
- **Upload your project or product as a reference** to [this site ](https://blog.littlevgl.com/2018-12-26/references )
2018-08-21 14:40:12 +08:00
2019-01-29 22:41:07 +08:00
Before contributing, please read [CONTRIBUTING.md ](https://github.com/littlevgl/lvgl/blob/master/docs/CONTRIBUTING.md ).
For more info read this [blog post ](https://blog.littlevgl.com/2018-12-06/contributing ).
2017-05-15 20:11:12 +08:00
2019-01-29 22:41:07 +08:00
### Donate
If you are pleased with the library, found it useful, or you are happy with the support you got, please help its further development:
2017-05-15 20:11:12 +08:00
2018-01-29 19:32:14 +08:00
[](https://littlevgl.com/donate)
