#include <key_collector.h>

Inheritance diagram for esphome::key_collector::KeyCollector:

Public Member Functions
void	loop () override

void	dump_config () override

void	add_provider (key_provider::KeyProvider *provider)

void	set_min_length (uint16_t min_length)

void	set_max_length (uint16_t max_length)

void	set_start_keys (std::string start_keys)

void	set_end_keys (std::string end_keys)

void	set_end_key_required (bool end_key_required)

void	set_back_keys (std::string back_keys)

void	set_clear_keys (std::string clear_keys)

void	set_allowed_keys (std::string allowed_keys)

void	add_on_progress_callback (std::function< void(const std::string &, uint8_t)> &&callback)

void	add_on_result_callback (std::function< void(const std::string &, uint8_t, uint8_t)> &&callback)

void	add_on_timeout_callback (std::function< void(const std::string &, uint8_t)> &&callback)

void	set_timeout (int timeout)

void	set_enabled (bool enabled)

void	clear (bool progress_update=true)

void	send_key (uint8_t key)

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

virtual float	get_setup_priority () const
	priority of setup().

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.

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)

Protected Attributes
uint16_t	min_length_ {0}

uint16_t	max_length_ {0}

std::string	start_keys_

std::string	end_keys_

bool	end_key_required_ {false}

std::string	back_keys_

std::string	clear_keys_

std::string	allowed_keys_

std::string	result_

uint8_t	start_key_ {0}

LazyCallbackManager< void(const std::string &, uint8_t)>	progress_callbacks_

LazyCallbackManager< void(const std::string &, uint8_t, uint8_t)>	result_callbacks_

LazyCallbackManager< void(const std::string &, uint8_t)>	timeout_callbacks_

uint32_t	last_key_time_ {}

uint32_t	timeout_ {0}

bool	enabled_ {}

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 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.

Additional Inherited Members
Protected Member Functions inherited from esphome::Component
void	call_loop_ ()

virtual void	call_setup ()

void	call_dump_config_ ()

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

Detailed Description

Definition at line 11 of file key_collector.h.

Member Function Documentation

◆ add_on_progress_callback()

void esphome::key_collector::KeyCollector::add_on_progress_callback ( std::function< void(const std::string &, uint8_t)> && callback )

inline

Definition at line 24 of file key_collector.h.

◆ add_on_result_callback()

void esphome::key_collector::KeyCollector::add_on_result_callback ( std::function< void(const std::string &, uint8_t, uint8_t)> && callback )

inline

Definition at line 27 of file key_collector.h.

◆ add_on_timeout_callback()

void esphome::key_collector::KeyCollector::add_on_timeout_callback ( std::function< void(const std::string &, uint8_t)> && callback )

inline

Definition at line 30 of file key_collector.h.

◆ add_provider()

void esphome::key_collector::KeyCollector::add_provider ( key_provider::KeyProvider * provider )

Definition at line 41 of file key_collector.cpp.

◆ clear()

void esphome::key_collector::KeyCollector::clear ( bool progress_update = true )

Definition at line 52 of file key_collector.cpp.

◆ dump_config()

void esphome::key_collector::KeyCollector::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 17 of file key_collector.cpp.

◆ loop()

void esphome::key_collector::KeyCollector::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file key_collector.cpp.

◆ send_key()

void esphome::key_collector::KeyCollector::send_key ( uint8_t key )

Definition at line 62 of file key_collector.cpp.

◆ set_allowed_keys()

void esphome::key_collector::KeyCollector::set_allowed_keys ( std::string allowed_keys )

inline

Definition at line 23 of file key_collector.h.

◆ set_back_keys()

void esphome::key_collector::KeyCollector::set_back_keys ( std::string back_keys )

inline

Definition at line 21 of file key_collector.h.

◆ set_clear_keys()

void esphome::key_collector::KeyCollector::set_clear_keys ( std::string clear_keys )

inline

Definition at line 22 of file key_collector.h.

◆ set_enabled()

void esphome::key_collector::KeyCollector::set_enabled ( bool enabled )

Definition at line 45 of file key_collector.cpp.

◆ set_end_key_required()

void esphome::key_collector::KeyCollector::set_end_key_required ( bool end_key_required )

inline

Definition at line 20 of file key_collector.h.

◆ set_end_keys()

void esphome::key_collector::KeyCollector::set_end_keys ( std::string end_keys )

inline

Definition at line 19 of file key_collector.h.

◆ set_max_length()

void esphome::key_collector::KeyCollector::set_max_length ( uint16_t max_length )

inline

Definition at line 17 of file key_collector.h.

◆ set_min_length()

void esphome::key_collector::KeyCollector::set_min_length ( uint16_t min_length )

inline

Definition at line 16 of file key_collector.h.

◆ set_start_keys()

void esphome::key_collector::KeyCollector::set_start_keys ( std::string start_keys )

inline

Definition at line 18 of file key_collector.h.

◆ set_timeout()

void esphome::key_collector::KeyCollector::set_timeout ( int timeout )

inline

Definition at line 33 of file key_collector.h.

Field Documentation

◆ allowed_keys_

std::string esphome::key_collector::KeyCollector::allowed_keys_

protected

Definition at line 47 of file key_collector.h.

◆ back_keys_

std::string esphome::key_collector::KeyCollector::back_keys_

protected

Definition at line 45 of file key_collector.h.

◆ clear_keys_

std::string esphome::key_collector::KeyCollector::clear_keys_

protected

Definition at line 46 of file key_collector.h.

◆ enabled_

bool esphome::key_collector::KeyCollector::enabled_ {}

protected

Definition at line 55 of file key_collector.h.

◆ end_key_required_

bool esphome::key_collector::KeyCollector::end_key_required_ {false}

protected

Definition at line 44 of file key_collector.h.

◆ end_keys_

std::string esphome::key_collector::KeyCollector::end_keys_

protected

Definition at line 43 of file key_collector.h.

◆ last_key_time_

uint32_t esphome::key_collector::KeyCollector::last_key_time_ {}

protected

Definition at line 53 of file key_collector.h.

◆ max_length_

uint16_t esphome::key_collector::KeyCollector::max_length_ {0}

protected

Definition at line 41 of file key_collector.h.

◆ min_length_

uint16_t esphome::key_collector::KeyCollector::min_length_ {0}

protected

Definition at line 40 of file key_collector.h.

◆ progress_callbacks_

LazyCallbackManager<void(const std::string &, uint8_t)> esphome::key_collector::KeyCollector::progress_callbacks_

protected

Definition at line 50 of file key_collector.h.

◆ result_

std::string esphome::key_collector::KeyCollector::result_

protected

Definition at line 48 of file key_collector.h.

◆ result_callbacks_

LazyCallbackManager<void(const std::string &, uint8_t, uint8_t)> esphome::key_collector::KeyCollector::result_callbacks_

protected

Definition at line 51 of file key_collector.h.

◆ start_key_

uint8_t esphome::key_collector::KeyCollector::start_key_ {0}

protected

Definition at line 49 of file key_collector.h.

◆ start_keys_

std::string esphome::key_collector::KeyCollector::start_keys_

protected

Definition at line 42 of file key_collector.h.

◆ timeout_

uint32_t esphome::key_collector::KeyCollector::timeout_ {0}

protected

Definition at line 54 of file key_collector.h.

◆ timeout_callbacks_

LazyCallbackManager<void(const std::string &, uint8_t)> esphome::key_collector::KeyCollector::timeout_callbacks_

protected

Definition at line 52 of file key_collector.h.

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

esphome/components/key_collector/key_collector.h
esphome/components/key_collector/key_collector.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ add_on_progress_callback()

◆ add_on_result_callback()

◆ add_on_timeout_callback()

◆ add_provider()

◆ clear()

◆ dump_config()

◆ loop()

◆ send_key()

◆ set_allowed_keys()

◆ set_back_keys()

◆ set_clear_keys()

◆ set_enabled()

◆ set_end_key_required()

◆ set_end_keys()

◆ set_max_length()

◆ set_min_length()

◆ set_start_keys()

◆ set_timeout()

Field Documentation

◆ allowed_keys_

◆ back_keys_

◆ clear_keys_

◆ enabled_

◆ end_key_required_

◆ end_keys_

◆ last_key_time_

◆ max_length_

◆ min_length_

◆ progress_callbacks_

◆ result_

◆ result_callbacks_

◆ start_key_

◆ start_keys_

◆ timeout_

◆ timeout_callbacks_