#include <esp32_touch.h>

Inheritance diagram for esphome::esp32_touch::ESP32TouchComponent:

Data Structures
struct	TouchEvent

Public Member Functions
void	register_touch_pad (ESP32TouchBinarySensor *pad)

void	set_setup_mode (bool setup_mode)

void	set_meas_interval_us (float meas_interval_us)

void	set_charge_duration_ms (float charge_duration_ms)

void	set_charge_times (uint32_t charge_times)

void	set_low_voltage_reference (touch_volt_lim_l_t low_voltage_reference)

void	set_high_voltage_reference (touch_volt_lim_h_t high_voltage_reference)

void	setup () override

void	dump_config () override

void	loop () override

void	on_shutdown () override

void	set_filter_mode (touch_benchmark_filter_mode_t filter_mode)

void	set_debounce_count (uint32_t debounce_count)

void	set_noise_threshold (uint32_t noise_threshold)

void	set_jitter_step (uint32_t jitter_step)

void	set_smooth_level (touch_smooth_filter_mode_t smooth_level)

void	set_denoise_grade (touch_denoise_chan_resolution_t denoise_grade)

void	set_denoise_cap (touch_denoise_chan_cap_t cap_level)

void	set_waterproof_guard_ring_pad (int channel_id)

void	set_waterproof_shield_driver (uint32_t drive_capability)

void	set_iir_filter (uint32_t iir_filter)

Public Member Functions inherited from esphome::Component
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_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 Member Functions
bool	create_touch_queue_ ()

void	cleanup_touch_queue_ ()

void	configure_wakeup_pads_ ()

void	process_setup_mode_logging_ (uint32_t now)

void	publish_initial_state_if_needed_ (ESP32TouchBinarySensor *child, uint32_t now)

bool	iir_filter_enabled_ () const

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)

Static Protected Member Functions
static bool	on_active_cb (touch_sensor_handle_t handle, const touch_active_event_data_t event, void ctx)

static bool	on_inactive_cb (touch_sensor_handle_t handle, const touch_inactive_event_data_t event, void ctx)

Protected Attributes
std::vector< ESP32TouchBinarySensor * >	children_

bool	setup_mode_ {false}

uint32_t	setup_mode_last_log_print_ {0}

touch_sensor_handle_t	sens_handle_ {nullptr}

QueueHandle_t	touch_queue_ {nullptr}

float	meas_interval_us_ {320.0f}

float	charge_duration_ms_ {1.0f}

uint32_t	charge_times_ {500}

touch_volt_lim_l_t	low_voltage_reference_ {TOUCH_VOLT_LIM_L_0V5}

touch_volt_lim_h_t	high_voltage_reference_ {TOUCH_VOLT_LIM_H_2V7}

uint32_t	iir_filter_ {0}

touch_benchmark_filter_mode_t	filter_mode_ {TOUCH_BM_JITTER_FILTER}

uint32_t	debounce_count_ {0}

uint32_t	noise_threshold_ {0}

uint32_t	jitter_step_ {0}

touch_smooth_filter_mode_t	smooth_level_ {TOUCH_SMOOTH_NO_FILTER}

bool	filter_configured_ {false}

touch_denoise_chan_resolution_t	denoise_grade_ {TOUCH_DENOISE_CHAN_RESOLUTION_BIT12}

touch_denoise_chan_cap_t	denoise_cap_level_ {TOUCH_DENOISE_CHAN_CAP_5PF}

bool	denoise_configured_ {false}

int	waterproof_guard_ring_pad_ {-1}

uint32_t	waterproof_shield_driver_ {0}

bool	waterproof_configured_ {false}

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.

Detailed Description

Definition at line 29 of file esp32_touch.h.

Member Function Documentation

◆ cleanup_touch_queue_()

void esphome::esp32_touch::ESP32TouchComponent::cleanup_touch_queue_ ( )

protected

Definition at line 407 of file esp32_touch.cpp.

◆ configure_wakeup_pads_()

void esphome::esp32_touch::ESP32TouchComponent::configure_wakeup_pads_ ( )

protected

Definition at line 414 of file esp32_touch.cpp.

◆ create_touch_queue_()

bool esphome::esp32_touch::ESP32TouchComponent::create_touch_queue_ ( )

protected

Definition at line 392 of file esp32_touch.cpp.

◆ dump_config()

void esphome::esp32_touch::ESP32TouchComponent::dump_config ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 232 of file esp32_touch.cpp.

◆ iir_filter_enabled_()

bool esphome::esp32_touch::ESP32TouchComponent::iir_filter_enabled_ ( ) const

inlineprotected

Definition at line 147 of file esp32_touch.h.

◆ loop()

void esphome::esp32_touch::ESP32TouchComponent::loop ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 314 of file esp32_touch.cpp.

◆ on_active_cb()

bool IRAM_ATTR esphome::esp32_touch::ESP32TouchComponent::on_active_cb	(	touch_sensor_handle_t	handle,
		const touch_active_event_data_t *	event,
		void *	ctx )

staticprotected

Definition at line 27 of file esp32_touch.cpp.

◆ on_inactive_cb()

bool IRAM_ATTR esphome::esp32_touch::ESP32TouchComponent::on_inactive_cb	(	touch_sensor_handle_t	handle,
		const touch_inactive_event_data_t *	event,
		void *	ctx )

staticprotected

Definition at line 37 of file esp32_touch.cpp.

◆ on_shutdown()

void esphome::esp32_touch::ESP32TouchComponent::on_shutdown ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 372 of file esp32_touch.cpp.

◆ process_setup_mode_logging_()

void esphome::esp32_touch::ESP32TouchComponent::process_setup_mode_logging_ ( uint32_t now )

protected

Definition at line 461 of file esp32_touch.cpp.

◆ publish_initial_state_if_needed_()

void esphome::esp32_touch::ESP32TouchComponent::publish_initial_state_if_needed_	(	ESP32TouchBinarySensor *	child,
		uint32_t	now )

protected

Definition at line 488 of file esp32_touch.cpp.

◆ register_touch_pad()

void esphome::esp32_touch::ESP32TouchComponent::register_touch_pad ( ESP32TouchBinarySensor * pad )

inline

Definition at line 31 of file esp32_touch.h.

◆ set_charge_duration_ms()

void esphome::esp32_touch::ESP32TouchComponent::set_charge_duration_ms ( float charge_duration_ms )

inline

Definition at line 37 of file esp32_touch.h.

◆ set_charge_times()

void esphome::esp32_touch::ESP32TouchComponent::set_charge_times ( uint32_t charge_times )

inline

Definition at line 39 of file esp32_touch.h.

◆ set_debounce_count()

void esphome::esp32_touch::ESP32TouchComponent::set_debounce_count ( uint32_t debounce_count )

inline

Definition at line 62 of file esp32_touch.h.

◆ set_denoise_cap()

void esphome::esp32_touch::ESP32TouchComponent::set_denoise_cap ( touch_denoise_chan_cap_t cap_level )

inline

Definition at line 83 of file esp32_touch.h.

◆ set_denoise_grade()

void esphome::esp32_touch::ESP32TouchComponent::set_denoise_grade ( touch_denoise_chan_resolution_t denoise_grade )

inline

Definition at line 79 of file esp32_touch.h.

◆ set_filter_mode()

void esphome::esp32_touch::ESP32TouchComponent::set_filter_mode ( touch_benchmark_filter_mode_t filter_mode )

inline

Definition at line 58 of file esp32_touch.h.

◆ set_high_voltage_reference()

void esphome::esp32_touch::ESP32TouchComponent::set_high_voltage_reference ( touch_volt_lim_h_t high_voltage_reference )

inline

Definition at line 46 of file esp32_touch.h.

◆ set_iir_filter()

void esphome::esp32_touch::ESP32TouchComponent::set_iir_filter ( uint32_t iir_filter )

inline

Definition at line 97 of file esp32_touch.h.

◆ set_jitter_step()

void esphome::esp32_touch::ESP32TouchComponent::set_jitter_step ( uint32_t jitter_step )

inline

Definition at line 70 of file esp32_touch.h.

◆ set_low_voltage_reference()

void esphome::esp32_touch::ESP32TouchComponent::set_low_voltage_reference ( touch_volt_lim_l_t low_voltage_reference )

inline

Definition at line 43 of file esp32_touch.h.

◆ set_meas_interval_us()

void esphome::esp32_touch::ESP32TouchComponent::set_meas_interval_us ( float meas_interval_us )

inline

Definition at line 34 of file esp32_touch.h.

◆ set_noise_threshold()

void esphome::esp32_touch::ESP32TouchComponent::set_noise_threshold ( uint32_t noise_threshold )

inline

Definition at line 66 of file esp32_touch.h.

◆ set_setup_mode()

void esphome::esp32_touch::ESP32TouchComponent::set_setup_mode ( bool setup_mode )

inline

Definition at line 33 of file esp32_touch.h.

◆ set_smooth_level()

void esphome::esp32_touch::ESP32TouchComponent::set_smooth_level ( touch_smooth_filter_mode_t smooth_level )

inline

Definition at line 74 of file esp32_touch.h.

◆ set_waterproof_guard_ring_pad()

void esphome::esp32_touch::ESP32TouchComponent::set_waterproof_guard_ring_pad ( int channel_id )

inline

Definition at line 88 of file esp32_touch.h.

◆ set_waterproof_shield_driver()

void esphome::esp32_touch::ESP32TouchComponent::set_waterproof_shield_driver ( uint32_t drive_capability )

inline

Definition at line 92 of file esp32_touch.h.

◆ setup()

void esphome::esp32_touch::ESP32TouchComponent::setup ( )

overridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file esp32_touch.cpp.

Field Documentation

◆ charge_duration_ms_

float esphome::esp32_touch::ESP32TouchComponent::charge_duration_ms_ {1.0f}

protected

Definition at line 133 of file esp32_touch.h.

◆ charge_times_

uint32_t esphome::esp32_touch::ESP32TouchComponent::charge_times_ {500}

protected

Definition at line 135 of file esp32_touch.h.

◆ children_

std::vector<ESP32TouchBinarySensor *> esphome::esp32_touch::ESP32TouchComponent::children_

protected

Definition at line 121 of file esp32_touch.h.

◆ debounce_count_

uint32_t esphome::esp32_touch::ESP32TouchComponent::debounce_count_ {0}

protected

Definition at line 154 of file esp32_touch.h.

◆ denoise_cap_level_

touch_denoise_chan_cap_t esphome::esp32_touch::ESP32TouchComponent::denoise_cap_level_ {TOUCH_DENOISE_CHAN_CAP_5PF}

protected

Definition at line 163 of file esp32_touch.h.

◆ denoise_configured_

bool esphome::esp32_touch::ESP32TouchComponent::denoise_configured_ {false}

protected

Definition at line 164 of file esp32_touch.h.

◆ denoise_grade_

touch_denoise_chan_resolution_t esphome::esp32_touch::ESP32TouchComponent::denoise_grade_ {TOUCH_DENOISE_CHAN_RESOLUTION_BIT12}

protected

Definition at line 162 of file esp32_touch.h.

◆ filter_configured_

bool esphome::esp32_touch::ESP32TouchComponent::filter_configured_ {false}

protected

Definition at line 158 of file esp32_touch.h.

◆ filter_mode_

touch_benchmark_filter_mode_t esphome::esp32_touch::ESP32TouchComponent::filter_mode_ {TOUCH_BM_JITTER_FILTER}

protected

Definition at line 153 of file esp32_touch.h.

◆ high_voltage_reference_

touch_volt_lim_h_t esphome::esp32_touch::ESP32TouchComponent::high_voltage_reference_ {TOUCH_VOLT_LIM_H_2V7}

protected

Definition at line 140 of file esp32_touch.h.

◆ iir_filter_

uint32_t esphome::esp32_touch::ESP32TouchComponent::iir_filter_ {0}

protected

Definition at line 145 of file esp32_touch.h.

◆ jitter_step_

uint32_t esphome::esp32_touch::ESP32TouchComponent::jitter_step_ {0}

protected

Definition at line 156 of file esp32_touch.h.

◆ low_voltage_reference_

touch_volt_lim_l_t esphome::esp32_touch::ESP32TouchComponent::low_voltage_reference_ {TOUCH_VOLT_LIM_L_0V5}

protected

Definition at line 139 of file esp32_touch.h.

◆ meas_interval_us_

float esphome::esp32_touch::ESP32TouchComponent::meas_interval_us_ {320.0f}

protected

Definition at line 130 of file esp32_touch.h.

◆ noise_threshold_

uint32_t esphome::esp32_touch::ESP32TouchComponent::noise_threshold_ {0}

protected

Definition at line 155 of file esp32_touch.h.

◆ sens_handle_

touch_sensor_handle_t esphome::esp32_touch::ESP32TouchComponent::sens_handle_ {nullptr}

protected

Definition at line 126 of file esp32_touch.h.

◆ setup_mode_

bool esphome::esp32_touch::ESP32TouchComponent::setup_mode_ {false}

protected

Definition at line 122 of file esp32_touch.h.

◆ setup_mode_last_log_print_

uint32_t esphome::esp32_touch::ESP32TouchComponent::setup_mode_last_log_print_ {0}

protected

Definition at line 123 of file esp32_touch.h.

◆ smooth_level_

touch_smooth_filter_mode_t esphome::esp32_touch::ESP32TouchComponent::smooth_level_ {TOUCH_SMOOTH_NO_FILTER}

protected

Definition at line 157 of file esp32_touch.h.

◆ touch_queue_

QueueHandle_t esphome::esp32_touch::ESP32TouchComponent::touch_queue_ {nullptr}

protected

Definition at line 127 of file esp32_touch.h.

◆ waterproof_configured_

bool esphome::esp32_touch::ESP32TouchComponent::waterproof_configured_ {false}

protected

Definition at line 170 of file esp32_touch.h.

◆ waterproof_guard_ring_pad_

int esphome::esp32_touch::ESP32TouchComponent::waterproof_guard_ring_pad_ {-1}

protected

Definition at line 168 of file esp32_touch.h.

◆ waterproof_shield_driver_

uint32_t esphome::esp32_touch::ESP32TouchComponent::waterproof_shield_driver_ {0}

protected

Definition at line 169 of file esp32_touch.h.

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

esphome/components/esp32_touch/esp32_touch.h
esphome/components/esp32_touch/esp32_touch.cpp

Data Structures

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ cleanup_touch_queue_()

◆ configure_wakeup_pads_()

◆ create_touch_queue_()

◆ dump_config()

◆ iir_filter_enabled_()

◆ loop()

◆ on_active_cb()

◆ on_inactive_cb()

◆ on_shutdown()

◆ process_setup_mode_logging_()

◆ publish_initial_state_if_needed_()

◆ register_touch_pad()

◆ set_charge_duration_ms()

◆ set_charge_times()

◆ set_debounce_count()

◆ set_denoise_cap()

◆ set_denoise_grade()

◆ set_filter_mode()

◆ set_high_voltage_reference()

◆ set_iir_filter()

◆ set_jitter_step()

◆ set_low_voltage_reference()

◆ set_meas_interval_us()

◆ set_noise_threshold()

◆ set_setup_mode()

◆ set_smooth_level()

◆ set_waterproof_guard_ring_pad()

◆ set_waterproof_shield_driver()

◆ setup()

Field Documentation

◆ charge_duration_ms_

◆ charge_times_

◆ children_

◆ debounce_count_

◆ denoise_cap_level_

◆ denoise_configured_

◆ denoise_grade_

◆ filter_configured_

◆ filter_mode_

◆ high_voltage_reference_

◆ iir_filter_

◆ jitter_step_

◆ low_voltage_reference_

◆ meas_interval_us_

◆ noise_threshold_

◆ sens_handle_

◆ setup_mode_

◆ setup_mode_last_log_print_

◆ smooth_level_

◆ touch_queue_

◆ waterproof_configured_

◆ waterproof_guard_ring_pad_

◆ waterproof_shield_driver_