adafruit / Adafruit_LvGL_Glue

“Glue” library between LittlevGL and Adafruit GFX (SPITFT)
Other
35 stars 14 forks source link
arduino-library

Adafruit LvGL Glue Build Status

This Arduino library provides a layer between LittlevGL (a UI library for embedded systems) and most of Adafruit's color TFT displays (anything that's a subclass of SPITFT).

Examples show basic use on PyPortal, FeatherWing, CLUE and TFT Gizmo. Use these as a starting point, see LittlevGL documentation at docs.littlevgl.com for a thorough explanation of capabilities and use.

Dependencies

Compatibility

Version 2.1.0 eliminates the "widgets" examples -- only the simple "hello" examples are provided now. LittlevGL development moves faster than we have resources to continually update our examples. You'll fare better starting with one of the official LittlevGL examples, bringing in just the display and input initialization from one of our "hello" examples.

Version 2.0.0 is a breaking change, mostly due to significant structural changes in the LittlevGL library for Arduino. If you were previously using an earlier version of this library and/or LittlevGL, both will need updating, and you should skim the examples and read through the hello_changes example specifically.

Use on M0 (SAMD21) boards is no longer recommended, as LittlevGL has grown. Simple programs might still work, but it's better to move up to a device with more RAM -- M4 (SAMD51), nRF52 and ESP32 are currently supported.

Notes for ESP32

If you wish to use LVGL with WiFi or Bluetooth on the ESP32 (or any other functions that have high memory utilization), wrap the LVGL function calls (lv_xyz() functions) inside calls to lvgl_acquire() and lvgl_release().

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation and doxygen

Documentation is produced by doxygen. Contributions should include documentation for any new code added.

Some examples of how to use doxygen can be found in these guide pages:

https://learn.adafruit.com/the-well-automated-arduino-library/doxygen

https://learn.adafruit.com/the-well-automated-arduino-library/doxygen-tips

Written by Phil Burgess aka Paint Your Dragon for Adafruit Industries. BSD license, check license.txt for more information All text above must be included in any redistribution

To install, use the Arduino Library Manager and search for "Adafruit LvGL Glue Library" and install the library.