ESPHome  2022.11.3
Public Member Functions | Protected Types | Protected Attributes
esphome::cap1188::CAP1188Component Class Reference

#include <cap1188.h>

Inheritance diagram for esphome::cap1188::CAP1188Component:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void register_channel (CAP1188Channel *channel)
 
void set_touch_threshold (uint8_t touch_threshold)
 
void set_allow_multiple_touches (bool allow_multiple_touches)
 
void set_reset_pin (GPIOPin *reset_pin)
 
void setup () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void loop () override
 
- Public Member Functions inherited from esphome::Component
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 ()
 
virtual bool can_proceed ()
 
bool status_has_warning ()
 
bool status_has_error ()
 
void status_set_warning ()
 
void status_set_error ()
 
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
 
void set_i2c_address (uint8_t address)
 
void set_i2c_bus (I2CBus *bus)
 
I2CRegister reg (uint8_t a_register)
 
ErrorCode read (uint8_t *data, size_t len)
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 
ErrorCode write (const uint8_t *data, uint8_t len, bool stop=true)
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 
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 Types

enum  ErrorCode { NONE = 0, COMMUNICATION_FAILED }
 

Protected Attributes

std::vector< CAP1188Channel * > channels_ {}
 
uint8_t touch_threshold_ {0x20}
 
uint8_t allow_multiple_touches_ {0x80}
 
GPIOPinreset_pin_ {nullptr}
 
uint8_t cap1188_product_id_ {0}
 
uint8_t cap1188_manufacture_id_ {0}
 
uint8_t cap1188_revision_ {0}
 
enum esphome::cap1188::CAP1188Component::ErrorCode NONE
 
- 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}
 
I2CBusbus_ {nullptr}
 

Additional Inherited Members

- 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()> &&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()> &&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 37 of file cap1188.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
NONE 
COMMUNICATION_FAILED 

Definition at line 61 of file cap1188.h.

Member Function Documentation

◆ dump_config()

void esphome::cap1188::CAP1188Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 51 of file cap1188.cpp.

◆ get_setup_priority()

float esphome::cap1188::CAP1188Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 47 of file cap1188.h.

◆ loop()

void esphome::cap1188::CAP1188Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 69 of file cap1188.cpp.

◆ register_channel()

void esphome::cap1188::CAP1188Component::register_channel ( CAP1188Channel channel)
inline

Definition at line 39 of file cap1188.h.

◆ set_allow_multiple_touches()

void esphome::cap1188::CAP1188Component::set_allow_multiple_touches ( bool  allow_multiple_touches)
inline

Definition at line 41 of file cap1188.h.

◆ set_reset_pin()

void esphome::cap1188::CAP1188Component::set_reset_pin ( GPIOPin reset_pin)
inline

Definition at line 44 of file cap1188.h.

◆ set_touch_threshold()

void esphome::cap1188::CAP1188Component::set_touch_threshold ( uint8_t  touch_threshold)
inline

Definition at line 40 of file cap1188.h.

◆ setup()

void esphome::cap1188::CAP1188Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file cap1188.cpp.

Field Documentation

◆ allow_multiple_touches_

uint8_t esphome::cap1188::CAP1188Component::allow_multiple_touches_ {0x80}
protected

Definition at line 53 of file cap1188.h.

◆ cap1188_manufacture_id_

uint8_t esphome::cap1188::CAP1188Component::cap1188_manufacture_id_ {0}
protected

Definition at line 58 of file cap1188.h.

◆ cap1188_product_id_

uint8_t esphome::cap1188::CAP1188Component::cap1188_product_id_ {0}
protected

Definition at line 57 of file cap1188.h.

◆ cap1188_revision_

uint8_t esphome::cap1188::CAP1188Component::cap1188_revision_ {0}
protected

Definition at line 59 of file cap1188.h.

◆ channels_

std::vector<CAP1188Channel *> esphome::cap1188::CAP1188Component::channels_ {}
protected

Definition at line 51 of file cap1188.h.

◆ NONE

enum esphome::cap1188::CAP1188Component::ErrorCode esphome::cap1188::CAP1188Component::NONE
protected

◆ reset_pin_

GPIOPin* esphome::cap1188::CAP1188Component::reset_pin_ {nullptr}
protected

Definition at line 55 of file cap1188.h.

◆ touch_threshold_

uint8_t esphome::cap1188::CAP1188Component::touch_threshold_ {0x20}
protected

Definition at line 52 of file cap1188.h.


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