5e842a8b20
Co-authored-by: J. Nick Koston <nick@koston.org> Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
72 lines
2.2 KiB
C++
72 lines
2.2 KiB
C++
#pragma once
|
|
|
|
#ifdef USE_ESP32
|
|
|
|
#include <driver/uart.h>
|
|
#include "esphome/core/component.h"
|
|
#include "uart_component.h"
|
|
#ifdef USE_UART_WAKE_LOOP_ON_RX
|
|
#include <driver/uart_select.h>
|
|
#endif
|
|
|
|
namespace esphome::uart {
|
|
|
|
/// ESP-IDF UART driver wrapper.
|
|
///
|
|
/// Thread safety: All public methods must only be called from the main loop.
|
|
/// The ESP-IDF UART driver API does not guarantee thread safety, and ESPHome's
|
|
/// peek byte state (has_peek_/peek_byte_) is not synchronized.
|
|
class IDFUARTComponent : public UARTComponent, public Component {
|
|
public:
|
|
void setup() override;
|
|
void dump_config() override;
|
|
float get_setup_priority() const override { return setup_priority::BUS; }
|
|
|
|
void set_rx_full_threshold(size_t rx_full_threshold) override;
|
|
void set_rx_timeout(size_t rx_timeout) override;
|
|
|
|
void write_array(const uint8_t *data, size_t len) override;
|
|
|
|
bool peek_byte(uint8_t *data) override;
|
|
bool read_array(uint8_t *data, size_t len) override;
|
|
|
|
size_t available() override;
|
|
FlushResult flush() override;
|
|
|
|
void set_flush_timeout(uint32_t flush_timeout_ms) override { this->flush_timeout_ms_ = flush_timeout_ms; }
|
|
|
|
uint8_t get_hw_serial_number() { return this->uart_num_; }
|
|
|
|
/**
|
|
* Load the UART with the current settings.
|
|
* @param dump_config (Optional, default `true`): True for displaying new settings or
|
|
* false to change it quitely
|
|
*
|
|
* Example:
|
|
* ```cpp
|
|
* id(uart1).load_settings();
|
|
* ```
|
|
*
|
|
* This will load the current UART interface with the latest settings (baud_rate, parity, etc).
|
|
*/
|
|
void load_settings(bool dump_config) override;
|
|
void load_settings() override { this->load_settings(true); }
|
|
|
|
protected:
|
|
void check_logger_conflict() override;
|
|
uart_port_t uart_num_;
|
|
uart_config_t get_config_();
|
|
|
|
bool has_peek_{false};
|
|
uint8_t peek_byte_;
|
|
uint32_t flush_timeout_ms_{0}; ///< 0 means wait indefinitely (portMAX_DELAY).
|
|
|
|
#ifdef USE_UART_WAKE_LOOP_ON_RX
|
|
// ISR callback for UART RX data notification — wakes the main loop directly.
|
|
static void uart_rx_isr_callback(uart_port_t uart_num, uart_select_notif_t uart_select_notif, BaseType_t *task_woken);
|
|
#endif // USE_UART_WAKE_LOOP_ON_RX
|
|
};
|
|
|
|
} // namespace esphome::uart
|
|
#endif // USE_ESP32
|