ESPHome  2024.2.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::key_collector::KeyCollector Class Reference

#include <key_collector.h>

Inheritance diagram for esphome::key_collector::KeyCollector:
esphome::Component

Public Member Functions

 KeyCollector ()
 
void loop () override
 
void dump_config () override
 
void set_provider (key_provider::KeyProvider *provider)
 
void set_min_length (int min_length)
 
void set_max_length (int max_length)
 
void set_start_keys (std::string start_keys)
 
void set_end_keys (std::string end_keys)
 
void set_end_key_required (bool end_key_required)
 
void set_back_keys (std::string back_keys)
 
void set_clear_keys (std::string clear_keys)
 
void set_allowed_keys (std::string allowed_keys)
 
Trigger< std::string, uint8_t > * get_progress_trigger () const
 
Trigger< std::string, uint8_t, uint8_t > * get_result_trigger () const
 
Trigger< std::string, uint8_t > * get_timeout_trigger () const
 
void set_timeout (int timeout)
 
void clear (bool progress_update=true)
 
void send_key (uint8_t key)
 
- Public Member Functions inherited from esphome::Component
virtual void setup ()
 Where the component's initialization should happen. More...
 
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 Member Functions

void key_pressed_ (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...
 

Protected Attributes

int min_length_ {0}
 
int max_length_ {0}
 
std::string start_keys_
 
std::string end_keys_
 
bool end_key_required_ {false}
 
std::string back_keys_
 
std::string clear_keys_
 
std::string allowed_keys_
 
std::string result_
 
uint8_t start_key_ {0}
 
Trigger< std::string, uint8_t > * progress_trigger_
 
Trigger< std::string, uint8_t, uint8_t > * result_trigger_
 
Trigger< std::string, uint8_t > * timeout_trigger_
 
uint32_t last_key_time_
 
uint32_t timeout_ {0}
 
- 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}
 

Detailed Description

Definition at line 10 of file key_collector.h.

Constructor & Destructor Documentation

◆ KeyCollector()

esphome::key_collector::KeyCollector::KeyCollector ( )

Definition at line 10 of file key_collector.cpp.

Member Function Documentation

◆ clear()

void esphome::key_collector::KeyCollector::clear ( bool  progress_update = true)

Definition at line 48 of file key_collector.cpp.

◆ dump_config()

void esphome::key_collector::KeyCollector::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 22 of file key_collector.cpp.

◆ get_progress_trigger()

Trigger<std::string, uint8_t>* esphome::key_collector::KeyCollector::get_progress_trigger ( ) const
inline

Definition at line 24 of file key_collector.h.

◆ get_result_trigger()

Trigger<std::string, uint8_t, uint8_t>* esphome::key_collector::KeyCollector::get_result_trigger ( ) const
inline

Definition at line 25 of file key_collector.h.

◆ get_timeout_trigger()

Trigger<std::string, uint8_t>* esphome::key_collector::KeyCollector::get_timeout_trigger ( ) const
inline

Definition at line 26 of file key_collector.h.

◆ key_pressed_()

void esphome::key_collector::KeyCollector::key_pressed_ ( uint8_t  key)
protected

Definition at line 57 of file key_collector.cpp.

◆ loop()

void esphome::key_collector::KeyCollector::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 15 of file key_collector.cpp.

◆ send_key()

void esphome::key_collector::KeyCollector::send_key ( uint8_t  key)

Definition at line 55 of file key_collector.cpp.

◆ set_allowed_keys()

void esphome::key_collector::KeyCollector::set_allowed_keys ( std::string  allowed_keys)
inline

Definition at line 23 of file key_collector.h.

◆ set_back_keys()

void esphome::key_collector::KeyCollector::set_back_keys ( std::string  back_keys)
inline

Definition at line 21 of file key_collector.h.

◆ set_clear_keys()

void esphome::key_collector::KeyCollector::set_clear_keys ( std::string  clear_keys)
inline

Definition at line 22 of file key_collector.h.

◆ set_end_key_required()

void esphome::key_collector::KeyCollector::set_end_key_required ( bool  end_key_required)
inline

Definition at line 20 of file key_collector.h.

◆ set_end_keys()

void esphome::key_collector::KeyCollector::set_end_keys ( std::string  end_keys)
inline

Definition at line 19 of file key_collector.h.

◆ set_max_length()

void esphome::key_collector::KeyCollector::set_max_length ( int  max_length)
inline

Definition at line 17 of file key_collector.h.

◆ set_min_length()

void esphome::key_collector::KeyCollector::set_min_length ( int  min_length)
inline

Definition at line 16 of file key_collector.h.

◆ set_provider()

void esphome::key_collector::KeyCollector::set_provider ( key_provider::KeyProvider provider)

Definition at line 44 of file key_collector.cpp.

◆ set_start_keys()

void esphome::key_collector::KeyCollector::set_start_keys ( std::string  start_keys)
inline

Definition at line 18 of file key_collector.h.

◆ set_timeout()

void esphome::key_collector::KeyCollector::set_timeout ( int  timeout)
inline

Definition at line 27 of file key_collector.h.

Field Documentation

◆ allowed_keys_

std::string esphome::key_collector::KeyCollector::allowed_keys_
protected

Definition at line 42 of file key_collector.h.

◆ back_keys_

std::string esphome::key_collector::KeyCollector::back_keys_
protected

Definition at line 40 of file key_collector.h.

◆ clear_keys_

std::string esphome::key_collector::KeyCollector::clear_keys_
protected

Definition at line 41 of file key_collector.h.

◆ end_key_required_

bool esphome::key_collector::KeyCollector::end_key_required_ {false}
protected

Definition at line 39 of file key_collector.h.

◆ end_keys_

std::string esphome::key_collector::KeyCollector::end_keys_
protected

Definition at line 38 of file key_collector.h.

◆ last_key_time_

uint32_t esphome::key_collector::KeyCollector::last_key_time_
protected

Definition at line 48 of file key_collector.h.

◆ max_length_

int esphome::key_collector::KeyCollector::max_length_ {0}
protected

Definition at line 36 of file key_collector.h.

◆ min_length_

int esphome::key_collector::KeyCollector::min_length_ {0}
protected

Definition at line 35 of file key_collector.h.

◆ progress_trigger_

Trigger<std::string, uint8_t>* esphome::key_collector::KeyCollector::progress_trigger_
protected

Definition at line 45 of file key_collector.h.

◆ result_

std::string esphome::key_collector::KeyCollector::result_
protected

Definition at line 43 of file key_collector.h.

◆ result_trigger_

Trigger<std::string, uint8_t, uint8_t>* esphome::key_collector::KeyCollector::result_trigger_
protected

Definition at line 46 of file key_collector.h.

◆ start_key_

uint8_t esphome::key_collector::KeyCollector::start_key_ {0}
protected

Definition at line 44 of file key_collector.h.

◆ start_keys_

std::string esphome::key_collector::KeyCollector::start_keys_
protected

Definition at line 37 of file key_collector.h.

◆ timeout_

uint32_t esphome::key_collector::KeyCollector::timeout_ {0}
protected

Definition at line 49 of file key_collector.h.

◆ timeout_trigger_

Trigger<std::string, uint8_t>* esphome::key_collector::KeyCollector::timeout_trigger_
protected

Definition at line 47 of file key_collector.h.


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