|
| void | setup () override |
| |
| void | loop () override |
| |
| void | dump_config () override |
| |
| void | add_event_matcher (const char *event_name, const uint8_t *match_data, size_t match_data_len) |
| |
| void | trigger (const std::string &event_type) |
| |
| void | set_event_types (std::initializer_list< const char * > event_types) |
| | Set the event types supported by this event (from initializer list).
|
| |
| void | set_event_types (const FixedVector< const char * > &event_types) |
| | Set the event types supported by this event (from FixedVector).
|
| |
| void | set_event_types (const std::vector< const char * > &event_types) |
| | Set the event types supported by this event (from vector).
|
| |
| void | set_event_types (std::initializer_list< std::string > event_types)=delete |
| |
| void | set_event_types (const FixedVector< std::string > &event_types)=delete |
| |
| void | set_event_types (const std::vector< std::string > &event_types)=delete |
| |
| const FixedVector< const char * > & | get_event_types () const |
| | Return the event types supported by this event.
|
| |
| const char * | get_last_event_type () const |
| | Return the last triggered event type (pointer to string in types_), or nullptr if no event triggered yet.
|
| |
| void | add_on_event_callback (std::function< void(const std::string &event_type)> &&callback) |
| |
| const StringRef & | get_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) |
| |
| void | set_name_and_object_id (const char *name, const char *object_id) |
| |
| uint32_t | get_object_id_hash () |
| |
| StringRef | get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const |
| | Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
|
| |
| size_t | write_object_id_to (char *buf, size_t buf_size) const |
| | Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
|
| |
| 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) |
| |
| ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void | set_icon (const char *icon) |
| |
| StringRef | get_icon_ref () const |
| |
| uint32_t | get_device_id () const |
| |
| void | set_device (Device *device) |
| |
| bool | has_state () const |
| |
| void | set_has_state (bool state) |
| |
| uint32_t | get_preference_hash () |
| | Get a unique hash for storing preferences/settings for this entity.
|
| |
| ESPDEPRECATED("Use get_device_class_ref() instead for better performance (avoids string copy). Will be removed in " "ESPHome 2026.5.0", "2025.11.0") std void | set_device_class (const char *device_class) |
| | Get the device class, using the manual override if set.
|
| |
| StringRef | get_device_class_ref () const |
| | Get the device class as StringRef.
|
| |
| | UARTDevice ()=default |
| |
| | UARTDevice (UARTComponent *parent) |
| |
| void | set_uart_parent (UARTComponent *parent) |
| |
| void | write_byte (uint8_t data) |
| |
| void | set_rx_full_threshold (size_t rx_full_threshold) |
| |
| void | set_rx_full_threshold_ms (size_t time) |
| |
| size_t | get_rx_full_threshold () |
| |
| void | set_rx_timeout (size_t rx_timeout) |
| |
| size_t | get_rx_timeout () |
| |
| void | write_array (const uint8_t *data, size_t len) |
| |
| void | write_array (const std::vector< uint8_t > &data) |
| |
| template<size_t N> |
| void | write_array (const std::array< uint8_t, N > &data) |
| |
| void | write_str (const char *str) |
| |
| bool | read_byte (uint8_t *data) |
| |
| bool | peek_byte (uint8_t *data) |
| |
| bool | read_array (uint8_t *data, size_t len) |
| |
| template<size_t N> |
| optional< std::array< uint8_t, N > > | read_array () |
| |
| int | available () |
| |
| void | flush () |
| |
| int | read () |
| |
| size_t | write (uint8_t data) |
| |
| int | peek () |
| |
| void | check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8) |
| | Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
|
| |
| virtual float | get_setup_priority () const |
| | priority of setup().
|
| |
| float | get_actual_setup_priority () const |
| |
| void | set_setup_priority (float priority) |
| |
| virtual float | get_loop_priority () const |
| | priority of loop().
|
| |
| void | call () |
| |
| virtual void | on_shutdown () |
| |
| virtual void | on_safe_shutdown () |
| |
| virtual bool | teardown () |
| | Called during teardown to allow component to gracefully finish operations.
|
| |
| virtual void | on_powerdown () |
| | Called after teardown is complete to power down hardware.
|
| |
| uint8_t | get_component_state () const |
| |
| void | reset_to_construction_state () |
| | Reset this component back to the construction state to allow setup to run again.
|
| |
| bool | is_in_loop_state () const |
| | Check if this component has completed setup and is in the loop state.
|
| |
| bool | is_idle () const |
| | Check if this component is idle.
|
| |
| virtual void | mark_failed () |
| | Mark this component as failed.
|
| |
| | ESPDEPRECATED ("Use mark_failed(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void mark_failed(const char *message) |
| |
| void | mark_failed (const LogString *message) |
| |
| void | disable_loop () |
| | Disable this component's loop.
|
| |
| void | enable_loop () |
| | Enable this component's loop.
|
| |
| void | enable_loop_soon_any_context () |
| | Thread and ISR-safe version of enable_loop() that can be called from any context.
|
| |
| 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=nullptr) |
| |
| void | status_set_warning (const LogString *message) |
| |
| void | status_set_error () |
| |
| | ESPDEPRECATED ("Use status_set_error(LOG_STR(\"static string literal\")) instead. Do NOT use .c_str() from temporary " "strings. Will stop working in 2026.6.0", "2025.12.0") void status_set_error(const char *message) |
| |
| void | status_set_error (const LogString *message) |
| |
| void | status_clear_warning () |
| |
| void | status_clear_error () |
| |
| void | status_momentary_warning (const char *name, uint32_t length=5000) |
| | Set warning status flag and automatically clear it after a timeout.
|
| |
| void | status_momentary_error (const char *name, uint32_t length=5000) |
| | Set error status flag and automatically clear it after a timeout.
|
| |
| bool | has_overridden_loop () const |
| |
| void | set_component_source (const LogString *source) |
| | Set where this component was loaded from for some debug messages.
|
| |
| const LogString * | get_component_log_str () const |
| | Get the integration where this component was declared as a LogString for logging.
|
| |
| bool | should_warn_of_blocking (uint32_t blocking_time) |
| |
|
| void | read_data_ () |
| |
| void | calc_object_id_ () |
| |
| bool | is_object_id_dynamic_ () const |
| | Check if the object_id is dynamic (changes with MAC suffix)
|
| |
| virtual void | call_loop () |
| |
| virtual void | call_setup () |
| |
| virtual void | call_dump_config () |
| |
| void | set_component_state_ (uint8_t state) |
| | Helper to set component state (clears state bits and sets new state)
|
| |
| void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a unique name.
|
| |
| void | set_interval (const char *name, uint32_t interval, std::function< void()> &&f) |
| | Set an interval function with a const char* name.
|
| |
| void | set_interval (uint32_t interval, std::function< void()> &&f) |
| |
| bool | cancel_interval (const std::string &name) |
| | Cancel an interval function.
|
| |
| bool | cancel_interval (const char *name) |
| |
| 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.
|
| |
| void | set_retry (const char *name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
| |
| 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.
|
| |
| bool | cancel_retry (const char *name) |
| |
| void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a unique name.
|
| |
| void | set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f) |
| | Set a timeout function with a const char* name.
|
| |
| void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
| |
| bool | cancel_timeout (const std::string &name) |
| | Cancel a timeout function.
|
| |
| bool | cancel_timeout (const char *name) |
| |
| void | defer (const std::string &name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| void | defer (const char *name, std::function< void()> &&f) |
| | Defer a callback to the next loop() call with a const char* name.
|
| |
| void | defer (std::function< void()> &&f) |
| | Defer a callback to the next loop() call.
|
| |
| bool | cancel_defer (const std::string &name) |
| | Cancel a defer callback using the specified name, name must not be empty.
|
| |
Definition at line 10 of file uart_event.h.
Public Member Functions inherited from esphome::event::Event
1.12.0