ESPHome 2026.2.1
Loading...
Searching...
No Matches
esphome::lvgl::LvglComponent Class Reference

Component for rendering LVGL. More...

#include <lvgl_esphome.h>

Inheritance diagram for esphome::lvgl::LvglComponent:
esphome::PollingComponent esphome::Component

Public Member Functions

 LvglComponent (std::vector< display::Display * > displays, float buffer_frac, bool full_refresh, int draw_rounding, bool resume_on_input, bool update_when_display_idle)
 
float get_setup_priority () const override
 
void setup () override
 
void update () override
 
void loop () override
 
void add_on_idle_callback (std::function< void(uint32_t)> &&callback)
 
void dump_config () override
 
lv_disp_t * get_disp ()
 
lv_obj_t * get_scr_act ()
 
void set_paused (bool paused, bool show_snow)
 
bool is_paused () const
 
void maybe_wakeup ()
 
void add_page (LvPageType *page)
 
void show_page (size_t index, lv_scr_load_anim_t anim, uint32_t time)
 
void show_next_page (lv_scr_load_anim_t anim, uint32_t time)
 
void show_prev_page (lv_scr_load_anim_t anim, uint32_t time)
 
void set_page_wrap (bool wrap)
 
size_t get_current_page () const
 
void set_focus_mark (lv_group_t *group)
 
void restore_focus_mark (lv_group_t *group)
 
void set_pause_trigger (Trigger<> *trigger)
 
void set_resume_trigger (Trigger<> *trigger)
 
void set_draw_start_trigger (Trigger<> *trigger)
 
void set_draw_end_trigger (Trigger<> *trigger)
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
virtual void mark_failed ()
 Mark this component as failed.
 
 ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message)
 
void mark_failed (const LogString *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
 ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message)
 
void status_set_error (const LogString *message)
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const char *name, uint32_t length=5000)
 Set warning status flag and automatically clear it after a timeout.
 
void status_momentary_error (const char *name, uint32_t length=5000)
 Set error status flag and automatically clear it after a timeout.
 
bool has_overridden_loop () const
 
void set_component_source (const LogString *source)
 Set where this component was loaded from for some debug messages.
 
const LogString * get_component_log_str () const
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Static Public Member Functions

static void static_flush_cb (lv_disp_drv_t *disp_drv, const lv_area_t *area, lv_color_t *color_p)
 
static void monitor_cb (lv_disp_drv_t *disp_drv, uint32_t time, uint32_t px)
 
static void render_start_cb (lv_disp_drv_t *disp_drv)
 
static void esphome_lvgl_init ()
 Initialize the LVGL library and register custom events.
 
static void add_event_cb (lv_obj_t *obj, event_callback_t callback, lv_event_code_t event)
 
static void add_event_cb (lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2)
 
static void add_event_cb (lv_obj_t *obj, event_callback_t callback, lv_event_code_t event1, lv_event_code_t event2, lv_event_code_t event3)
 

Data Fields

size_t draw_rounding {2}
 
display::DisplayRotation rotation {display::DISPLAY_ROTATION_0_DEGREES}
 

Protected Member Functions

void draw_end_ ()
 
void draw_start_ () const
 
void write_random_ ()
 
void draw_buffer_ (const lv_area_t *area, lv_color_t *ptr)
 
void flush_cb_ (lv_disp_drv_t *disp_drv, const lv_area_t *area, lv_color_t *color_p)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
void set_interval (uint32_t id, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a numeric ID (zero heap allocation).
 
void set_interval (InternalSchedulerID id, uint32_t interval, std::function< void()> &&f)
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const char *name
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t id
 
 ESPDEPRECATED ("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(uint32_t initial_wait_time
 
ESPDEPRECATED("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const std ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(const char *name)
 
 ESPDEPRECATED ("cancel_retry is deprecated and will be removed in 2026.8.0.", "2026.2.0") bool cancel_retry(uint32_t id)
 
void set_timeout (uint32_t id, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a numeric ID (zero heap allocation).
 
void set_timeout (InternalSchedulerID id, uint32_t timeout, std::function< void()> &&f)
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (uint32_t id, std::function< void()> &&f)
 Defer a callback with a numeric ID (zero heap allocation)
 
bool cancel_defer (uint32_t id)
 

Protected Attributes

std::vector< display::Display * > displays_ {}
 
size_t buffer_frac_ {1}
 
bool full_refresh_ {}
 
bool resume_on_input_ {}
 
bool update_when_display_idle_ {}
 
lv_disp_draw_buf_t draw_buf_ {}
 
lv_disp_drv_t disp_drv_ {}
 
lv_disp_t * disp_ {}
 
bool paused_ {}
 
std::vector< LvPageType * > pages_ {}
 
size_t current_page_ {0}
 
bool show_snow_ {}
 
bool page_wrap_ {true}
 
std::map< lv_group_t *, lv_obj_t * > focus_marks_ {}
 
CallbackManager< void(uint32_t)> idle_callbacks_ {}
 
Triggerpause_callback_ {}
 
Triggerresume_callback_ {}
 
Triggerdraw_start_callback_ {}
 
Triggerdraw_end_callback_ {}
 
lv_color_t * rotate_buf_ {}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_interval(const std voi set_interval )(const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_interval(const std boo cancel_interval )(const char *name)
 Cancel an interval function.
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t initial_wait_time
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t max_attempts
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
ESPDEPRECATED("set_retry is deprecated and will be removed in 2026.8.0. Use set_timeout or set_interval instead.", "2026.2.0") void set_retry(const std uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint32_t initial_wait_time
 
uint32_t uint8_t max_attempts
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> && f
 
uint32_t uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
uint8_t max_attempts
 
uint8_t std::function< RetryResult(uint8_t)> && f
 
uint8_t std::function< RetryResult(uint8_t)> float backoff_increase_factor = 1.0f)
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") void set_timeout(const std voi set_timeout )(const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
ESPDEPRECATED("Use const char* or uint32_t overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_timeout(const std boo cancel_timeout )(const char *name)
 Cancel a timeout function.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") void defer(const std voi defer )(const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
ESPDEPRECATED("Use const char* overload instead. Removed in 2026.7.0", "2026.1.0") bool cancel_defer(const std boo cancel_defer )(const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
const LogString * component_source_ {nullptr}
 
uint16_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 Warn if blocked for this many ms (max 65.5s)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 

Detailed Description

Component for rendering LVGL.

This component renders LVGL widgets on a display. Some initialisation must be done in the constructor since LVGL needs to be initialised before any widgets can be created.

Parameters
displaysa list of displays to render onto. All displays must have the same resolution.
buffer_fracthe fraction of the display resolution to use for the LVGL draw buffer. A higher value will make animations smoother but also increase memory usage.
full_refreshif true, the display will be fully refreshed on every frame. If false, only changed areas will be updated.
draw_roundingthe rounding to use when drawing. A value of 1 will draw without any rounding, a value of 2 will round to the nearest multiple of 2, and so on.
resume_on_inputif true, this component will resume rendering when the user presses a key or clicks on the screen.

Definition at line 149 of file lvgl_esphome.h.

Constructor & Destructor Documentation

◆ LvglComponent()

esphome::lvgl::LvglComponent::LvglComponent ( std::vector< display::Display * > displays,
float buffer_frac,
bool full_refresh,
int draw_rounding,
bool resume_on_input,
bool update_when_display_idle )

Definition at line 463 of file lvgl_esphome.cpp.

Member Function Documentation

◆ add_event_cb() [1/3]

void esphome::lvgl::LvglComponent::add_event_cb ( lv_obj_t * obj,
event_callback_t callback,
lv_event_code_t event )
static

Definition at line 132 of file lvgl_esphome.cpp.

◆ add_event_cb() [2/3]

void esphome::lvgl::LvglComponent::add_event_cb ( lv_obj_t * obj,
event_callback_t callback,
lv_event_code_t event1,
lv_event_code_t event2 )
static

Definition at line 136 of file lvgl_esphome.cpp.

◆ add_event_cb() [3/3]

void esphome::lvgl::LvglComponent::add_event_cb ( lv_obj_t * obj,
event_callback_t callback,
lv_event_code_t event1,
lv_event_code_t event2,
lv_event_code_t event3 )
static

Definition at line 142 of file lvgl_esphome.cpp.

◆ add_on_idle_callback()

void esphome::lvgl::LvglComponent::add_on_idle_callback ( std::function< void(uint32_t)> && callback)
inline

Definition at line 161 of file lvgl_esphome.h.

◆ add_page()

void esphome::lvgl::LvglComponent::add_page ( LvPageType * page)

Definition at line 149 of file lvgl_esphome.cpp.

◆ draw_buffer_()

void esphome::lvgl::LvglComponent::draw_buffer_ ( const lv_area_t * area,
lv_color_t * ptr )
protected

Definition at line 184 of file lvgl_esphome.cpp.

◆ draw_end_()

void esphome::lvgl::LvglComponent::draw_end_ ( )
protected

Definition at line 394 of file lvgl_esphome.cpp.

◆ draw_start_()

void esphome::lvgl::LvglComponent::draw_start_ ( ) const
inlineprotected

Definition at line 218 of file lvgl_esphome.h.

◆ dump_config()

void esphome::lvgl::LvglComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 102 of file lvgl_esphome.cpp.

◆ esphome_lvgl_init()

void esphome::lvgl::LvglComponent::esphome_lvgl_init ( )
static

Initialize the LVGL library and register custom events.

Definition at line 126 of file lvgl_esphome.cpp.

◆ flush_cb_()

void esphome::lvgl::LvglComponent::flush_cb_ ( lv_disp_drv_t * disp_drv,
const lv_area_t * area,
lv_color_t * color_p )
protected

Definition at line 237 of file lvgl_esphome.cpp.

◆ get_current_page()

size_t esphome::lvgl::LvglComponent::get_current_page ( ) const

Definition at line 181 of file lvgl_esphome.cpp.

◆ get_disp()

lv_disp_t * esphome::lvgl::LvglComponent::get_disp ( )
inline

Definition at line 168 of file lvgl_esphome.h.

◆ get_scr_act()

lv_obj_t * esphome::lvgl::LvglComponent::get_scr_act ( )
inline

Definition at line 169 of file lvgl_esphome.h.

◆ get_setup_priority()

float esphome::lvgl::LvglComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 157 of file lvgl_esphome.h.

◆ is_paused()

bool esphome::lvgl::LvglComponent::is_paused ( ) const

Definition at line 403 of file lvgl_esphome.cpp.

◆ loop()

void esphome::lvgl::LvglComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 554 of file lvgl_esphome.cpp.

◆ maybe_wakeup()

void esphome::lvgl::LvglComponent::maybe_wakeup ( )
inline

Definition at line 178 of file lvgl_esphome.h.

◆ monitor_cb()

void esphome::lvgl::LvglComponent::monitor_cb ( lv_disp_drv_t * disp_drv,
uint32_t time,
uint32_t px )
static

Definition at line 88 of file lvgl_esphome.cpp.

◆ render_start_cb()

void esphome::lvgl::LvglComponent::render_start_cb ( lv_disp_drv_t * disp_drv)
static

Definition at line 94 of file lvgl_esphome.cpp.

◆ restore_focus_mark()

void esphome::lvgl::LvglComponent::restore_focus_mark ( lv_group_t * group)
inline

Definition at line 199 of file lvgl_esphome.h.

◆ set_draw_end_trigger()

void esphome::lvgl::LvglComponent::set_draw_end_trigger ( Trigger<> * trigger)
inline

Definition at line 212 of file lvgl_esphome.h.

◆ set_draw_start_trigger()

void esphome::lvgl::LvglComponent::set_draw_start_trigger ( Trigger<> * trigger)
inline

Definition at line 211 of file lvgl_esphome.h.

◆ set_focus_mark()

void esphome::lvgl::LvglComponent::set_focus_mark ( lv_group_t * group)
inline

Definition at line 198 of file lvgl_esphome.h.

◆ set_page_wrap()

void esphome::lvgl::LvglComponent::set_page_wrap ( bool wrap)
inline

Definition at line 196 of file lvgl_esphome.h.

◆ set_pause_trigger()

void esphome::lvgl::LvglComponent::set_pause_trigger ( Trigger<> * trigger)
inline

Definition at line 209 of file lvgl_esphome.h.

◆ set_paused()

void esphome::lvgl::LvglComponent::set_paused ( bool paused,
bool show_snow )

Definition at line 113 of file lvgl_esphome.cpp.

◆ set_resume_trigger()

void esphome::lvgl::LvglComponent::set_resume_trigger ( Trigger<> * trigger)
inline

Definition at line 210 of file lvgl_esphome.h.

◆ setup()

void esphome::lvgl::LvglComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 481 of file lvgl_esphome.cpp.

◆ show_next_page()

void esphome::lvgl::LvglComponent::show_next_page ( lv_scr_load_anim_t anim,
uint32_t time )

Definition at line 163 of file lvgl_esphome.cpp.

◆ show_page()

void esphome::lvgl::LvglComponent::show_page ( size_t index,
lv_scr_load_anim_t anim,
uint32_t time )

Definition at line 156 of file lvgl_esphome.cpp.

◆ show_prev_page()

void esphome::lvgl::LvglComponent::show_prev_page ( lv_scr_load_anim_t anim,
uint32_t time )

Definition at line 172 of file lvgl_esphome.cpp.

◆ static_flush_cb()

void esphome::lvgl::LvglComponent::static_flush_cb ( lv_disp_drv_t * disp_drv,
const lv_area_t * area,
lv_color_t * color_p )
static

Definition at line 572 of file lvgl_esphome.cpp.

◆ update()

void esphome::lvgl::LvglComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 546 of file lvgl_esphome.cpp.

◆ write_random_()

void esphome::lvgl::LvglComponent::write_random_ ( )
protected

Definition at line 415 of file lvgl_esphome.cpp.

Field Documentation

◆ buffer_frac_

size_t esphome::lvgl::LvglComponent::buffer_frac_ {1}
protected

Definition at line 224 of file lvgl_esphome.h.

◆ current_page_

size_t esphome::lvgl::LvglComponent::current_page_ {0}
protected

Definition at line 234 of file lvgl_esphome.h.

◆ disp_

lv_disp_t* esphome::lvgl::LvglComponent::disp_ {}
protected

Definition at line 231 of file lvgl_esphome.h.

◆ disp_drv_

lv_disp_drv_t esphome::lvgl::LvglComponent::disp_drv_ {}
protected

Definition at line 230 of file lvgl_esphome.h.

◆ displays_

std::vector<display::Display *> esphome::lvgl::LvglComponent::displays_ {}
protected

Definition at line 223 of file lvgl_esphome.h.

◆ draw_buf_

lv_disp_draw_buf_t esphome::lvgl::LvglComponent::draw_buf_ {}
protected

Definition at line 229 of file lvgl_esphome.h.

◆ draw_end_callback_

Trigger* esphome::lvgl::LvglComponent::draw_end_callback_ {}
protected

Definition at line 243 of file lvgl_esphome.h.

◆ draw_rounding

size_t esphome::lvgl::LvglComponent::draw_rounding {2}

Definition at line 206 of file lvgl_esphome.h.

◆ draw_start_callback_

Trigger* esphome::lvgl::LvglComponent::draw_start_callback_ {}
protected

Definition at line 242 of file lvgl_esphome.h.

◆ focus_marks_

std::map<lv_group_t *, lv_obj_t *> esphome::lvgl::LvglComponent::focus_marks_ {}
protected

Definition at line 237 of file lvgl_esphome.h.

◆ full_refresh_

bool esphome::lvgl::LvglComponent::full_refresh_ {}
protected

Definition at line 225 of file lvgl_esphome.h.

◆ idle_callbacks_

CallbackManager<void(uint32_t)> esphome::lvgl::LvglComponent::idle_callbacks_ {}
protected

Definition at line 239 of file lvgl_esphome.h.

◆ page_wrap_

bool esphome::lvgl::LvglComponent::page_wrap_ {true}
protected

Definition at line 236 of file lvgl_esphome.h.

◆ pages_

std::vector<LvPageType *> esphome::lvgl::LvglComponent::pages_ {}
protected

Definition at line 233 of file lvgl_esphome.h.

◆ pause_callback_

Trigger* esphome::lvgl::LvglComponent::pause_callback_ {}
protected

Definition at line 240 of file lvgl_esphome.h.

◆ paused_

bool esphome::lvgl::LvglComponent::paused_ {}
protected

Definition at line 232 of file lvgl_esphome.h.

◆ resume_callback_

Trigger* esphome::lvgl::LvglComponent::resume_callback_ {}
protected

Definition at line 241 of file lvgl_esphome.h.

◆ resume_on_input_

bool esphome::lvgl::LvglComponent::resume_on_input_ {}
protected

Definition at line 226 of file lvgl_esphome.h.

◆ rotate_buf_

lv_color_t* esphome::lvgl::LvglComponent::rotate_buf_ {}
protected

Definition at line 244 of file lvgl_esphome.h.

◆ rotation

display::DisplayRotation esphome::lvgl::LvglComponent::rotation {display::DISPLAY_ROTATION_0_DEGREES}

Definition at line 208 of file lvgl_esphome.h.

◆ show_snow_

bool esphome::lvgl::LvglComponent::show_snow_ {}
protected

Definition at line 235 of file lvgl_esphome.h.

◆ update_when_display_idle_

bool esphome::lvgl::LvglComponent::update_when_display_idle_ {}
protected

Definition at line 227 of file lvgl_esphome.h.


The documentation for this class was generated from the following files: