ESPHome 2025.7.3
Loading...
Searching...
No Matches
esphome::esp32_touch::ESP32TouchComponent Class Reference

#include <esp32_touch.h>

Inheritance diagram for esphome::esp32_touch::ESP32TouchComponent:
esphome::Component

Public Member Functions

void register_touch_pad (ESP32TouchBinarySensor *pad)
 
void set_setup_mode (bool setup_mode)
 
void set_sleep_duration (uint16_t sleep_duration)
 
void set_measurement_duration (uint16_t meas_cycle)
 
void set_low_voltage_reference (touch_low_volt_t low_voltage_reference)
 
void set_high_voltage_reference (touch_high_volt_t high_voltage_reference)
 
void set_voltage_attenuation (touch_volt_atten_t voltage_attenuation)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void on_shutdown () override
 
void set_filter_mode (touch_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_mode_t smooth_level)
 
void set_denoise_grade (touch_pad_denoise_grade_t denoise_grade)
 
void set_denoise_cap (touch_pad_denoise_cap_t cap_level)
 
void set_waterproof_guard_ring_pad (touch_pad_t pad)
 
void set_waterproof_shield_driver (touch_pad_shield_driver_t drive_capability)
 
void set_iir_filter (uint32_t iir_filter)
 
- Public Member Functions inherited from esphome::Component
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.
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *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="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages.
 
const char * get_component_source () const
 Get the integration where this component was declared as a string.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 

Protected Member Functions

void dump_config_base_ ()
 
void dump_config_sensors_ ()
 
bool create_touch_queue_ ()
 
void cleanup_touch_queue_ ()
 
void configure_wakeup_pads_ ()
 
void process_setup_mode_logging_ (uint32_t now)
 
bool should_check_for_releases_ (uint32_t now)
 
void publish_initial_state_if_needed_ (ESP32TouchBinarySensor *child, uint32_t now)
 
void check_and_disable_loop_if_all_released_ (size_t pads_off)
 
void calculate_release_timeout_ ()
 
bool iir_filter_enabled_ () const
 
bool filter_configured_ () const
 
bool denoise_configured_ () const
 
bool waterproof_configured_ () const
 
uint32_t read_touch_value (touch_pad_t pad) const
 
void update_touch_state_ (ESP32TouchBinarySensor *child, bool is_touched)
 
bool check_and_update_touch_state_ (ESP32TouchBinarySensor *child)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
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 interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
bool cancel_interval (const char *name)
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name.
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
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 timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
bool cancel_timeout (const char *name)
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
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.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Static Protected Member Functions

static void touch_isr_handler (void *arg)
 
static void touch_isr_handler (void *arg)
 
static const char * get_low_voltage_reference_str (touch_low_volt_t ref)
 
static const char * get_high_voltage_reference_str (touch_high_volt_t ref)
 
static const char * get_voltage_attenuation_str (touch_volt_atten_t atten)
 

Protected Attributes

std::vector< ESP32TouchBinarySensor * > children_
 
bool setup_mode_ {false}
 
uint32_t setup_mode_last_log_print_ {0}
 
uint32_t last_release_check_ {0}
 
uint32_t release_timeout_ms_ {1500}
 
uint32_t release_check_interval_ms_ {50}
 
uint16_t sleep_cycle_ {4095}
 
uint16_t meas_cycle_ {65535}
 
touch_low_volt_t low_voltage_reference_ {TOUCH_LVOLT_0V5}
 
touch_high_volt_t high_voltage_reference_ {TOUCH_HVOLT_2V7}
 
touch_volt_atten_t voltage_attenuation_ {TOUCH_HVOLT_ATTEN_0V}
 
QueueHandle_t touch_queue_ {nullptr}
 
uint32_t iir_filter_ {0}
 
touch_filter_mode_t filter_mode_ {TOUCH_PAD_FILTER_MAX}
 
uint32_t debounce_count_ {0}
 
uint32_t noise_threshold_ {0}
 
uint32_t jitter_step_ {0}
 
touch_smooth_mode_t smooth_level_ {TOUCH_PAD_SMOOTH_MAX}
 
touch_pad_denoise_grade_t grade_ {TOUCH_PAD_DENOISE_MAX}
 
touch_pad_denoise_cap_t cap_level_ {TOUCH_PAD_DENOISE_CAP_MAX}
 
touch_pad_t waterproof_guard_ring_pad_ {TOUCH_PAD_MAX}
 
touch_pad_shield_driver_t waterproof_shield_driver_ {TOUCH_PAD_SHIELD_DRV_MAX}
 
- Protected Attributes inherited from esphome::Component
const char * 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-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free)
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 

Static Protected Attributes

static constexpr uint32_t MINIMUM_RELEASE_TIME_MS = 100
 

Detailed Description

Definition at line 34 of file esp32_touch.h.

Member Function Documentation

◆ calculate_release_timeout_()

void esphome::esp32_touch::ESP32TouchComponent::calculate_release_timeout_ ( )
protected

Definition at line 136 of file esp32_touch_common.cpp.

◆ check_and_disable_loop_if_all_released_()

void esphome::esp32_touch::ESP32TouchComponent::check_and_disable_loop_if_all_released_ ( size_t pads_off)
protected

Definition at line 129 of file esp32_touch_common.cpp.

◆ check_and_update_touch_state_()

bool esphome::esp32_touch::ESP32TouchComponent::check_and_update_touch_state_ ( ESP32TouchBinarySensor * child)
protected

Definition at line 34 of file esp32_touch_v2.cpp.

◆ cleanup_touch_queue_()

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

Definition at line 63 of file esp32_touch_common.cpp.

◆ configure_wakeup_pads_()

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

Definition at line 70 of file esp32_touch_common.cpp.

◆ create_touch_queue_()

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

Definition at line 42 of file esp32_touch_common.cpp.

◆ denoise_configured_()

bool esphome::esp32_touch::ESP32TouchComponent::denoise_configured_ ( ) const
inlineprotected

Definition at line 161 of file esp32_touch.h.

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 72 of file esp32_touch_v1.cpp.

◆ dump_config_base_()

void esphome::esp32_touch::ESP32TouchComponent::dump_config_base_ ( )
protected

Definition at line 14 of file esp32_touch_common.cpp.

◆ dump_config_sensors_()

void esphome::esp32_touch::ESP32TouchComponent::dump_config_sensors_ ( )
protected

Definition at line 31 of file esp32_touch_common.cpp.

◆ filter_configured_()

bool esphome::esp32_touch::ESP32TouchComponent::filter_configured_ ( ) const
inlineprotected

Definition at line 158 of file esp32_touch.h.

◆ get_high_voltage_reference_str()

static const char * esphome::esp32_touch::ESP32TouchComponent::get_high_voltage_reference_str ( touch_high_volt_t ref)
inlinestaticprotected

Definition at line 197 of file esp32_touch.h.

◆ get_low_voltage_reference_str()

static const char * esphome::esp32_touch::ESP32TouchComponent::get_low_voltage_reference_str ( touch_low_volt_t ref)
inlinestaticprotected

Definition at line 182 of file esp32_touch.h.

◆ get_setup_priority()

float esphome::esp32_touch::ESP32TouchComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 54 of file esp32_touch.h.

◆ get_voltage_attenuation_str()

static const char * esphome::esp32_touch::ESP32TouchComponent::get_voltage_attenuation_str ( touch_volt_atten_t atten)
inlinestaticprotected

Definition at line 212 of file esp32_touch.h.

◆ iir_filter_enabled_()

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

Definition at line 127 of file esp32_touch.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 88 of file esp32_touch_v1.cpp.

◆ on_shutdown()

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

Reimplemented from esphome::Component.

Definition at line 168 of file esp32_touch_v1.cpp.

◆ process_setup_mode_logging_()

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

Definition at line 94 of file esp32_touch_common.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 118 of file esp32_touch_common.cpp.

◆ read_touch_value()

uint32_t esphome::esp32_touch::ESP32TouchComponent::read_touch_value ( touch_pad_t pad) const
protected

Definition at line 379 of file esp32_touch_v2.cpp.

◆ register_touch_pad()

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

Definition at line 36 of file esp32_touch.h.

◆ set_debounce_count()

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

Definition at line 60 of file esp32_touch.h.

◆ set_denoise_cap()

void esphome::esp32_touch::ESP32TouchComponent::set_denoise_cap ( touch_pad_denoise_cap_t cap_level)
inline

Definition at line 65 of file esp32_touch.h.

◆ set_denoise_grade()

void esphome::esp32_touch::ESP32TouchComponent::set_denoise_grade ( touch_pad_denoise_grade_t denoise_grade)
inline

Definition at line 64 of file esp32_touch.h.

◆ set_filter_mode()

void esphome::esp32_touch::ESP32TouchComponent::set_filter_mode ( touch_filter_mode_t filter_mode)
inline

Definition at line 59 of file esp32_touch.h.

◆ set_high_voltage_reference()

void esphome::esp32_touch::ESP32TouchComponent::set_high_voltage_reference ( touch_high_volt_t high_voltage_reference)
inline

Definition at line 44 of file esp32_touch.h.

◆ set_iir_filter()

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

Definition at line 71 of file esp32_touch.h.

◆ set_jitter_step()

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

Definition at line 62 of file esp32_touch.h.

◆ set_low_voltage_reference()

void esphome::esp32_touch::ESP32TouchComponent::set_low_voltage_reference ( touch_low_volt_t low_voltage_reference)
inline

Definition at line 41 of file esp32_touch.h.

◆ set_measurement_duration()

void esphome::esp32_touch::ESP32TouchComponent::set_measurement_duration ( uint16_t meas_cycle)
inline

Definition at line 40 of file esp32_touch.h.

◆ set_noise_threshold()

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

Definition at line 61 of file esp32_touch.h.

◆ set_setup_mode()

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

Definition at line 38 of file esp32_touch.h.

◆ set_sleep_duration()

void esphome::esp32_touch::ESP32TouchComponent::set_sleep_duration ( uint16_t sleep_duration)
inline

Definition at line 39 of file esp32_touch.h.

◆ set_smooth_level()

void esphome::esp32_touch::ESP32TouchComponent::set_smooth_level ( touch_smooth_mode_t smooth_level)
inline

Definition at line 63 of file esp32_touch.h.

◆ set_voltage_attenuation()

void esphome::esp32_touch::ESP32TouchComponent::set_voltage_attenuation ( touch_volt_atten_t voltage_attenuation)
inline

Definition at line 47 of file esp32_touch.h.

◆ set_waterproof_guard_ring_pad()

void esphome::esp32_touch::ESP32TouchComponent::set_waterproof_guard_ring_pad ( touch_pad_t pad)
inline

Definition at line 66 of file esp32_touch.h.

◆ set_waterproof_shield_driver()

void esphome::esp32_touch::ESP32TouchComponent::set_waterproof_shield_driver ( touch_pad_shield_driver_t drive_capability)
inline

Definition at line 67 of file esp32_touch.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 21 of file esp32_touch_v1.cpp.

◆ should_check_for_releases_()

bool esphome::esp32_touch::ESP32TouchComponent::should_check_for_releases_ ( uint32_t now)
protected

Definition at line 110 of file esp32_touch_common.cpp.

◆ touch_isr_handler() [1/2]

void IRAM_ATTR esphome::esp32_touch::ESP32TouchComponent::touch_isr_handler ( void * arg)
staticprotected

Definition at line 182 of file esp32_touch_v1.cpp.

◆ touch_isr_handler() [2/2]

static void esphome::esp32_touch::ESP32TouchComponent::touch_isr_handler ( void * arg)
staticprotected

◆ update_touch_state_()

void esphome::esp32_touch::ESP32TouchComponent::update_touch_state_ ( ESP32TouchBinarySensor * child,
bool is_touched )
protected

Definition at line 14 of file esp32_touch_v2.cpp.

◆ waterproof_configured_()

bool esphome::esp32_touch::ESP32TouchComponent::waterproof_configured_ ( ) const
inlineprotected

Definition at line 164 of file esp32_touch.h.

Field Documentation

◆ cap_level_

touch_pad_denoise_cap_t esphome::esp32_touch::ESP32TouchComponent::cap_level_ {TOUCH_PAD_DENOISE_CAP_MAX}
protected

Definition at line 152 of file esp32_touch.h.

◆ children_

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

Definition at line 90 of file esp32_touch.h.

◆ debounce_count_

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

Definition at line 145 of file esp32_touch.h.

◆ filter_mode_

touch_filter_mode_t esphome::esp32_touch::ESP32TouchComponent::filter_mode_ {TOUCH_PAD_FILTER_MAX}
protected

Definition at line 144 of file esp32_touch.h.

◆ grade_

touch_pad_denoise_grade_t esphome::esp32_touch::ESP32TouchComponent::grade_ {TOUCH_PAD_DENOISE_MAX}
protected

Definition at line 151 of file esp32_touch.h.

◆ high_voltage_reference_

touch_high_volt_t esphome::esp32_touch::ESP32TouchComponent::high_voltage_reference_ {TOUCH_HVOLT_2V7}
protected

Definition at line 101 of file esp32_touch.h.

◆ iir_filter_

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

Definition at line 125 of file esp32_touch.h.

◆ jitter_step_

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

Definition at line 147 of file esp32_touch.h.

◆ last_release_check_

uint32_t esphome::esp32_touch::ESP32TouchComponent::last_release_check_ {0}
protected

Definition at line 93 of file esp32_touch.h.

◆ low_voltage_reference_

touch_low_volt_t esphome::esp32_touch::ESP32TouchComponent::low_voltage_reference_ {TOUCH_LVOLT_0V5}
protected

Definition at line 100 of file esp32_touch.h.

◆ meas_cycle_

uint16_t esphome::esp32_touch::ESP32TouchComponent::meas_cycle_ {65535}
protected

Definition at line 99 of file esp32_touch.h.

◆ MINIMUM_RELEASE_TIME_MS

uint32_t esphome::esp32_touch::ESP32TouchComponent::MINIMUM_RELEASE_TIME_MS = 100
staticconstexprprotected

Definition at line 105 of file esp32_touch.h.

◆ noise_threshold_

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

Definition at line 146 of file esp32_touch.h.

◆ release_check_interval_ms_

uint32_t esphome::esp32_touch::ESP32TouchComponent::release_check_interval_ms_ {50}
protected

Definition at line 95 of file esp32_touch.h.

◆ release_timeout_ms_

uint32_t esphome::esp32_touch::ESP32TouchComponent::release_timeout_ms_ {1500}
protected

Definition at line 94 of file esp32_touch.h.

◆ setup_mode_

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

Definition at line 91 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 92 of file esp32_touch.h.

◆ sleep_cycle_

uint16_t esphome::esp32_touch::ESP32TouchComponent::sleep_cycle_ {4095}
protected

Definition at line 98 of file esp32_touch.h.

◆ smooth_level_

touch_smooth_mode_t esphome::esp32_touch::ESP32TouchComponent::smooth_level_ {TOUCH_PAD_SMOOTH_MAX}
protected

Definition at line 148 of file esp32_touch.h.

◆ touch_queue_

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

Definition at line 113 of file esp32_touch.h.

◆ voltage_attenuation_

touch_volt_atten_t esphome::esp32_touch::ESP32TouchComponent::voltage_attenuation_ {TOUCH_HVOLT_ATTEN_0V}
protected

Definition at line 102 of file esp32_touch.h.

◆ waterproof_guard_ring_pad_

touch_pad_t esphome::esp32_touch::ESP32TouchComponent::waterproof_guard_ring_pad_ {TOUCH_PAD_MAX}
protected

Definition at line 155 of file esp32_touch.h.

◆ waterproof_shield_driver_

touch_pad_shield_driver_t esphome::esp32_touch::ESP32TouchComponent::waterproof_shield_driver_ {TOUCH_PAD_SHIELD_DRV_MAX}
protected

Definition at line 156 of file esp32_touch.h.


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