ESPHome  2024.5.3
Public Member Functions | Protected Attributes
esphome::touchscreen::TouchscreenBinarySensor Class Reference

#include <touchscreen_binary_sensor.h>

Inheritance diagram for esphome::touchscreen::TouchscreenBinarySensor:
esphome::binary_sensor::BinarySensor esphome::Component esphome::touchscreen::TouchListener esphome::Parented< Touchscreen > esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void setup () override
 
void set_area (int16_t x_min, int16_t x_max, int16_t y_min, int16_t y_max)
 Set the touch screen area where the button will detect the touch. More...
 
int16_t get_x_min ()
 
int16_t get_x_max ()
 
int16_t get_y_min ()
 
int16_t get_y_max ()
 
int16_t get_width ()
 
int16_t get_height ()
 
void set_page (display::DisplayPage *page)
 
void touch (TouchPoint tp) override
 
void release () override
 
- 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 StringRefget_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...
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly. More...
 
virtual void dump_config ()
 
virtual float get_setup_priority () const
 priority of setup(). More...
 
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_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed ()
 
bool is_ready ()
 
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...
 
- Public Member Functions inherited from esphome::touchscreen::TouchListener
virtual void update (const TouchPoints_t &tpoints)
 
- Public Member Functions inherited from esphome::Parented< Touchscreen >
 Parented ()
 
 Parented (Touchscreen *parent)
 
Touchscreen * get_parent () const
 Get the parent of this object. More...
 
void set_parent (Touchscreen *parent)
 Set the parent of this object. More...
 

Protected Attributes

int16_t x_min_
 
int16_t x_max_
 
int16_t y_min_
 
int16_t y_max_
 
display::DisplayPagepage_ {nullptr}
 
- Protected Attributes inherited from esphome::binary_sensor::BinarySensor
CallbackManager< void(bool)> state_callback_ {}
 
Filterfilter_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...
 
- 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}
 
- Protected Attributes inherited from esphome::Parented< Touchscreen >
Touchscreen * parent_
 

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_ ()
 
- 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...
 

Detailed Description

Definition at line 12 of file touchscreen_binary_sensor.h.

Member Function Documentation

◆ get_height()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_height ( )
inline

Definition at line 31 of file touchscreen_binary_sensor.h.

◆ get_width()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_width ( )
inline

Definition at line 30 of file touchscreen_binary_sensor.h.

◆ get_x_max()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_x_max ( )
inline

Definition at line 27 of file touchscreen_binary_sensor.h.

◆ get_x_min()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_x_min ( )
inline

Definition at line 26 of file touchscreen_binary_sensor.h.

◆ get_y_max()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_y_max ( )
inline

Definition at line 29 of file touchscreen_binary_sensor.h.

◆ get_y_min()

int16_t esphome::touchscreen::TouchscreenBinarySensor::get_y_min ( )
inline

Definition at line 28 of file touchscreen_binary_sensor.h.

◆ release()

void esphome::touchscreen::TouchscreenBinarySensor::release ( )
overridevirtual

Reimplemented from esphome::touchscreen::TouchListener.

Definition at line 24 of file touchscreen_binary_sensor.cpp.

◆ set_area()

void esphome::touchscreen::TouchscreenBinarySensor::set_area ( int16_t  x_min,
int16_t  x_max,
int16_t  y_min,
int16_t  y_max 
)
inline

Set the touch screen area where the button will detect the touch.

Definition at line 20 of file touchscreen_binary_sensor.h.

◆ set_page()

void esphome::touchscreen::TouchscreenBinarySensor::set_page ( display::DisplayPage page)
inline

Definition at line 33 of file touchscreen_binary_sensor.h.

◆ setup()

void esphome::touchscreen::TouchscreenBinarySensor::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 6 of file touchscreen_binary_sensor.cpp.

◆ touch()

void esphome::touchscreen::TouchscreenBinarySensor::touch ( TouchPoint  tp)
overridevirtual

Reimplemented from esphome::touchscreen::TouchListener.

Definition at line 11 of file touchscreen_binary_sensor.cpp.

Field Documentation

◆ page_

display::DisplayPage* esphome::touchscreen::TouchscreenBinarySensor::page_ {nullptr}
protected

Definition at line 40 of file touchscreen_binary_sensor.h.

◆ x_max_

int16_t esphome::touchscreen::TouchscreenBinarySensor::x_max_
protected

Definition at line 39 of file touchscreen_binary_sensor.h.

◆ x_min_

int16_t esphome::touchscreen::TouchscreenBinarySensor::x_min_
protected

Definition at line 39 of file touchscreen_binary_sensor.h.

◆ y_max_

int16_t esphome::touchscreen::TouchscreenBinarySensor::y_max_
protected

Definition at line 39 of file touchscreen_binary_sensor.h.

◆ y_min_

int16_t esphome::touchscreen::TouchscreenBinarySensor::y_min_
protected

Definition at line 39 of file touchscreen_binary_sensor.h.


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