acid-drop

- Hacking the planet from a LilyGo T-Deck using custom firmware
git clone git://git.acid.vegas/acid-drop.git
Log | Files | Refs | Archive | README | LICENSE

README.md (8181B)

      1 <h1 align="center"> LVGL - Light and Versatile Graphics Library</h1>
      2 
      3 <p align="center">
      4 <img src="https://lvgl.io/assets/images/lvgl_widgets_demo.gif">
      5 </p>
      6 
      7 <p align="center">
      8 LVGL provides everything you need to create an embedded GUI with easy-to-use graphical elements, beautiful visual effects and a low memory footprint.
      9 </p>
     10 
     11 <h4 align="center">
     12 <a href="https://lvgl.io">Website </a> &middot;
     13 <a href="https://docs.lvgl.io/">Docs</a> &middot;
     14 <a href="https://forum.lvgl.io">Forum</a>  &middot;
     15 <a href="https://lvgl.io/services">Services</a>  &middot;
     16 <a href="https://docs.lvgl.io/master/examples.html">Interactive examples</a>
     17 </h4>
     18 
     19 
     20 **English** | [中文](./README_zh.md) |
     21 
     22 
     23 ---
     24 
     25 #### Table of content
     26 - [Overview](#overview)
     27 - [Get started](#get-started)
     28 - [Examples](#examples)
     29 - [Services](#services)
     30 - [Contributing](#contributing)
     31 
     32 ## Overview
     33 ### Features
     34 * Powerful [building blocks](https://docs.lvgl.io/master/widgets/index.html): buttons, charts, lists, sliders, images, etc.
     35 * Advanced graphics engine: animations, anti-aliasing, opacity, smooth scrolling, blending modes, etc
     36 * Supports [various input devices](https://docs.lvgl.io/master/overview/indev.html): touchscreen, mouse, keyboard, encoder, buttons, etc.
     37 * Supports [multiple displays](https://docs.lvgl.io/master/overview/display.html)
     38 * Hardware independent, can be use with any microcontroller and display
     39 * Scalable to operate with little memory (64 kB Flash, 16 kB RAM)
     40 * Multi-language support with UTF-8 handling, CJK, Bidirectional and Arabic script support
     41 * Fully customizable graphical elements via [CSS-like styles](https://docs.lvgl.io/master/overview/style.html)
     42 * Powerful layouts inspired by CSS: [Flexbox](https://docs.lvgl.io/master/layouts/flex.html) and [Grid](https://docs.lvgl.io/master/layouts/grid.html)
     43 * OS, External memory and GPU are supported but not required. (built in support for STM32 DMA2D, and NXP PXP and VGLite)
     44 * Smooth rendering even with a [single frame buffer](https://docs.lvgl.io/master/porting/display.html)
     45 * Written in C and compatible with C++
     46 * Micropython Binding exposes [LVGL API in Micropython](https://blog.lvgl.io/2019-02-20/micropython-bindings)
     47 * [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) to develop on PC without embedded hardware
     48 * 100+ simple [Examples](https://github.com/lvgl/lvgl/tree/master/examples)
     49 * [Documentation](http://docs.lvgl.io/) and API references online and in PDF
     50 
     51 ### Requirements
     52 Basically, every modern controller (which is able to drive a display) is suitable to run LVGL. The minimal requirements are:
     53 <table>
     54   <tr>
     55     <td> <strong>Name</strong> </td>
     56     <td><strong>Minimal</strong></td>
     57     <td><strong>Recommended</strong></td>
     58   </tr>
     59   <tr>
     60     <td><strong>Architecture</strong></td>
     61     <td colspan="2">16, 32 or 64 bit microcontroller or processor</td>
     62   </tr>
     63   <tr>
     64     <td> <strong>Clock</strong></td>
     65     <td> &gt; 16 MHz </td>
     66     <td> &gt; 48 MHz</td>
     67   </tr>
     68 
     69   <tr>
     70     <td> <strong>Flash/ROM</strong></td>
     71     <td> &gt; 64 kB </td>
     72     <td> &gt; 180 kB</td>
     73   </tr>
     74 
     75   <tr>
     76     <td> <strong>Static RAM</strong></td>
     77     <td> &gt; 16 kB </td>
     78     <td> &gt; 48 kB</td>
     79   </tr>
     80 
     81   <tr>
     82     <td> <strong>Draw buffer</strong></td>
     83     <td> &gt; 1 &times; <em>hor. res.</em> pixels </td>
     84     <td> &gt; 1/10 screen size </td>
     85   </tr>
     86 
     87   <tr>
     88     <td> <strong>Compiler</strong></td>
     89     <td colspan="2"> C99 or newer </td>
     90   </tr>
     91 </table>
     92 
     93 *Note that the memory usage might vary depending on the architecture, compiler and build options.*
     94 
     95 ### Supported platforms
     96 LVGL is completely platform independent and can be used with any MCU that fulfills the requirements.
     97 Just to mention some platforms:
     98 - NXP: Kinetis, LPC, iMX, iMX RT
     99 - STM32F1, STM32F3, STM32F4, STM32F7, STM32L4, STM32L5, STM32H7
    100 - Microchip dsPIC33, PIC24, PIC32MX, PIC32MZ
    101 - [Linux frame buffer](https://blog.lvgl.io/2018-01-03/linux_fb) (/dev/fb)
    102 - [Raspberry Pi](http://www.vk3erw.com/index.php/16-software/63-raspberry-pi-official-7-touchscreen-and-littlevgl)
    103 - [Espressif ESP32](https://github.com/lvgl/lv_port_esp32)
    104 - [Infineon Aurix](https://github.com/lvgl/lv_port_aurix)
    105 - Nordic NRF52 Bluetooth modules
    106 - Quectel modems
    107 
    108 LVGL is also available as:
    109 - [Arduino library](https://docs.lvgl.io/master/get-started/platforms/arduino.html)
    110 - [PlatformIO package](https://platformio.org/lib/show/12440/lvgl)
    111 - [Zephyr library](https://docs.zephyrproject.org/latest/reference/kconfig/CONFIG_LVGL.html)
    112 - [ESP32 component](https://docs.lvgl.io/master/get-started/platforms/espressif.html)
    113 - [NXP MCUXpresso component](https://www.nxp.com/design/software/embedded-software/lvgl-open-source-graphics-library:LITTLEVGL-OPEN-SOURCE-GRAPHICS-LIBRARY)
    114 - [NuttX library](https://docs.lvgl.io/master/get-started/os/nuttx.html)
    115 - [RT-Thread RTOS](https://docs.lvgl.io/master/get-started/os/rt-thread.html)
    116 
    117 
    118 ## Get started
    119 This list shows the recommended way of learning the library:
    120 1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
    121 2. Read the [Introduction](https://docs.lvgl.io/master/intro/index.html) page of the documentation (5 minutes)
    122 3. Get familiar with the basics on the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page (15 minutes)
    123 4. Set up a [Simulator](https://docs.lvgl.io/master/get-started/platforms/pc-simulator.html) (10 minutes)
    124 5. Try out some [Examples](https://github.com/lvgl/lvgl/tree/master/examples)
    125 6. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_)
    126 7. Read the [Overview](https://docs.lvgl.io/master/overview/index.html) page to get a better understanding of the library (2-3 hours)
    127 8. Check the documentation of the [Widgets](https://docs.lvgl.io/master/widgets/index.html) to see their features and usage
    128 9. If you have questions go to the [Forum](http://forum.lvgl.io/)
    129 10. Read the [Contributing](https://docs.lvgl.io/master/CONTRIBUTING.html) guide to see how you can help to improve LVGL (15 minutes)
    130 
    131 ## Examples
    132 
    133 For more examples see the [examples](https://github.com/lvgl/lvgl/tree/master/examples) folder.
    134 
    135 ![LVGL button with label example](https://github.com/lvgl/lvgl/raw/master/docs/misc/btn_example.png)
    136 
    137 ### C
    138 ```c
    139 lv_obj_t * btn = lv_btn_create(lv_scr_act());                   /*Add a button to the current screen*/
    140 lv_obj_set_pos(btn, 10, 10);                                    /*Set its position*/
    141 lv_obj_set_size(btn, 100, 50);                                  /*Set its size*/
    142 lv_obj_add_event_cb(btn, btn_event_cb, LV_EVENT_CLICKED, NULL); /*Assign a callback to the button*/
    143 
    144 lv_obj_t * label = lv_label_create(btn);                        /*Add a label to the button*/
    145 lv_label_set_text(label, "Button");                             /*Set the labels text*/
    146 lv_obj_center(label);                                           /*Align the label to the center*/
    147 ...
    148 
    149 void btn_event_cb(lv_event_t * e)
    150 {
    151   printf("Clicked\n");
    152 }
    153 ```
    154 ### Micropython
    155 Learn more about [Micropython](https://docs.lvgl.io/master/get-started/bindings/micropython.html).
    156 ```python
    157 def btn_event_cb(e):
    158   print("Clicked")
    159 
    160 # Create a Button and a Label
    161 btn = lv.btn(lv.scr_act())
    162 btn.set_pos(10, 10)
    163 btn.set_size(100, 50)
    164 btn.add_event_cb(btn_event_cb, lv.EVENT.CLICKED, None)
    165 
    166 label = lv.label(btn)
    167 label.set_text("Button")
    168 label.center()
    169 ```
    170 
    171 ## Services
    172 LVGL Kft was established to provide a solid background for LVGL library. We offer several type of services to help you in UI development:
    173 - Graphics design
    174 - UI implementation
    175 - Consulting/Support
    176 
    177 For more information see https://lvgl.io/services
    178 Feel free to contact us if you have any questions.
    179 
    180 
    181 ## Contributing
    182 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.
    183 
    184 For a detailed description of contribution opportunities visit the [Contributing](https://docs.lvgl.io/master/CONTRIBUTING.html) section of the documentation.
    185