ESPHome  2024.6.1
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::touchscreen::Touchscreen Class Referenceabstract

#include <touchscreen.h>

Inheritance diagram for esphome::touchscreen::Touchscreen:
esphome::PollingComponent esphome::Component esphome::cst226::CST226Touchscreen esphome::cst816::CST816Touchscreen esphome::ektf2232::EKTF2232Touchscreen esphome::ft5x06::FT5x06Touchscreen esphome::ft63x6::FT63X6Touchscreen esphome::gt911::GT911Touchscreen esphome::lilygo_t5_47::LilygoT547Touchscreen esphome::sdl::SdlTouchscreen esphome::tt21100::TT21100Touchscreen esphome::xpt2046::XPT2046Component

Public Member Functions

void set_display (display::Display *display)
 
display::Displayget_display () const
 
void set_touch_timeout (uint16_t val)
 
void set_mirror_x (bool invert_x)
 
void set_mirror_y (bool invert_y)
 
void set_swap_xy (bool swap)
 
void set_calibration (int16_t x_min, int16_t x_max, int16_t y_min, int16_t y_max)
 
Trigger< TouchPoint, const TouchPoints_t & > * get_touch_trigger ()
 
Trigger< const TouchPoints_t & > * get_update_trigger ()
 
Triggerget_release_trigger ()
 
void register_listener (TouchListener *listener)
 
optional< TouchPointget_touch ()
 
TouchPoints_t get_touches ()
 
void update () override
 
void loop () override
 
void call_setup () override
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms. More...
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object. More...
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor. More...
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. 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 () 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

void attach_interrupt_ (InternalGPIOPin *irq_pin, esphome::gpio::InterruptType type)
 Call this function to send touch points to the on_touch listener and the binary_sensors. More...
 
void add_raw_touch_position_ (uint8_t id, int16_t x_raw, int16_t y_raw, int16_t z_raw=0)
 
virtual void update_touches ()=0
 
void send_touches_ ()
 
int16_t normalize_ (int16_t val, int16_t min_val, int16_t max_val, bool inverted=false)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
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

display::Displaydisplay_ {nullptr}
 
int16_t x_raw_min_ {0}
 
int16_t x_raw_max_ {0}
 
int16_t y_raw_min_ {0}
 
int16_t y_raw_max_ {0}
 
int16_t display_width_ {0}
 
int16_t display_height_ {0}
 
uint16_t touch_timeout_ {0}
 
bool invert_x_ {false}
 
bool invert_y_ {false}
 
bool swap_x_y_ {false}
 
Trigger< TouchPoint, const TouchPoints_t & > touch_trigger_
 
Trigger< const TouchPoints_t & > update_trigger_
 
Trigger release_trigger_
 
std::vector< TouchListener * > touch_listeners_
 
std::map< uint8_t, TouchPointtouches_
 
TouchscreenInterrupt store_
 
bool first_touch_ {true}
 
bool need_update_ {false}
 
bool is_touched_ {false}
 
bool was_touched_ {false}
 
bool skip_update_ {false}
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- 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 45 of file touchscreen.h.

Member Function Documentation

◆ add_raw_touch_position_()

void esphome::touchscreen::Touchscreen::add_raw_touch_position_ ( uint8_t  id,
int16_t  x_raw,
int16_t  y_raw,
int16_t  z_raw = 0 
)
protected

Definition at line 74 of file touchscreen.cpp.

◆ attach_interrupt_()

void esphome::touchscreen::Touchscreen::attach_interrupt_ ( InternalGPIOPin irq_pin,
esphome::gpio::InterruptType  type 
)
protected

Call this function to send touch points to the on_touch listener and the binary_sensors.

Definition at line 12 of file touchscreen.cpp.

◆ call_setup()

void esphome::touchscreen::Touchscreen::call_setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 19 of file touchscreen.cpp.

◆ get_display()

display::Display* esphome::touchscreen::Touchscreen::get_display ( ) const
inline

Definition at line 48 of file touchscreen.h.

◆ get_release_trigger()

Trigger* esphome::touchscreen::Touchscreen::get_release_trigger ( )
inline

Definition at line 68 of file touchscreen.h.

◆ get_touch()

optional<TouchPoint> esphome::touchscreen::Touchscreen::get_touch ( )
inline

Definition at line 72 of file touchscreen.h.

◆ get_touch_trigger()

Trigger<TouchPoint, const TouchPoints_t &>* esphome::touchscreen::Touchscreen::get_touch_trigger ( )
inline

Definition at line 66 of file touchscreen.h.

◆ get_touches()

TouchPoints_t esphome::touchscreen::Touchscreen::get_touches ( )
inline

Definition at line 74 of file touchscreen.h.

◆ get_update_trigger()

Trigger<const TouchPoints_t &>* esphome::touchscreen::Touchscreen::get_update_trigger ( )
inline

Definition at line 67 of file touchscreen.h.

◆ loop()

void esphome::touchscreen::Touchscreen::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 37 of file touchscreen.cpp.

◆ normalize_()

int16_t esphome::touchscreen::Touchscreen::normalize_ ( int16_t  val,
int16_t  min_val,
int16_t  max_val,
bool  inverted = false 
)
protected

Definition at line 148 of file touchscreen.cpp.

◆ register_listener()

void esphome::touchscreen::Touchscreen::register_listener ( TouchListener listener)
inline

Definition at line 70 of file touchscreen.h.

◆ send_touches_()

void esphome::touchscreen::Touchscreen::send_touches_ ( )
protected

Definition at line 115 of file touchscreen.cpp.

◆ set_calibration()

void esphome::touchscreen::Touchscreen::set_calibration ( int16_t  x_min,
int16_t  x_max,
int16_t  y_min,
int16_t  y_max 
)
inline

Definition at line 55 of file touchscreen.h.

◆ set_display()

void esphome::touchscreen::Touchscreen::set_display ( display::Display display)
inline

Definition at line 47 of file touchscreen.h.

◆ set_mirror_x()

void esphome::touchscreen::Touchscreen::set_mirror_x ( bool  invert_x)
inline

Definition at line 51 of file touchscreen.h.

◆ set_mirror_y()

void esphome::touchscreen::Touchscreen::set_mirror_y ( bool  invert_y)
inline

Definition at line 52 of file touchscreen.h.

◆ set_swap_xy()

void esphome::touchscreen::Touchscreen::set_swap_xy ( bool  swap)
inline

Definition at line 53 of file touchscreen.h.

◆ set_touch_timeout()

void esphome::touchscreen::Touchscreen::set_touch_timeout ( uint16_t  val)
inline

Definition at line 50 of file touchscreen.h.

◆ update()

void esphome::touchscreen::Touchscreen::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 27 of file touchscreen.cpp.

◆ update_touches()

virtual void esphome::touchscreen::Touchscreen::update_touches ( )
protectedpure virtual

Field Documentation

◆ display_

display::Display* esphome::touchscreen::Touchscreen::display_ {nullptr}
protected

Definition at line 99 of file touchscreen.h.

◆ display_height_

int16_t esphome::touchscreen::Touchscreen::display_height_ {0}
protected

Definition at line 102 of file touchscreen.h.

◆ display_width_

int16_t esphome::touchscreen::Touchscreen::display_width_ {0}
protected

Definition at line 102 of file touchscreen.h.

◆ first_touch_

bool esphome::touchscreen::Touchscreen::first_touch_ {true}
protected

Definition at line 115 of file touchscreen.h.

◆ invert_x_

bool esphome::touchscreen::Touchscreen::invert_x_ {false}
protected

Definition at line 105 of file touchscreen.h.

◆ invert_y_

bool esphome::touchscreen::Touchscreen::invert_y_ {false}
protected

Definition at line 105 of file touchscreen.h.

◆ is_touched_

bool esphome::touchscreen::Touchscreen::is_touched_ {false}
protected

Definition at line 117 of file touchscreen.h.

◆ need_update_

bool esphome::touchscreen::Touchscreen::need_update_ {false}
protected

Definition at line 116 of file touchscreen.h.

◆ release_trigger_

Trigger esphome::touchscreen::Touchscreen::release_trigger_
protected

Definition at line 109 of file touchscreen.h.

◆ skip_update_

bool esphome::touchscreen::Touchscreen::skip_update_ {false}
protected

Definition at line 119 of file touchscreen.h.

◆ store_

TouchscreenInterrupt esphome::touchscreen::Touchscreen::store_
protected

Definition at line 113 of file touchscreen.h.

◆ swap_x_y_

bool esphome::touchscreen::Touchscreen::swap_x_y_ {false}
protected

Definition at line 105 of file touchscreen.h.

◆ touch_listeners_

std::vector<TouchListener *> esphome::touchscreen::Touchscreen::touch_listeners_
protected

Definition at line 110 of file touchscreen.h.

◆ touch_timeout_

uint16_t esphome::touchscreen::Touchscreen::touch_timeout_ {0}
protected

Definition at line 104 of file touchscreen.h.

◆ touch_trigger_

Trigger<TouchPoint, const TouchPoints_t &> esphome::touchscreen::Touchscreen::touch_trigger_
protected

Definition at line 107 of file touchscreen.h.

◆ touches_

std::map<uint8_t, TouchPoint> esphome::touchscreen::Touchscreen::touches_
protected

Definition at line 112 of file touchscreen.h.

◆ update_trigger_

Trigger<const TouchPoints_t &> esphome::touchscreen::Touchscreen::update_trigger_
protected

Definition at line 108 of file touchscreen.h.

◆ was_touched_

bool esphome::touchscreen::Touchscreen::was_touched_ {false}
protected

Definition at line 118 of file touchscreen.h.

◆ x_raw_max_

int16_t esphome::touchscreen::Touchscreen::x_raw_max_ {0}
protected

Definition at line 101 of file touchscreen.h.

◆ x_raw_min_

int16_t esphome::touchscreen::Touchscreen::x_raw_min_ {0}
protected

Definition at line 101 of file touchscreen.h.

◆ y_raw_max_

int16_t esphome::touchscreen::Touchscreen::y_raw_max_ {0}
protected

Definition at line 101 of file touchscreen.h.

◆ y_raw_min_

int16_t esphome::touchscreen::Touchscreen::y_raw_min_ {0}
protected

Definition at line 101 of file touchscreen.h.


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