This UARTDevice is used by the serial debugger to read data from a serial interface when the 'dummy_receiver' option is enabled. More...
#include <uart_debugger.h>
Inheritance diagram for esphome::uart::UARTDummyReceiver:
Public Member Functions | |
| UARTDummyReceiver (UARTComponent *parent) | |
| void | loop () override |
 Public Member Functions inherited from esphome::Component | |
| virtual void | setup () |
| Where the component's initialization should happen. More... | |
| virtual void | dump_config () |
| 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 () 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... | |
| Public Member Functions inherited from esphome::uart::UARTDevice | |
| UARTDevice ()=default | |
| UARTDevice (UARTComponent *parent) | |
| void | set_uart_parent (UARTComponent *parent) |
| void | write_byte (uint8_t data) |
| 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. More... | |
Additional Inherited Members | |
| 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 inherited from esphome::Component | |
| uint32_t | component_state_ {0x0000} |
| State of this component. More... | |
| float | setup_priority_override_ {NAN} |
| const char * | component_source_ {nullptr} |
| Protected Attributes inherited from esphome::uart::UARTDevice | |
| UARTComponent * | parent_ {nullptr} |
Detailed Description
This UARTDevice is used by the serial debugger to read data from a serial interface when the 'dummy_receiver' option is enabled.
The data are not stored, nor processed. This is most useful when the debugger is used to reverse engineer a serial protocol, for which no specific UARTDevice implementation exists (yet), but for which the incoming bytes must be read to drive the debugger.
Definition at line 73 of file uart_debugger.h.
Constructor & Destructor Documentation
◆ UARTDummyReceiver()
|
inline |
Definition at line 75 of file uart_debugger.h.
Member Function Documentation
◆ loop()
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 83 of file uart_debugger.cpp.
The documentation for this class was generated from the following files:
- /opt/build/esphome/esphome/components/uart/uart_debugger.h
- /opt/build/esphome/esphome/components/uart/uart_debugger.cpp
