Simple helper class to expose a touch pad value as a binary sensor. More...

#include <esp32_touch.h>

Inheritance diagram for esphome::esp32_touch::ESP32TouchBinarySensor:

Public Member Functions
	ESP32TouchBinarySensor (touch_pad_t touch_pad, uint32_t threshold, uint32_t wakeup_threshold)

touch_pad_t	get_touch_pad () const

uint32_t	get_threshold () const

void	set_threshold (uint32_t threshold)

uint32_t	get_value () const

uint32_t	get_wakeup_threshold () const

Public Member Functions inherited from esphome::binary_sensor::BinarySensor
	BinarySensor ()

void	add_on_state_callback (std::function< void(bool)> &&callback)
	Add a callback to be notified of state changes. More...

void	publish_state (bool state)
	Publish a new state to the front-end. More...

void	publish_initial_state (bool state)
	Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot. More...

void	add_filter (Filter *filter)

void	add_filters (const std::vector< Filter *> &filters)

void	set_publish_initial_state (bool publish_initial_state)

void	send_state_internal (bool state, bool is_initial)

virtual bool	has_state () const
	Return whether this binary sensor has outputted a state. More...

virtual bool	is_status_binary_sensor () const

Public Member Functions inherited from esphome::EntityBase
const StringRef &	get_name () const

void	set_name (const char *name)

bool	has_own_name () const

std::string	get_object_id () const

void	set_object_id (const char *object_id)

uint32_t	get_object_id_hash ()

bool	is_internal () const

void	set_internal (bool internal)

bool	is_disabled_by_default () const

void	set_disabled_by_default (bool disabled_by_default)

EntityCategory	get_entity_category () const

void	set_entity_category (EntityCategory entity_category)

std::string	get_icon () const

void	set_icon (const char *icon)

Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string	get_device_class ()
	Get the device class, using the manual override if set. More...

void	set_device_class (const char *device_class)
	Manually set the device class. More...

Protected Attributes
friend	ESP32TouchComponent

touch_pad_t	touch_pad_ {TOUCH_PAD_MAX}

uint32_t	threshold_ {0}

uint32_t	value_ {0}

const uint32_t	wakeup_threshold_ {0}

Protected Attributes inherited from esphome::binary_sensor::BinarySensor
CallbackManager< void(bool)>	state_callback_ {}

Filter *	filter_list_ {nullptr}

bool	has_state_ {false}

bool	publish_initial_state_ {false}

Deduplicator< bool >	publish_dedup_

Protected Attributes inherited from esphome::EntityBase
StringRef	name_

const char *	object_id_c_str_ {nullptr}

const char *	icon_c_str_ {nullptr}

uint32_t	object_id_hash_

bool	has_own_name_ {false}

bool	internal_ {false}

bool	disabled_by_default_ {false}

EntityCategory	entity_category_ {ENTITY_CATEGORY_NONE}

Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char *	device_class_ {nullptr}
	Device class override. More...

Additional Inherited Members
Data Fields inherited from esphome::binary_sensor::BinarySensor
bool	state {false}
	The current reported state of the binary sensor. More...

Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t	hash_base ()
	The hash_base() function has been deprecated. More...

void	calc_object_id_ ()

Detailed Description

Simple helper class to expose a touch pad value as a binary sensor.

Definition at line 100 of file esp32_touch.h.

Constructor & Destructor Documentation

◆ ESP32TouchBinarySensor()

esphome::esp32_touch::ESP32TouchBinarySensor::ESP32TouchBinarySensor	(	touch_pad_t	touch_pad,
		uint32_t	threshold,
		uint32_t	wakeup_threshold
	)

Definition at line 340 of file esp32_touch.cpp.

Member Function Documentation

◆ get_threshold()

uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::get_threshold ( ) const

inline

Definition at line 105 of file esp32_touch.h.

◆ get_touch_pad()

touch_pad_t esphome::esp32_touch::ESP32TouchBinarySensor::get_touch_pad ( ) const

inline

Definition at line 104 of file esp32_touch.h.

◆ get_value()

uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::get_value ( ) const

inline

Definition at line 107 of file esp32_touch.h.

◆ get_wakeup_threshold()

uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::get_wakeup_threshold ( ) const

inline

Definition at line 108 of file esp32_touch.h.

◆ set_threshold()

void esphome::esp32_touch::ESP32TouchBinarySensor::set_threshold ( uint32_t threshold )

inline

Definition at line 106 of file esp32_touch.h.

Field Documentation

◆ ESP32TouchComponent

friend esphome::esp32_touch::ESP32TouchBinarySensor::ESP32TouchComponent

protected

Definition at line 111 of file esp32_touch.h.

◆ threshold_

uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::threshold_ {0}

protected

Definition at line 114 of file esp32_touch.h.

◆ touch_pad_

touch_pad_t esphome::esp32_touch::ESP32TouchBinarySensor::touch_pad_ {TOUCH_PAD_MAX}

protected

Definition at line 113 of file esp32_touch.h.

◆ value_

uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::value_ {0}

protected

Definition at line 115 of file esp32_touch.h.

◆ wakeup_threshold_

const uint32_t esphome::esp32_touch::ESP32TouchBinarySensor::wakeup_threshold_ {0}

protected

Definition at line 116 of file esp32_touch.h.

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

/opt/build/esphome/esphome/components/esp32_touch/esp32_touch.h
/opt/build/esphome/esphome/components/esp32_touch/esp32_touch.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ESP32TouchBinarySensor()

Member Function Documentation

◆ get_threshold()

◆ get_touch_pad()

◆ get_value()

◆ get_wakeup_threshold()

◆ set_threshold()

Field Documentation

◆ ESP32TouchComponent

◆ threshold_

◆ touch_pad_

◆ value_

◆ wakeup_threshold_