ESPHome  2024.5.3
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::ft5x06::FT5x06Touchscreen Class Reference

#include <ft5x06_touchscreen.h>

Inheritance diagram for esphome::ft5x06::FT5x06Touchscreen:
esphome::touchscreen::Touchscreen esphome::i2c::I2CDevice esphome::PollingComponent esphome::Component

Public Member Functions

void setup () override
 
void continue_setup_ (void)
 
void update_touches () 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 ()
 
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::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 

Protected Member Functions

bool err_check_ (i2c::ErrorCode err, const char *msg)
 
bool set_mode_ (FTMode mode)
 
- 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...
 

Protected Attributes

VendorId vendor_id_ {FT5X06_ID_UNKNOWN}
 
- 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::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 

Detailed Description

Definition at line 40 of file ft5x06_touchscreen.h.

Member Function Documentation

◆ continue_setup_()

void esphome::ft5x06::FT5x06Touchscreen::continue_setup_ ( void  )
inline

Definition at line 48 of file ft5x06_touchscreen.h.

◆ dump_config()

void esphome::ft5x06::FT5x06Touchscreen::dump_config ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 108 of file ft5x06_touchscreen.h.

◆ err_check_()

bool esphome::ft5x06::FT5x06Touchscreen::err_check_ ( i2c::ErrorCode  err,
const char *  msg 
)
inlineprotected

Definition at line 115 of file ft5x06_touchscreen.h.

◆ set_mode_()

bool esphome::ft5x06::FT5x06Touchscreen::set_mode_ ( FTMode  mode)
inlineprotected

Definition at line 123 of file ft5x06_touchscreen.h.

◆ setup()

void esphome::ft5x06::FT5x06Touchscreen::setup ( )
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 42 of file ft5x06_touchscreen.h.

◆ update_touches()

void esphome::ft5x06::FT5x06Touchscreen::update_touches ( )
inlineoverridevirtual

Implements esphome::touchscreen::Touchscreen.

Definition at line 80 of file ft5x06_touchscreen.h.

Field Documentation

◆ vendor_id_

VendorId esphome::ft5x06::FT5x06Touchscreen::vendor_id_ {FT5X06_ID_UNKNOWN}
protected

Definition at line 126 of file ft5x06_touchscreen.h.


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