Base for expanders that cache reads per loop. With an interrupt pin the cache stays valid until INT fires. More...

#include <cached_gpio_component.h>

Inheritance diagram for esphome::gpio_expander::CachedGpioExpanderComponent< T, N >:

Public Member Functions
void	loop () override

Public Member Functions inherited from esphome::gpio_expander::InterruptExpanderComponent
void	set_interrupt_pin (InternalGPIOPin *pin)

float	get_setup_priority () const override

Public Member Functions inherited from esphome::Component
virtual void	setup ()
	Where the component's initialization should happen.

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)

bool	status_comm_result (bool ok)
	Clears the warning when `ok`, else sets it with `message` (default "Communication failed"); returns `ok`.

bool	status_comm_result (bool ok, const LogString *message)

void	status_set_error ()

void	status_set_error (const LogString *message)

void	status_clear_warning ()

void	status_clear_error ()

	ESPDEPRECATED ("Use status_momentary_warning() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_warning(const char *name

void	status_momentary_warning (uint32_t length=5000)
	Set warning status flag and clear it after `length` ms.

void	status_momentary_warning (const LogString *message, uint32_t length=5000)

	ESPDEPRECATED ("Use status_momentary_error() without a name. Removed in 2027.5.0", "2026.11.0") void status_momentary_error(const char *name

void	status_momentary_error (uint32_t length=5000)
	Set error status flag and clear it after `length` ms.

void	status_momentary_error (const LogString *message, uint32_t length=5000)

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::gpio_expander::CachedGpioExpander< T, N, P >
bool	digital_read (P pin)
	Read the state of the given pin.

void	digital_write (P pin, bool value)

Protected Member Functions
void	setup_interrupt_pin_ ()
	Call at the end of setup().

Protected Member Functions inherited from esphome::gpio_expander::InterruptExpanderComponent
bool	attach_interrupt_pin_ ()
	Attach the falling-edge ISR when there is an interrupt pin, then disable the loop until an input needs it.

void	disable_loop_when_released_ ()
	The loop runs again after the INT line falls; stop it once the line is released (HIGH).

void	enable_polling_loop_ ()
	Call from pin_mode() for an input pin: without an interrupt pin the loop polls instead.

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.

bool	set_error_flag_ (const LogString *message)
	Set the error flag and log it; true when it was not set before.

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 Member Functions inherited from esphome::gpio_expander::CachedGpioExpander< T, N, P >
virtual bool	digital_read_hw (P pin)=0
	Read GPIO bank from hardware into internal state.

virtual bool	digital_read_cache (P pin)=0
	Get cached pin value from internal state.

virtual void	digital_write_hw (P pin, bool value)=0
	Write GPIO state to hardware.

void	reset_pin_cache_ ()
	Invalidate cache. This function should be called in component loop().

void	set_invalidate_on_read_ (bool invalidate)
	Control whether digital_read() invalidates the pin's cache entry after reading.

Additional Inherited Members
Data Fields inherited from esphome::Component
uint32_t	length = 5000)

Protected Attributes inherited from esphome::gpio_expander::InterruptExpanderComponent
InternalGPIOPin *	interrupt_pin_ {nullptr}

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::gpio_expander::CachedGpioExpander< T, N, P >
T	read_cache_valid_ [BANKS] {0}

bool	invalidate_on_read_ {true}

Static Protected Attributes inherited from esphome::gpio_expander::CachedGpioExpander< T, N, P >
static constexpr uint16_t	BITS_PER_BYTE = 8

static constexpr uint16_t	BANK_SIZE = sizeof(T) * BITS_PER_BYTE

static constexpr size_t	BANKS = N / BANK_SIZE

static constexpr size_t	CACHE_SIZE_BYTES = BANKS * sizeof(T)

Detailed Description

template<typename T, uint16_t N>
class esphome::gpio_expander::CachedGpioExpanderComponent< T, N >

Base for expanders that cache reads per loop. With an interrupt pin the cache stays valid until INT fires.

Definition at line 34 of file cached_gpio_component.h.

Member Function Documentation

◆ loop()

template<typename T , uint16_t N>

void esphome::gpio_expander::CachedGpioExpanderComponent< T, N >::loop ( )

inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 36 of file cached_gpio_component.h.

◆ setup_interrupt_pin_()

template<typename T , uint16_t N>

void esphome::gpio_expander::CachedGpioExpanderComponent< T, N >::setup_interrupt_pin_ ( )

inlineprotected

Call at the end of setup().

Definition at line 44 of file cached_gpio_component.h.

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

esphome/components/gpio_expander/cached_gpio_component.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ loop()

◆ setup_interrupt_pin_()