ESPHome  2022.6.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_iir_filter (uint32_t iir_filter)
 
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
 
- 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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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 iir_filter_enabled_ () const
 Is the IIR filter enabled? More...
 
- 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()> &&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()> &&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

uint16_t sleep_cycle_ {}
 
uint16_t meas_cycle_ {65535}
 
touch_low_volt_t low_voltage_reference_ {}
 
touch_high_volt_t high_voltage_reference_ {}
 
touch_volt_atten_t voltage_attenuation_ {}
 
std::vector< ESP32TouchBinarySensor * > children_
 
bool setup_mode_ {false}
 
uint32_t setup_mode_last_log_print_ {}
 
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 20 of file esp32_touch.h.

Member Function Documentation

◆ dump_config()

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

Reimplemented from esphome::Component.

Definition at line 30 of file esp32_touch.cpp.

◆ get_setup_priority()

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

Reimplemented from esphome::Component.

Definition at line 45 of file esp32_touch.h.

◆ iir_filter_enabled_()

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

Is the IIR filter enabled?

Definition at line 51 of file esp32_touch.h.

◆ loop()

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

Reimplemented from esphome::Component.

Definition at line 111 of file esp32_touch.cpp.

◆ on_shutdown()

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

Reimplemented from esphome::Component.

Definition at line 138 of file esp32_touch.cpp.

◆ register_touch_pad()

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

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

◆ set_iir_filter()

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

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

◆ set_measurement_duration()

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

Definition at line 30 of file esp32_touch.h.

◆ set_setup_mode()

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

Definition at line 24 of file esp32_touch.h.

◆ set_sleep_duration()

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

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

◆ setup()

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

Reimplemented from esphome::Component.

Definition at line 13 of file esp32_touch.cpp.

Field Documentation

◆ children_

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

Definition at line 58 of file esp32_touch.h.

◆ high_voltage_reference_

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

Definition at line 56 of file esp32_touch.h.

◆ iir_filter_

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

Definition at line 61 of file esp32_touch.h.

◆ low_voltage_reference_

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

Definition at line 55 of file esp32_touch.h.

◆ meas_cycle_

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

Definition at line 54 of file esp32_touch.h.

◆ setup_mode_

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

Definition at line 59 of file esp32_touch.h.

◆ setup_mode_last_log_print_

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

Definition at line 60 of file esp32_touch.h.

◆ sleep_cycle_

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

Definition at line 53 of file esp32_touch.h.

◆ voltage_attenuation_

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

Definition at line 57 of file esp32_touch.h.


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