Library Configuration Options¶
Kconfig files describe build-time configuration options (called symbols
in Kconfig-speak), how they’re grouped into menus and sub-menus, and
dependencies between them that determine what configurations are valid.
Kconfig files appear throughout the directory tree. For example,
subsys/power/Kconfig defines power-related options.
This documentation is generated automatically from the Kconfig files by
the genrest.py script. Click on symbols for more
information.
Configuration Options¶
Symbol name |
Help/prompt |
|---|---|
Add LVGL header files to the ‘app’ include path. It may be disabled if the include paths for LVGL are causing aliasing issues for ‘app’. |
|
Add POSIX subsystem header files to the ‘app’ include path. |
|
Enable base64 encoding and decoding functionality |
|
Mention maximum number of mutexes in CMSIS compliant application. |
|
This enables CMSIS RTOS v1 API support. This is an OS-integration layer which allows applications using CMSIS RTOS APIs to build on Zephyr. |
|
This enables CMSIS RTOS v2 API support. This is an OS-integration layer which allows applications using CMSIS RTOS V2 APIs to build on Zephyr. |
|
Mention maximum number of semaphores in CMSIS compliant application. |
|
Mention max stack size threads can be allocated in CMSIS RTOS application. |
|
Mention maximum number of timers in CMSIS compliant application. |
|
Mention maximum number of event flags in CMSIS RTOS V2 compliant application. |
|
Mention maximum number of memory slabs in CMSIS RTOS V2 compliant application. |
|
Mention maximum dynamic size of memory slabs/pools in CMSIS RTOS V2 compliant application. |
|
Mention maximum number of message queues in CMSIS RTOS V2 compliant application. |
|
Mention maximum dynamic size of message queues in CMSIS RTOS V2 compliant application. |
|
Mention max number of mutexes in CMSIS RTOS V2 compliant application. |
|
Mention max number of semaphores in CMSIS RTOS V2 compliant application. |
|
Mention max number of dynamic threads in CMSIS RTOS V2 compliant application. There’s a limitation on the number of threads due to memory related constraints. Dynamic threads are a subset of all other CMSIS threads i.e. they also count towards that maximum too. |
|
Mention dynamic stack size threads are allocated in CMSIS RTOS V2 application. |
|
Mention max number of threads in CMSIS RTOS V2 compliant application. There’s a limitation on the number of threads due to memory related constraints. |
|
Mention max stack size threads can be allocated in CMSIS RTOS V2 application. |
|
Mention maximum number of timers in CMSIS RTOS V2 compliant application. |
|
Build with external/user provided C library. |
|
Build a minimal JSON parsing/encoding library. Used by sample applications such as the NATS client. |
|
This option enables the LittlevGL GUI library. |
|
Enable animations |
|
Enable anti-aliasing |
|
Number of bits per pixel. |
|
Rendering buffers are dynamically allocated based on the actual display parameters |
|
Rendering buffers are statically allocated based on the following configuration parameters: * Horizontal screen resolution * Vertical screen resolution * Rendering buffer size * Bytes per pixel |
|
Enable build-in font support, size 12 pixels |
|
Enable build-in font support with sub-pixel rendering, size 12 pixels |
|
Enable build-in font support, size 16 pixels |
|
Enable build-in font support, size 22 pixels |
|
Enable build-in font support, size 28 pixels |
|
Enable build-in compressed font support, size 28 pixels |
|
Enable build-in monospace font support, size 8 pixels |
|
Blue |
|
Custom |
|
Green |
|
Red |
|
Swap the 2 bytes of a RGB565 pixel. |
|
1-bit |
|
16-bit |
|
32-bit |
|
8-bit |
|
Enable screen transparency. Useful for OSD or other overlapping GUISs. |
|
Value of the color blue to be used in the chroma key |
|
Value of the color green to be used in the chroma key |
|
Value of the color red to be used in the chroma key |
|
Build-in font size 12 |
|
Build-in font size 12 with sub-pixel rendering |
|
Build-in font size 16 |
|
Build-in font size 22 |
|
Build-in font size 28 |
|
Build-in compressed font size 28 |
|
Build-in monospace font |
|
Use a none build-in font as default font. A pointer named lv_default_font_custom_ptr should exists as a global variable and point to a valid font structure |
|
Name of the display device to use for rendering. |
|
Use two buffers to render and flush data in parallel |
|
Dots per inch (DPI) |
|
Full flexibility |
|
Disabled |
|
Only horizontally and vertical |
|
Enable LittlevGL file system |
|
User BGR pixel format instead of RGB for sub-pixel rendering |
|
Enable GPU support |
|
Enable group support. Used by keyboard and button input |
|
Horizontal screen resolution in pixels |
|
Default image cache size, image caching keeps the images open. If only the built-in image formats are used there is no real advantage of caching. With complex image decoders (e.g. PNG or JPG) caching can save the continuous decoding of images. However the opened images might consume additional RAM. |
|
Enable support for alpha indexed images |
|
Enable support for indexed images |
|
Enable chroma keying for indexed images |
|
Threshold in pixels before entering drag mode |
|
Percentage of slow down of a throw following a drag. Greater percentage means faster slow-down. |
|
Period in milliseconds before a press is seen as a long press |
|
Period in milliseconds after which a new trigger is generated for a long press |
|
Refresh period for input devices in milliseconds |
|
Use k_malloc and k_free to allocate objects on the kernel heap |
|
Use C library malloc and free to allocate objects on the C library heap |
|
Use a dedicated memory pool in kernel space to allocate lvgl objects on |
|
Size of the largest block in the memory pool in bytes |
|
Size of the smallest block in the memory pool in bytes |
|
Number of maximum sized blocks in the memory pool. |
|
Use a dedicated memory pool in user space to allocate lvgl objects on |
|
Enable arc object support |
|
Enable bar object support |
|
Enable button object support |
|
Enable ink, press, effect for buttons |
|
Enable button matrix object support |
|
Enable calendar object support |
|
Enabled canvas object support |
|
Enable chart object support |
|
Maximum length of axis label |
|
Enable check box object support |
|
Enable color picker object support |
|
Enable container object support |
|
Enable drop down list object support |
|
Drop down list animation time in milliseconds |
|
Enable gauge object support |
|
Enable image object support |
|
Enable image button object support |
|
Enable tile support for image button |
|
Enable keyboard object support |
|
Enable label support |
|
Enable support for long text hints |
|
Scroll speed in pixels per second if scroll mode is enabled for a label |
|
Enable label text selection |
|
Waiting period at beginning/end of the label animation cycle |
|
Enable LED object support |
|
Enable line object support |
|
Enable line meter object support |
|
Enable list object support |
|
List focus animation time in milliseconds |
|
Enable message box object support |
|
Enable page object support |
|
Default page focus animation time in milliseconds |
|
Enabled pre-load object support |
|
Fill |
|
Spinning Arc |
|
Default arc length for pre-load in degrees |
|
Default spin time for pre-load in ms |
|
Enable object realign support |
|
Enable roller object support |
|
Roller animation time in milliseconds |
|
Number of extra pages in case the roller is infinite |
|
Enable slider object support |
|
Enable spinbox object support |
|
Enable switch object support |
|
Enable table object support |
|
Maximum number of columns to support in a table |
|
Enable tab view object support |
|
Tab view animation time in milliseconds |
|
Enable text area object support |
|
Text area cursor blink time in milliseconds |
|
Password character show time in milliseconds |
|
Enable tile view object support |
|
Tile view animation time in milliseconds |
|
Enable window object support |
|
Enable keyboard scan pointer input |
|
Name of the keyboard scan device to use for pointer input. |
|
Maximum number of items in the keyboard scan message queue. |
|
Screen refresh period in milliseconds |
|
Enable shadows |
|
Automatically detect direction |
|
Left-to-right |
|
Right-to-left |
|
Characters on which a text break can take place |
|
Control character to use for signalling text recoloring |
|
If a word is at least this long, a line break is allowed in the word. If the length is 0, no line break is allowed in the middle of a word. |
|
Minimal number of characters to place on a line after a line break occurred in the middle of a word. |
|
Minimal number of characters to place on a line before a line break in the middle of a word can occur. |
|
Enable bidirectional text support The direction of the text will be processed according to the Unicode Bidirectional Algorithm: https://www.w3.org/International/articles/inline-bidi-markup/uba-basics*/ |
|
Enable build-in themes |
|
Enable alien theme, dark futuristic, support |
|
Enable default theme support. Low RAM footprint theme. |
|
Enable runtime theme switching, this will consume 8 to 10kB of RAM. |
|
Enable material theme, flat theme with bold colors and light shadow, support |
|
Enable mono theme, monochrome, support |
|
Enable water-like theme based on the movie “Finding Nemo” |
|
Enable night theme, dark elegant, support |
|
Enable zen theme, peaceful light theme, support |
|
ASCII string encoding |
|
UTF-8 string encoding |
|
Enable memory allocation assertion Check if memory allocation is successful (Quite fast) |
|
Enable null pointer assertion Check if a null pointer is passed as a parameter (Quite fast) |
|
Enable object assertion Check if an object is not a NULL pointer, has the correct type and does exists. (Quite Slow) If this option is disabled and NULL pointer checking is enabled, the NULL pointer check is executed instead. |
|
Enable string assertion Check if the string is not a NULL pointer, unusually long string, contains invalid characters or contains unusual repetitions. (Slow) If this option is disabled and NULL pointer checking is enabled, the NULL pointer check is executed instead. |
|
Enable style assertion Check if a used style is correctly initialized. (Fast) |
|
Enable debug support. If debug support is enabled LVGL will validate the parameters of any function call made and if an invalid parameter is found __ASSERT is called. |
|
Size of the buffer used for rendering screen content as a percentage of total display size. |
|
Vertical screen resolution in pixels |
|
Maximum number of simultaneously active threads in a POSIX application. |
|
Mention maximum number of timers in POSIX compliant application. |
|
Build with minimal C library. |
|
Enable the minimal libc’s trivial implementation of calloc, which forwards to malloc and memset. |
|
Build with long long printf enabled. This will increase the size of the image. |
|
Enable the minimal libc’s implementation of malloc, free, and realloc. Disable if you wish to provide your own implementations of these functions. |
|
Indicate the size of the memory arena used for minimal libc’s malloc() implementation. This size value must be compatible with a sys_mem_pool definition with nmax of 1 and minsz of 16. |
|
Enable the minimal libc’s trivial implementation of reallocarray, which forwards to realloc. |
|
Mention length of message queue name in number of characters. |
|
Mention maximum number of messages in message queue in POSIX compliant application. |
|
Mention maximum size of message in bytes. |
|
Build with newlib library. The newlib library is expected to be part of the SDK in this case. |
|
If user mode is enabled, and MPU hardware has requirements that regions be sized to a power of two and aligned to their size, and user mode threads need to access this heap, then this is necessary to properly define an MPU region for the heap. If this is left at 0, then remaining system RAM will be used for this area and it may not be possible to program it as an MPU region. |
|
Build with floating point printf enabled. This will increase the size of the image. |
|
Build with floating point scanf enabled. This will increase the size of the image. |
|
Build with newlib-nano library, for small embedded apps. The newlib-nano library for ARM embedded processors is a part of the GNU Tools for ARM Embedded Processors. |
|
Enable mostly-standards-compliant implementations of various POSIX (IEEE 1003.1) APIs. |
|
This enables POSIX clock_*(), timer_*(), and *sleep() functions. |
|
This enables POSIX style file system related APIs. |
|
Maximum number of open file descriptors, this includes files, sockets, special devices, etc. |
|
Maximum number of open files. Note that this setting is additionally bounded by CONFIG_POSIX_MAX_FDS. |
|
This enabled POSIX message queue related APIs. |
|
This enables a mostly-standards-compliant implementation of the pthread mutex, condition variable and barrier IPC mechanisms. |
|
Helper symbol to indicate some feature requires a C library implementation with more functionality than what MINIMAL_LIBC provides |
|
Enable usage of ring buffers. This is similar to kernel FIFOs but ring buffers manage their own buffer memory and can store arbitrary data. For optimal performance, use buffer sizes that are a power of 2. |
|
Maximum semaphore count in POSIX compliant Application. |
|
This option directs standard output (e.g. printf) to the console device, rather than suppressing it entirely. See also EARLY_CONSOLE option. |
|
UpdateHub is an enterprise-grade solution which makes simple to remotely update all your embedded devices in the field. It handles all aspects related to sending Firmware Over-the-Air (FOTA) updates with maximum security and efficiency, while you focus in adding value to your product. |
|
Allow the use of UpdateHub Community Server (updatehub-ce) as alternative to the updatehub.io enterprise server. |
|
Enables DTLS communication between the UpdateHub client and the server |
|
Set the interval that the UpdateHub update server will be polled. This time interval is zero and 43200 minutes(30 days). |
|
The product unique identifier is used when communicating with the UpdateHub server. |
|
This configuration is default, if need to use other address, must be set on the UpdateHub shell |
|
Activate shell module that provides UpdateHub commands like |
|
Configure the max number of supported hardware by the same image. |