ESPHome 2026.8.0-dev
Loading...
Searching...
No Matches
esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START > Class Template Reference

#include <animation.h>

Inheritance diagram for esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >:
esphome::Component

Public Member Functions

 LvAnimation (void(*update_callback)(const lv_coord_t *data), std::vector< TemplatableValue< lv_coord_t > > from, std::vector< TemplatableValue< lv_coord_t > > to)
 
void start ()
 
void stop ()
 
void setup () override
 
void loop () override
 
float get_setup_priority () const override
 
void set_duration (uint32_t duration)
 
void set_start_delay (uint32_t start_delay)
 
void add_timing (LvAnimationTiming *timing)
 
void set_loop (bool loop)
 
template<typename F >
void add_on_start_callback (F &&callback)
 
template<typename F >
void add_on_stop_callback (F &&callback)
 
- Public Member Functions inherited from esphome::Component
virtual void dump_config ()
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
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.
 
void mark_failed ()
 Mark this component as failed.
 
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 ()
 
void status_set_warning (const char *message)
 
void status_set_warning (const LogString *message)
 
void status_set_error ()
 
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
 
const LogString * get_component_log_str () const ESPHOME_ALWAYS_INLINE
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time, uint32_t &threshold_ms_out)
 

Protected Attributes

void(*const update_callback_ )(const lv_coord_t *data)
 
LazyCallbackManager< void()> start_callback_ {}
 
LazyCallbackManager< void()> stop_callback_ {}
 
TemplatableValue< lv_coord_t > from_ [DATA_SIZE] {}
 
TemplatableValue< lv_coord_t > to_ [DATA_SIZE] {}
 
uint32_t duration_ {0}
 
uint32_t start_delay_ {0}
 
uint32_t start_time_ {0}
 
lv_coord_t data_from_ [DATA_SIZE] {0}
 
lv_coord_t data_to_ [DATA_SIZE] {0}
 
AnimationState state_ {AnimationState::STOPPED}
 
std::vector< LvAnimationTiming * > timings_ {}
 
bool loop_ {false}
 
- Protected Attributes inherited from esphome::Component
uint8_t component_source_index_ {0}
 Index into component source PROGMEM lookup table (0 = not set)
 
uint8_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_CS}
 Warn threshold in centiseconds (max 2550ms)
 
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 Bit 5: Has overridden loop() (set at registration time) Bits 6-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
ComponentRuntimeStats runtime_stats_
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::Component
friend void::setup ()
 
friend void::original_setup ()
 
void set_component_source_ (uint8_t index)
 Set where this component was loaded from for some debug messages.
 
virtual void call_setup ()
 
void call_dump_config_ ()
 
void enable_loop_slow_path_ ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
bool set_status_flag_ (uint8_t flag)
 Helper to set a status LED flag on both this component and the app.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
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 (const char *name)
 Cancel an interval function.
 
bool cancel_interval (uint32_t id)
 
bool cancel_interval (InternalSchedulerID id)
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
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 (const char *name)
 Cancel a timeout function.
 
bool cancel_timeout (uint32_t id)
 
bool cancel_timeout (InternalSchedulerID id)
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
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 (const char *name)
 Cancel a defer callback using the specified name, name must not be empty.
 
bool cancel_defer (uint32_t id)
 
void status_clear_warning_slow_path_ ()
 
void status_clear_error_slow_path_ ()
 

Detailed Description

template<size_t DATA_SIZE, bool AUTO_START = false>
class esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >

Definition at line 93 of file animation.h.

Constructor & Destructor Documentation

◆ LvAnimation()

template<size_t DATA_SIZE, bool AUTO_START = false>
esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::LvAnimation ( void(* update_callback )(const lv_coord_t *data),
std::vector< TemplatableValue< lv_coord_t > > from,
std::vector< TemplatableValue< lv_coord_t > > to )
inline

Definition at line 95 of file animation.h.

Member Function Documentation

◆ add_on_start_callback()

template<size_t DATA_SIZE, bool AUTO_START = false>
template<typename F >
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::add_on_start_callback ( F && callback)
inline

Definition at line 174 of file animation.h.

◆ add_on_stop_callback()

template<size_t DATA_SIZE, bool AUTO_START = false>
template<typename F >
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::add_on_stop_callback ( F && callback)
inline

Definition at line 177 of file animation.h.

◆ add_timing()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::add_timing ( LvAnimationTiming * timing)
inline

Definition at line 171 of file animation.h.

◆ get_setup_priority()

template<size_t DATA_SIZE, bool AUTO_START = false>
float esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 168 of file animation.h.

◆ loop()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::loop ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 132 of file animation.h.

◆ set_duration()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::set_duration ( uint32_t duration)
inline

Definition at line 169 of file animation.h.

◆ set_loop()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::set_loop ( bool loop)
inline

Definition at line 172 of file animation.h.

◆ set_start_delay()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::set_start_delay ( uint32_t start_delay)
inline

Definition at line 170 of file animation.h.

◆ setup()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 127 of file animation.h.

◆ start()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::start ( )
inline

Definition at line 102 of file animation.h.

◆ stop()

template<size_t DATA_SIZE, bool AUTO_START = false>
void esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::stop ( )
inline

Definition at line 118 of file animation.h.

Field Documentation

◆ data_from_

template<size_t DATA_SIZE, bool AUTO_START = false>
lv_coord_t esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::data_from_[DATA_SIZE] {0}
protected

Definition at line 188 of file animation.h.

◆ data_to_

template<size_t DATA_SIZE, bool AUTO_START = false>
lv_coord_t esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::data_to_[DATA_SIZE] {0}
protected

Definition at line 189 of file animation.h.

◆ duration_

template<size_t DATA_SIZE, bool AUTO_START = false>
uint32_t esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::duration_ {0}
protected

Definition at line 185 of file animation.h.

◆ from_

template<size_t DATA_SIZE, bool AUTO_START = false>
TemplatableValue<lv_coord_t> esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::from_[DATA_SIZE] {}
protected

Definition at line 183 of file animation.h.

◆ loop_

template<size_t DATA_SIZE, bool AUTO_START = false>
bool esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::loop_ {false}
protected

Definition at line 192 of file animation.h.

◆ start_callback_

template<size_t DATA_SIZE, bool AUTO_START = false>
LazyCallbackManager<void()> esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::start_callback_ {}
protected

Definition at line 181 of file animation.h.

◆ start_delay_

template<size_t DATA_SIZE, bool AUTO_START = false>
uint32_t esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::start_delay_ {0}
protected

Definition at line 186 of file animation.h.

◆ start_time_

template<size_t DATA_SIZE, bool AUTO_START = false>
uint32_t esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::start_time_ {0}
protected

Definition at line 187 of file animation.h.

◆ state_

template<size_t DATA_SIZE, bool AUTO_START = false>
AnimationState esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::state_ {AnimationState::STOPPED}
protected

Definition at line 190 of file animation.h.

◆ stop_callback_

template<size_t DATA_SIZE, bool AUTO_START = false>
LazyCallbackManager<void()> esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::stop_callback_ {}
protected

Definition at line 182 of file animation.h.

◆ timings_

template<size_t DATA_SIZE, bool AUTO_START = false>
std::vector<LvAnimationTiming *> esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::timings_ {}
protected

Definition at line 191 of file animation.h.

◆ to_

template<size_t DATA_SIZE, bool AUTO_START = false>
TemplatableValue<lv_coord_t> esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::to_[DATA_SIZE] {}
protected

Definition at line 184 of file animation.h.

◆ update_callback_

template<size_t DATA_SIZE, bool AUTO_START = false>
void(*const esphome::lvgl::LvAnimation< DATA_SIZE, AUTO_START >::update_callback_) (const lv_coord_t *data)
protected

Definition at line 180 of file animation.h.


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