1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/pkg/lvgl/doc.txt
2023-05-08 15:00:53 +02:00

34 lines
907 B
Plaintext

/**
@defgroup pkg_lvgl LVGL - Open-Source Embedded GUI Library
@ingroup pkg
@brief LVGL package for RIOT
@see https://github.com/LVGL/lvgl
## Configuration options
The package can be configured with using several variables. These variables can
either be configured using CFLAGS or using Kconfig (via `make menuconfig`).
LVGL_TASK_THREAD_PRIO cannot be configured via Kconfig.
### Engine settings
- `CONFIG_LVGL_INACTIVITY_PERIOD_MS`: maximum inactivity period before going to sleep in ms.
(default: 5s)
- `CONFIG_LVGL_TASK_HANDLER_DELAY_MS`: delay between lvgl task handle call in us.
(default: 5ms)
- `LVGL_TASK_THREAD_PRIO`: lvgl task handler thread priority.
(default: THREAD_PRIORITY_MAIN - 1)
Example of command line for changing the max activity period to 5s:
```
CFLAGS=-DCONFIG_LVGL_ACTIVITY_PERIOD=5000 make -C tests/pkg/lvgl
```
### SDL Usage
See @ref pkg_lv_drivers.
*/