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

#include <matrix_keypad_binary_sensor.h>

Inheritance diagram for esphome::matrix_keypad::MatrixKeypadBinarySensor:
esphome::matrix_keypad::MatrixKeypadListener esphome::binary_sensor::BinarySensor esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

 MatrixKeypadBinarySensor (uint8_t key)
 
 MatrixKeypadBinarySensor (const char *key)
 
 MatrixKeypadBinarySensor (int row, int col)
 
void key_pressed (uint8_t key) override
 
void key_released (uint8_t key) override
 
void button_pressed (int row, int col) override
 
void button_released (int row, int col) override
 
- Public Member Functions inherited from esphome::binary_sensor::BinarySensor
 BinarySensor ()
 
void add_on_state_callback (std::function< void(bool)> &&callback)
 Add a callback to be notified of state changes. More...
 
void publish_state (bool state)
 Publish a new state to the front-end. More...
 
void publish_initial_state (bool state)
 Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot. More...
 
void add_filter (Filter *filter)
 
void add_filters (const std::vector< Filter *> &filters)
 
void set_publish_initial_state (bool publish_initial_state)
 
void send_state_internal (bool state, bool is_initial)
 
virtual bool has_state () const
 Return whether this binary sensor has outputted a state. More...
 
virtual bool is_status_binary_sensor () const
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 

Protected Attributes

bool has_key_
 
uint8_t key_
 
int row_
 
int col_
 
- Protected Attributes inherited from esphome::binary_sensor::BinarySensor
CallbackManager< void(bool)> state_callback_ {}
 
Filterfilter_list_ {nullptr}
 
bool has_state_ {false}
 
bool publish_initial_state_ {false}
 
Deduplicator< bool > publish_dedup_
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 

Additional Inherited Members

- Data Fields inherited from esphome::binary_sensor::BinarySensor
bool state
 The current reported state of the binary sensor. More...
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 

Detailed Description

Definition at line 9 of file matrix_keypad_binary_sensor.h.

Constructor & Destructor Documentation

◆ MatrixKeypadBinarySensor() [1/3]

esphome::matrix_keypad::MatrixKeypadBinarySensor::MatrixKeypadBinarySensor ( uint8_t  key)
inline

Definition at line 11 of file matrix_keypad_binary_sensor.h.

◆ MatrixKeypadBinarySensor() [2/3]

esphome::matrix_keypad::MatrixKeypadBinarySensor::MatrixKeypadBinarySensor ( const char *  key)
inline

Definition at line 12 of file matrix_keypad_binary_sensor.h.

◆ MatrixKeypadBinarySensor() [3/3]

esphome::matrix_keypad::MatrixKeypadBinarySensor::MatrixKeypadBinarySensor ( int  row,
int  col 
)
inline

Definition at line 13 of file matrix_keypad_binary_sensor.h.

Member Function Documentation

◆ button_pressed()

void esphome::matrix_keypad::MatrixKeypadBinarySensor::button_pressed ( int  row,
int  col 
)
inlineoverridevirtual

Reimplemented from esphome::matrix_keypad::MatrixKeypadListener.

Definition at line 29 of file matrix_keypad_binary_sensor.h.

◆ button_released()

void esphome::matrix_keypad::MatrixKeypadBinarySensor::button_released ( int  row,
int  col 
)
inlineoverridevirtual

Reimplemented from esphome::matrix_keypad::MatrixKeypadListener.

Definition at line 36 of file matrix_keypad_binary_sensor.h.

◆ key_pressed()

void esphome::matrix_keypad::MatrixKeypadBinarySensor::key_pressed ( uint8_t  key)
inlineoverridevirtual

Reimplemented from esphome::matrix_keypad::MatrixKeypadListener.

Definition at line 15 of file matrix_keypad_binary_sensor.h.

◆ key_released()

void esphome::matrix_keypad::MatrixKeypadBinarySensor::key_released ( uint8_t  key)
inlineoverridevirtual

Reimplemented from esphome::matrix_keypad::MatrixKeypadListener.

Definition at line 22 of file matrix_keypad_binary_sensor.h.

Field Documentation

◆ col_

int esphome::matrix_keypad::MatrixKeypadBinarySensor::col_
protected

Definition at line 47 of file matrix_keypad_binary_sensor.h.

◆ has_key_

bool esphome::matrix_keypad::MatrixKeypadBinarySensor::has_key_
protected

Definition at line 44 of file matrix_keypad_binary_sensor.h.

◆ key_

uint8_t esphome::matrix_keypad::MatrixKeypadBinarySensor::key_
protected

Definition at line 45 of file matrix_keypad_binary_sensor.h.

◆ row_

int esphome::matrix_keypad::MatrixKeypadBinarySensor::row_
protected

Definition at line 46 of file matrix_keypad_binary_sensor.h.


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