ESPHome  2024.11.3
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
esphome::xpt2046::XPT2046Component Class Reference

#include <xpt2046.h>

Inheritance diagram for esphome::xpt2046::XPT2046Component:
esphome::touchscreen::Touchscreen esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ > esphome::PollingComponent esphome::spi::SPIClient esphome::Component

Public Member Functions

void set_threshold (int16_t threshold)
 Set the threshold for the touch detection. More...
 
void set_irq_pin (InternalGPIOPin *pin)
 Set the pin used to detect the touch. More...
 
void setup () override
 
void dump_config () override
 
- Public Member Functions inherited from esphome::touchscreen::Touchscreen
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 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...
 
- Public Member Functions inherited from esphome::spi::SPIDevice< spi::BIT_ORDER_MSB_FIRST, spi::CLOCK_POLARITY_LOW, spi::CLOCK_PHASE_LEADING, spi::DATA_RATE_2MHZ >
 SPIDevice ()
 
 SPIDevice (SPIComponent *parent, GPIOPin *cs_pin)
 
void spi_setup () override
 
void spi_teardown () override
 
void set_spi_parent (SPIComponent *parent)
 
void set_cs_pin (GPIOPin *cs)
 
void set_data_rate (uint32_t data_rate)
 
void set_bit_order (SPIBitOrder order)
 
void set_mode (SPIMode mode)
 
uint8_t read_byte ()
 
void read_array (uint8_t *data, size_t length)
 
void write (uint16_t data, size_t num_bits)
 Write a single data item, up to 32 bits. More...
 
void write_cmd_addr_data (size_t cmd_bits, uint32_t cmd, size_t addr_bits, uint32_t address, const uint8_t *data, size_t length, uint8_t bus_width=1)
 
void write_byte (uint8_t data)
 
void transfer_array (uint8_t *data, size_t length)
 Write the array data, replace with received data. More...
 
void transfer_array (std::array< uint8_t, N > &data)
 
uint8_t transfer_byte (uint8_t data)
 
void write_byte16 (uint16_t data)
 Write 16 bit data. More...
 
void write_array16 (const uint16_t *data, size_t length)
 Write an array of data as 16 bit values, byte-swapping if required. More...
 
void enable ()
 
void disable ()
 
void write_array (const uint8_t *data, size_t length)
 
void write_array (const std::array< uint8_t, N > &data)
 
void write_array (const std::vector< uint8_t > &data)
 
- Public Member Functions inherited from esphome::spi::SPIClient
 SPIClient (SPIBitOrder bit_order, SPIMode mode, uint32_t data_rate)
 
bool spi_is_ready ()
 

Protected Member Functions

int16_t read_adc_ (uint8_t ctrl)
 
void update_touches () override
 
- Protected Member Functions inherited from esphome::touchscreen::Touchscreen
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)
 
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...
 

Static Protected Member Functions

static int16_t best_two_avg (int16_t value1, int16_t value2, int16_t value3)
 

Protected Attributes

int16_t threshold_
 
InternalGPIOPinirq_pin_ {nullptr}
 
- Protected Attributes inherited from esphome::touchscreen::Touchscreen
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}
 
- Protected Attributes inherited from esphome::spi::SPIClient
SPIBitOrder bit_order_ {BIT_ORDER_MSB_FIRST}
 
SPIMode mode_ {MODE0}
 
uint32_t data_rate_ {1000000}
 
SPIComponentparent_ {nullptr}
 
GPIOPincs_ {nullptr}
 
SPIDelegatedelegate_ {nullptr}
 

Detailed Description

Definition at line 15 of file xpt2046.h.

Member Function Documentation

◆ best_two_avg()

int16_t esphome::xpt2046::XPT2046Component::best_two_avg ( int16_t  value1,
int16_t  value2,
int16_t  value3 
)
staticprotected

Definition at line 81 of file xpt2046.cpp.

◆ dump_config()

void esphome::xpt2046::XPT2046Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 61 of file xpt2046.cpp.

◆ read_adc_()

int16_t esphome::xpt2046::XPT2046Component::read_adc_ ( uint8_t  ctrl)
protected

Definition at line 100 of file xpt2046.cpp.

◆ set_irq_pin()

void esphome::xpt2046::XPT2046Component::set_irq_pin ( InternalGPIOPin pin)
inline

Set the pin used to detect the touch.

Definition at line 22 of file xpt2046.h.

◆ set_threshold()

void esphome::xpt2046::XPT2046Component::set_threshold ( int16_t  threshold)
inline

Set the threshold for the touch detection.

Definition at line 20 of file xpt2046.h.

◆ setup()

void esphome::xpt2046::XPT2046Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 12 of file xpt2046.cpp.

◆ update_touches()

void esphome::xpt2046::XPT2046Component::update_touches ( )
overrideprotectedvirtual

Implements esphome::touchscreen::Touchscreen.

Definition at line 27 of file xpt2046.cpp.

Field Documentation

◆ irq_pin_

InternalGPIOPin* esphome::xpt2046::XPT2046Component::irq_pin_ {nullptr}
protected

Definition at line 37 of file xpt2046.h.

◆ threshold_

int16_t esphome::xpt2046::XPT2046Component::threshold_
protected

Definition at line 35 of file xpt2046.h.


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