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, uint16_t threshold, uint16_t wakeup_threshold) | |
| touch_pad_t | get_touch_pad () const |
| uint16_t | get_threshold () const |
| void | set_threshold (uint16_t threshold) |
| uint16_t | get_value () const |
| uint16_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 | set_device_class (const std::string &device_class) |
| Manually set the Home Assistant device class (see binary_sensor::device_class) More... | |
| std::string | get_device_class () |
| Get the device class for this binary sensor, using the manual override if specified. 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 |
| virtual std::string | device_class () |
| Override this to set the default device class. More... | |
| Public Member Functions inherited from esphome::EntityBase | |
| EntityBase () | |
| EntityBase (std::string name) | |
| const std::string & | get_name () const |
| void | set_name (const std::string &name) |
| const std::string & | get_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) |
| const std::string & | get_icon () const |
| void | set_icon (const std::string &name) |
Protected Attributes | |
| friend | ESP32TouchComponent |
| touch_pad_t | touch_pad_ |
| uint16_t | threshold_ |
| uint16_t | value_ |
| const uint16_t | wakeup_threshold_ |
| Protected Attributes inherited from esphome::binary_sensor::BinarySensor | |
| CallbackManager< void(bool)> | state_callback_ {} |
| optional< std::string > | device_class_ {} |
| Stores the override of the device class. More... | |
| Filter * | filter_list_ {nullptr} |
| bool | has_state_ {false} |
| bool | publish_initial_state_ {false} |
| Deduplicator< bool > | publish_dedup_ |
| Protected Attributes inherited from esphome::EntityBase | |
| std::string | name_ |
| std::string | object_id_ |
| std::string | icon_ |
| uint32_t | object_id_hash_ |
| bool | internal_ {false} |
| bool | disabled_by_default_ {false} |
| EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
Additional Inherited Members | |
| Data Fields inherited from esphome::binary_sensor::BinarySensor | |
| bool | state |
| 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 67 of file esp32_touch.h.
Constructor & Destructor Documentation
◆ ESP32TouchBinarySensor()
| esphome::esp32_touch::ESP32TouchBinarySensor::ESP32TouchBinarySensor | ( | touch_pad_t | touch_pad, |
| uint16_t | threshold, | ||
| uint16_t | wakeup_threshold | ||
| ) |
Definition at line 164 of file esp32_touch.cpp.
Member Function Documentation
◆ get_threshold()
|
inline |
Definition at line 72 of file esp32_touch.h.
◆ get_touch_pad()
|
inline |
Definition at line 71 of file esp32_touch.h.
◆ get_value()
|
inline |
Definition at line 74 of file esp32_touch.h.
◆ get_wakeup_threshold()
|
inline |
Definition at line 75 of file esp32_touch.h.
◆ set_threshold()
|
inline |
Definition at line 73 of file esp32_touch.h.
Field Documentation
◆ ESP32TouchComponent
|
protected |
Definition at line 78 of file esp32_touch.h.
◆ threshold_
|
protected |
Definition at line 81 of file esp32_touch.h.
◆ touch_pad_
|
protected |
Definition at line 80 of file esp32_touch.h.
◆ value_
|
protected |
Definition at line 82 of file esp32_touch.h.
◆ wakeup_threshold_
|
protected |
Definition at line 83 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
