ESPHome
2024.12.2
|
#include <key_collector.h>
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 () const |
bool | is_ready () const |
virtual bool | can_proceed () |
bool | status_has_warning () const |
bool | status_has_error () const |
void | status_set_warning (const char *message="unspecified") |
void | status_set_error (const char *message="unspecified") |
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} |
Definition at line 10 of file key_collector.h.
esphome::key_collector::KeyCollector::KeyCollector | ( | ) |
Definition at line 10 of file key_collector.cpp.
void esphome::key_collector::KeyCollector::clear | ( | bool | progress_update = true | ) |
Definition at line 48 of file key_collector.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 22 of file key_collector.cpp.
|
inline |
Definition at line 24 of file key_collector.h.
|
inline |
Definition at line 25 of file key_collector.h.
|
inline |
Definition at line 26 of file key_collector.h.
|
protected |
Definition at line 57 of file key_collector.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 15 of file key_collector.cpp.
void esphome::key_collector::KeyCollector::send_key | ( | uint8_t | key | ) |
Definition at line 55 of file key_collector.cpp.
|
inline |
Definition at line 23 of file key_collector.h.
|
inline |
Definition at line 21 of file key_collector.h.
|
inline |
Definition at line 22 of file key_collector.h.
|
inline |
Definition at line 20 of file key_collector.h.
|
inline |
Definition at line 19 of file key_collector.h.
|
inline |
Definition at line 17 of file key_collector.h.
|
inline |
Definition at line 16 of file key_collector.h.
void esphome::key_collector::KeyCollector::set_provider | ( | key_provider::KeyProvider * | provider | ) |
Definition at line 44 of file key_collector.cpp.
|
inline |
Definition at line 18 of file key_collector.h.
|
inline |
Definition at line 27 of file key_collector.h.
|
protected |
Definition at line 42 of file key_collector.h.
|
protected |
Definition at line 40 of file key_collector.h.
|
protected |
Definition at line 41 of file key_collector.h.
|
protected |
Definition at line 39 of file key_collector.h.
|
protected |
Definition at line 38 of file key_collector.h.
|
protected |
Definition at line 48 of file key_collector.h.
|
protected |
Definition at line 36 of file key_collector.h.
|
protected |
Definition at line 35 of file key_collector.h.
|
protected |
Definition at line 45 of file key_collector.h.
|
protected |
Definition at line 43 of file key_collector.h.
|
protected |
Definition at line 46 of file key_collector.h.
|
protected |
Definition at line 44 of file key_collector.h.
|
protected |
Definition at line 37 of file key_collector.h.
|
protected |
Definition at line 49 of file key_collector.h.
|
protected |
Definition at line 47 of file key_collector.h.