ESPHome  2024.2.0
Public Member Functions | Protected Attributes
esphome::matrix_keypad::MatrixKeypad Class Reference

#include <matrix_keypad.h>

Inheritance diagram for esphome::matrix_keypad::MatrixKeypad:
esphome::key_provider::KeyProvider esphome::Component

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
void set_columns (std::vector< GPIOPin *> pins)
 
void set_rows (std::vector< GPIOPin *> pins)
 
void set_keys (std::string keys)
 
void set_debounce_time (int debounce_time)
 
void set_has_diodes (int has_diodes)
 
void set_has_pulldowns (int has_pulldowns)
 
void register_listener (MatrixKeypadListener *listener)
 
- Public Member Functions inherited from esphome::key_provider::KeyProvider
void add_on_key_callback (std::function< void(uint8_t)> &&callback)
 
- 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 ()
 
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...
 

Protected Attributes

std::vector< GPIOPin * > rows_
 
std::vector< GPIOPin * > columns_
 
std::string keys_
 
int debounce_time_ = 0
 
bool has_diodes_ {false}
 
bool has_pulldowns_ {false}
 
int pressed_key_ = -1
 
std::vector< MatrixKeypadListener * > listeners_ {}
 
- Protected Attributes inherited from esphome::key_provider::KeyProvider
CallbackManager< void(uint8_t)> key_callback_ {}
 
- 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}
 

Additional Inherited Members

- Protected Member Functions inherited from esphome::key_provider::KeyProvider
void send_key_ (uint8_t key)
 
- 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(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...
 

Detailed Description

Definition at line 21 of file matrix_keypad.h.

Member Function Documentation

◆ dump_config()

void esphome::matrix_keypad::MatrixKeypad::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 94 of file matrix_keypad.cpp.

◆ loop()

void esphome::matrix_keypad::MatrixKeypad::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 26 of file matrix_keypad.cpp.

◆ register_listener()

void esphome::matrix_keypad::MatrixKeypad::register_listener ( MatrixKeypadListener listener)

Definition at line 106 of file matrix_keypad.cpp.

◆ set_columns()

void esphome::matrix_keypad::MatrixKeypad::set_columns ( std::vector< GPIOPin *>  pins)
inline

Definition at line 26 of file matrix_keypad.h.

◆ set_debounce_time()

void esphome::matrix_keypad::MatrixKeypad::set_debounce_time ( int  debounce_time)
inline

Definition at line 29 of file matrix_keypad.h.

◆ set_has_diodes()

void esphome::matrix_keypad::MatrixKeypad::set_has_diodes ( int  has_diodes)
inline

Definition at line 30 of file matrix_keypad.h.

◆ set_has_pulldowns()

void esphome::matrix_keypad::MatrixKeypad::set_has_pulldowns ( int  has_pulldowns)
inline

Definition at line 31 of file matrix_keypad.h.

◆ set_keys()

void esphome::matrix_keypad::MatrixKeypad::set_keys ( std::string  keys)
inline

Definition at line 28 of file matrix_keypad.h.

◆ set_rows()

void esphome::matrix_keypad::MatrixKeypad::set_rows ( std::vector< GPIOPin *>  pins)
inline

Definition at line 27 of file matrix_keypad.h.

◆ setup()

void esphome::matrix_keypad::MatrixKeypad::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file matrix_keypad.cpp.

Field Documentation

◆ columns_

std::vector<GPIOPin *> esphome::matrix_keypad::MatrixKeypad::columns_
protected

Definition at line 37 of file matrix_keypad.h.

◆ debounce_time_

int esphome::matrix_keypad::MatrixKeypad::debounce_time_ = 0
protected

Definition at line 39 of file matrix_keypad.h.

◆ has_diodes_

bool esphome::matrix_keypad::MatrixKeypad::has_diodes_ {false}
protected

Definition at line 40 of file matrix_keypad.h.

◆ has_pulldowns_

bool esphome::matrix_keypad::MatrixKeypad::has_pulldowns_ {false}
protected

Definition at line 41 of file matrix_keypad.h.

◆ keys_

std::string esphome::matrix_keypad::MatrixKeypad::keys_
protected

Definition at line 38 of file matrix_keypad.h.

◆ listeners_

std::vector<MatrixKeypadListener *> esphome::matrix_keypad::MatrixKeypad::listeners_ {}
protected

Definition at line 44 of file matrix_keypad.h.

◆ pressed_key_

int esphome::matrix_keypad::MatrixKeypad::pressed_key_ = -1
protected

Definition at line 42 of file matrix_keypad.h.

◆ rows_

std::vector<GPIOPin *> esphome::matrix_keypad::MatrixKeypad::rows_
protected

Definition at line 36 of file matrix_keypad.h.


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