ESPHome  2024.12.2
Public Member Functions | Protected Member Functions | Protected Attributes
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 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)
 
uint32_t component_touch_pad_read (touch_pad_t tp)
 
void setup () override
 
void dump_config () override
 
void loop () override
 
float get_setup_priority () const override
 
void on_shutdown () override
 
- 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(). More...
 
void call ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
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. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 

Protected Member Functions

bool filter_configured_ () const
 
bool denoise_configured_ () const
 
bool waterproof_configured_ () const
 
bool iir_filter_enabled_ () const
 
- 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. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
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. More...
 
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. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. More...
 

Protected Attributes

std::vector< ESP32TouchBinarySensor * > children_
 
bool setup_mode_ {false}
 
uint32_t setup_mode_last_log_print_ {0}
 
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}
 
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}
 
uint32_t iir_filter_ {0}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 

Detailed Description

Definition at line 18 of file esp32_touch.h.

Member Function Documentation

◆ component_touch_pad_read()

uint32_t esphome::esp32_touch::ESP32TouchComponent::component_touch_pad_read ( touch_pad_t  tp)

Definition at line 266 of file esp32_touch.cpp.

◆ denoise_configured_()

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

Definition at line 64 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.cpp.

◆ filter_configured_()

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

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

◆ iir_filter_enabled_()

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

Definition at line 72 of file esp32_touch.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 285 of file esp32_touch.cpp.

◆ on_shutdown()

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

Reimplemented from esphome::Component.

Definition at line 310 of file esp32_touch.cpp.

◆ register_touch_pad()

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

Definition at line 20 of file esp32_touch.h.

◆ set_debounce_count()

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

Definition at line 36 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 41 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 40 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 35 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 28 of file esp32_touch.h.

◆ set_iir_filter()

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

Definition at line 47 of file esp32_touch.h.

◆ set_jitter_step()

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

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

◆ set_measurement_duration()

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

Definition at line 24 of file esp32_touch.h.

◆ set_noise_threshold()

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

Definition at line 37 of file esp32_touch.h.

◆ set_setup_mode()

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

Definition at line 22 of file esp32_touch.h.

◆ set_sleep_duration()

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

Definition at line 23 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 39 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 31 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 42 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 43 of file esp32_touch.h.

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 15 of file esp32_touch.cpp.

◆ waterproof_configured_()

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

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

◆ children_

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

Definition at line 75 of file esp32_touch.h.

◆ debounce_count_

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

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

◆ grade_

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

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

◆ iir_filter_

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

Definition at line 95 of file esp32_touch.h.

◆ jitter_step_

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

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

◆ meas_cycle_

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

Definition at line 80 of file esp32_touch.h.

◆ noise_threshold_

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

Definition at line 87 of file esp32_touch.h.

◆ setup_mode_

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

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

◆ sleep_cycle_

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

Definition at line 79 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 89 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 83 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 92 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 93 of file esp32_touch.h.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.13