A single artwork slot: owns the frame buffers and publishes them to its image views. More...

#include <sendspin_image.h>

Inheritance diagram for esphome::sendspin_::SendspinImageSlot:

Public Member Functions
	SendspinImageSlot (uint8_t slot, ArtworkImageView *current_image, int width, int height, runtime_image::ImageFormat format, image::ImageType type, image::Transparency transparency, bool is_big_endian)

void	setup () override

void	dump_config () override

template<typename F >
void	add_on_image_display_callback (F &&callback)

template<typename F >
void	add_on_image_clear_callback (F &&callback)

template<typename F >
void	add_on_image_error_callback (F &&callback)

void	set_transition_image (ArtworkImageView *transition_image)
	Sets the optional view a transition draws the outgoing artwork from.

void	transition_finished ()
	Signals that the display transition for the last frame has finished.

Public Member Functions inherited from esphome::sendspin_::SendspinChild
float	get_setup_priority () const override

Public Member Functions inherited from esphome::Component
virtual void	loop ()
	This method will be called repeatedly.

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)

Public Member Functions inherited from esphome::Parented< SendspinHub >
	Parented ()

	Parented (SendspinHub *parent)

SendspinHub *	get_parent () const
	Get the parent of this object.

void	set_parent (SendspinHub *parent)
	Set the parent of this object.

Protected Member Functions
void	on_decode_ (const uint8_t *data, size_t length)

bool	decode_frame_ (const uint8_t data, size_t length, const uint8_t target)

void	on_display_ (uint32_t lateness_ms)

void	on_clear_ ()

void	finish_transition_ ()

void	apply_frames_ (bool transition_is_artwork)

void	report_error_ ()

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_ ()

Protected Attributes
ArtworkDecodeSink	decode_sink_

std::array< uint8_t *, 2 >	buffers_ {}

Mutex	pending_mutex_

uint8_t	current_index_ {0}

bool	frame_pending_ {false}

bool	showing_artwork_ {false}

bool	transition_pending_ {false}

ArtworkImageView *	current_image_

ArtworkImageView *	transition_image_ {nullptr}

int	width_

int	height_

uint8_t	slot_

LazyCallbackManager< void(uint32_t)>	image_display_callback_ {}

LazyCallbackManager< void()>	image_clear_callback_ {}

LazyCallbackManager< void()>	image_error_callback_ {}

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_

Protected Attributes inherited from esphome::Parented< SendspinHub >
SendspinHub *	parent_

Detailed Description

A single artwork slot: owns the frame buffers and publishes them to its image views.

BUFFERS: two buffers, allocated zeroed at setup and never freed. One holds the frame the current image shows; the other holds the outgoing frame a transition shows, and is where the next artwork is decoded. Each display swaps their roles.

THREADING: the sendspin library decodes on a dedicated thread and fires display/clear on the main loop. Decoding runs into decode_sink_, which writes into the buffer the current image is not showing; the swap that puts it on screen happens on the main loop. Every slot enables the library's require_frame_done gate, which withholds further deliveries for the slot (buffering the newest payload, latest wins) until the hub's artwork_frame_done() runs. That gate is what makes two buffers enough: no decode starts while the main loop still needs the outgoing frame.

LVGL: publishing a frame to a view updates the descriptor LVGL was handed but does not invalidate the widget, so every widget's source must be set again on each display.

Definition at line 98 of file sendspin_image.h.

Constructor & Destructor Documentation

◆ SendspinImageSlot()

esphome::sendspin_::SendspinImageSlot::SendspinImageSlot	(	uint8_t	slot,
		ArtworkImageView *	current_image,
		int	width,
		int	height,
		runtime_image::ImageFormat	format,
		image::ImageType	type,
		image::Transparency	transparency,
		bool	is_big_endian )

inline

Definition at line 100 of file sendspin_image.h.

Member Function Documentation

◆ add_on_image_clear_callback()

template<typename F >

void esphome::sendspin_::SendspinImageSlot::add_on_image_clear_callback ( F && callback )

inline

Definition at line 115 of file sendspin_image.h.

◆ add_on_image_display_callback()

template<typename F >

void esphome::sendspin_::SendspinImageSlot::add_on_image_display_callback ( F && callback )

inline

Definition at line 112 of file sendspin_image.h.

◆ add_on_image_error_callback()

template<typename F >

void esphome::sendspin_::SendspinImageSlot::add_on_image_error_callback ( F && callback )

inline

Definition at line 118 of file sendspin_image.h.

◆ apply_frames_()

void esphome::sendspin_::SendspinImageSlot::apply_frames_ ( bool transition_is_artwork )

protected

Definition at line 244 of file sendspin_image.cpp.

◆ decode_frame_()

bool esphome::sendspin_::SendspinImageSlot::decode_frame_	(	const uint8_t *	data,
		size_t	length,
		const uint8_t *	target )

protected

Definition at line 105 of file sendspin_image.cpp.

◆ dump_config()

void esphome::sendspin_::SendspinImageSlot::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 232 of file sendspin_image.cpp.

◆ finish_transition_()

void esphome::sendspin_::SendspinImageSlot::finish_transition_ ( )

protected

Definition at line 182 of file sendspin_image.cpp.

◆ on_clear_()

void esphome::sendspin_::SendspinImageSlot::on_clear_ ( )

protected

Definition at line 204 of file sendspin_image.cpp.

◆ on_decode_()

void esphome::sendspin_::SendspinImageSlot::on_decode_	(	const uint8_t *	data,
		size_t	length )

protected

Definition at line 69 of file sendspin_image.cpp.

◆ on_display_()

void esphome::sendspin_::SendspinImageSlot::on_display_ ( uint32_t lateness_ms )

protected

Definition at line 134 of file sendspin_image.cpp.

◆ report_error_()

void esphome::sendspin_::SendspinImageSlot::report_error_ ( )

protected

Definition at line 255 of file sendspin_image.cpp.

◆ set_transition_image()

void esphome::sendspin_::SendspinImageSlot::set_transition_image ( ArtworkImageView * transition_image )

inline

Sets the optional view a transition draws the outgoing artwork from.

It holds the outgoing frame while a transition is running and the current frame at any other time, so it always names a picture and never the frame being decoded.

Setting it is also what defers the library ack to transition_finished(): the ack releases the outgoing frame to be decoded over, and this view is the only thing that still names it.

Definition at line 129 of file sendspin_image.h.

◆ setup()

void esphome::sendspin_::SendspinImageSlot::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 18 of file sendspin_image.cpp.

◆ transition_finished()

void esphome::sendspin_::SendspinImageSlot::transition_finished ( )

Signals that the display transition for the last frame has finished.

Acks the library so the next artwork can be delivered, which also hands the outgoing frame's buffer over to be decoded into. Safe no-op when no transition is pending (e.g. no transition image is configured, a clear already ended the transition, or the call is a duplicate). Must run on the main loop thread; exposed as the sendspin.image.transition_finished action.

Definition at line 196 of file sendspin_image.cpp.

Field Documentation

◆ buffers_

std::array<uint8_t *, 2> esphome::sendspin_::SendspinImageSlot::buffers_ {}

protected

Definition at line 153 of file sendspin_image.h.

◆ current_image_

ArtworkImageView* esphome::sendspin_::SendspinImageSlot::current_image_

protected

Definition at line 172 of file sendspin_image.h.

◆ current_index_

uint8_t esphome::sendspin_::SendspinImageSlot::current_index_ {0}

protected

Definition at line 161 of file sendspin_image.h.

◆ decode_sink_

ArtworkDecodeSink esphome::sendspin_::SendspinImageSlot::decode_sink_

protected

Definition at line 148 of file sendspin_image.h.

◆ frame_pending_

bool esphome::sendspin_::SendspinImageSlot::frame_pending_ {false}

protected

Definition at line 163 of file sendspin_image.h.

◆ height_

int esphome::sendspin_::SendspinImageSlot::height_

protected

Definition at line 175 of file sendspin_image.h.

◆ image_clear_callback_

LazyCallbackManager<void()> esphome::sendspin_::SendspinImageSlot::image_clear_callback_ {}

protected

Definition at line 179 of file sendspin_image.h.

◆ image_display_callback_

LazyCallbackManager<void(uint32_t)> esphome::sendspin_::SendspinImageSlot::image_display_callback_ {}

protected

Definition at line 178 of file sendspin_image.h.

◆ image_error_callback_

LazyCallbackManager<void()> esphome::sendspin_::SendspinImageSlot::image_error_callback_ {}

protected

Definition at line 180 of file sendspin_image.h.

◆ pending_mutex_

Mutex esphome::sendspin_::SendspinImageSlot::pending_mutex_

protected

Definition at line 157 of file sendspin_image.h.

◆ showing_artwork_

bool esphome::sendspin_::SendspinImageSlot::showing_artwork_ {false}

protected

Definition at line 167 of file sendspin_image.h.

◆ slot_

uint8_t esphome::sendspin_::SendspinImageSlot::slot_

protected

Definition at line 176 of file sendspin_image.h.

◆ transition_image_

ArtworkImageView* esphome::sendspin_::SendspinImageSlot::transition_image_ {nullptr}

protected

Definition at line 173 of file sendspin_image.h.

◆ transition_pending_

bool esphome::sendspin_::SendspinImageSlot::transition_pending_ {false}

protected

Definition at line 170 of file sendspin_image.h.

◆ width_

int esphome::sendspin_::SendspinImageSlot::width_

protected

Definition at line 174 of file sendspin_image.h.

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

esphome/components/sendspin/image/sendspin_image.h
esphome/components/sendspin/image/sendspin_image.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SendspinImageSlot()

Member Function Documentation

◆ add_on_image_clear_callback()

◆ add_on_image_display_callback()

◆ add_on_image_error_callback()

◆ apply_frames_()

◆ decode_frame_()

◆ dump_config()

◆ finish_transition_()

◆ on_clear_()

◆ on_decode_()

◆ on_display_()

◆ report_error_()

◆ set_transition_image()

◆ setup()

◆ transition_finished()

Field Documentation

◆ buffers_

◆ current_image_

◆ current_index_

◆ decode_sink_

◆ frame_pending_

◆ height_

◆ image_clear_callback_

◆ image_display_callback_

◆ image_error_callback_

◆ pending_mutex_

◆ showing_artwork_

◆ slot_

◆ transition_image_

◆ transition_pending_

◆ width_