ESPHome  2022.6.2
Public Member Functions | Protected Types | Protected Attributes
esphome::mpr121::MPR121Component Class Reference

#include <mpr121.h>

Inheritance diagram for esphome::mpr121::MPR121Component:
esphome::Component esphome::i2c::I2CDevice

Public Member Functions

void register_channel (MPR121Channel *channel)
 
void set_touch_debounce (uint8_t debounce)
 
void set_release_debounce (uint8_t debounce)
 
void set_touch_threshold (uint8_t touch_threshold)
 
void set_release_threshold (uint8_t release_threshold)
 
uint8_t get_touch_threshold ()
 
uint8_t get_release_threshold ()
 
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, WRONG_CHIP_STATE }
 

Protected Attributes

std::vector< MPR121Channel * > channels_ {}
 
uint8_t debounce_ {0}
 
uint8_t touch_threshold_ {}
 
uint8_t release_threshold_ {}
 
enum esphome::mpr121::MPR121Component::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 63 of file mpr121.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
NONE 
COMMUNICATION_FAILED 
WRONG_CHIP_STATE 

Definition at line 82 of file mpr121.h.

Member Function Documentation

◆ dump_config()

void esphome::mpr121::MPR121Component::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 63 of file mpr121.cpp.

◆ get_release_threshold()

uint8_t esphome::mpr121::MPR121Component::get_release_threshold ( )
inline

Definition at line 71 of file mpr121.h.

◆ get_setup_priority()

float esphome::mpr121::MPR121Component::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 74 of file mpr121.h.

◆ get_touch_threshold()

uint8_t esphome::mpr121::MPR121Component::get_touch_threshold ( )
inline

Definition at line 70 of file mpr121.h.

◆ loop()

void esphome::mpr121::MPR121Component::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 78 of file mpr121.cpp.

◆ register_channel()

void esphome::mpr121::MPR121Component::register_channel ( MPR121Channel channel)
inline

Definition at line 65 of file mpr121.h.

◆ set_release_debounce()

void esphome::mpr121::MPR121Component::set_release_debounce ( uint8_t  debounce)

Definition at line 57 of file mpr121.cpp.

◆ set_release_threshold()

void esphome::mpr121::MPR121Component::set_release_threshold ( uint8_t  release_threshold)
inline

Definition at line 69 of file mpr121.h.

◆ set_touch_debounce()

void esphome::mpr121::MPR121Component::set_touch_debounce ( uint8_t  debounce)

Definition at line 51 of file mpr121.cpp.

◆ set_touch_threshold()

void esphome::mpr121::MPR121Component::set_touch_threshold ( uint8_t  touch_threshold)
inline

Definition at line 68 of file mpr121.h.

◆ setup()

void esphome::mpr121::MPR121Component::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 10 of file mpr121.cpp.

Field Documentation

◆ channels_

std::vector<MPR121Channel *> esphome::mpr121::MPR121Component::channels_ {}
protected

Definition at line 78 of file mpr121.h.

◆ debounce_

uint8_t esphome::mpr121::MPR121Component::debounce_ {0}
protected

Definition at line 79 of file mpr121.h.

◆ NONE

enum esphome::mpr121::MPR121Component::ErrorCode esphome::mpr121::MPR121Component::NONE
protected

◆ release_threshold_

uint8_t esphome::mpr121::MPR121Component::release_threshold_ {}
protected

Definition at line 81 of file mpr121.h.

◆ touch_threshold_

uint8_t esphome::mpr121::MPR121Component::touch_threshold_ {}
protected

Definition at line 80 of file mpr121.h.


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