EspUart.h

Go to the documentation of this file.

 
#pragma once
 
#include "BaseUart.h"
#include "McuSelect.h"
#include "PlatformMutex.h"
#include "utils/EspTypes.h"
 
#include <array>
#include <atomic>
#include <memory>
#include <vector>
 
// ESP-IDF C headers must be wrapped in extern "C" for C++ compatibility
#ifdef __cplusplus
extern "C" {
#endif
 
#include "driver/gpio.h"
#include "driver/uart.h"
#include "esp_log.h"
#include "esp_timer.h"
 
#include "freertos/FreeRTOS.h"
#include "freertos/queue.h"
#include "freertos/task.h"
 
#ifdef __cplusplus
}
#endif
 
class EspUart : public BaseUart {
public:
  //==============================================================================
  // CONSTANTS
  //==============================================================================
 
  static constexpr hf_u8_t MAX_PORTS = 3;               
  static constexpr hf_u32_t MAX_BAUD_RATE = 5000000;    
  static constexpr hf_u32_t MIN_BAUD_RATE = 110;        
  static constexpr hf_u32_t DEFAULT_BAUD_RATE = 115200; 
  static constexpr hf_u16_t MAX_BUFFER_SIZE = 1024;     
  static constexpr hf_u16_t DEFAULT_BUFFER_SIZE = 256;  
 
  //==============================================================================
  // CONSTRUCTOR AND DESTRUCTOR
  //==============================================================================
 
  explicit EspUart(const hf_uart_config_t& config) noexcept;
 
  virtual ~EspUart() noexcept override;
 
  // Prevent copying and moving
  EspUart(const EspUart&) = delete;
  EspUart& operator=(const EspUart&) = delete;
  EspUart(EspUart&&) = delete;
  EspUart& operator=(EspUart&&) = delete;
 
  //==============================================================================
  // LIFECYCLE (BaseUart Interface)
  //==============================================================================
 
  // Note: EnsureInitialized() is inherited from BaseUart and provides lazy initialization
  // Thread safety is handled in Initialize() and Deinitialize() methods
 
  //==============================================================================
  // BASIC UART OPERATIONS (BaseUart Interface)
  //==============================================================================
 
  hf_uart_err_t Write(const uint8_t* data, uint16_t length,
                      uint32_t timeout_ms = 0) noexcept override;
 
  hf_uart_err_t Read(uint8_t* data, uint16_t length, uint32_t timeout_ms = 0) noexcept override;
 
  bool WriteByte(uint8_t byte) noexcept override;
 
  bool SetBaudRate(uint32_t baud_rate) noexcept;
 
  hf_uart_err_t SetFlowControl(bool enable) noexcept;
 
  hf_uart_err_t SetRTS(bool active) noexcept;
 
  hf_uart_err_t SendBreak(uint32_t duration_ms) noexcept;
 
  hf_uart_err_t SetLoopback(bool enable) noexcept;
 
  bool WaitTransmitComplete(uint32_t timeout_ms) noexcept;
 
  //==============================================================================
  // ADVANCED UART FEATURES
  //==============================================================================
 
  hf_uart_err_t SetOperatingMode(hf_uart_operating_mode_t mode) noexcept;
 
  uint16_t ReadUntil(uint8_t* data, uint16_t max_length, uint8_t terminator,
                     uint32_t timeout_ms) noexcept;
 
  uint16_t ReadLine(char* buffer, uint16_t max_length, uint32_t timeout_ms) noexcept;
 
  hf_uart_err_t SetCommunicationMode(hf_uart_mode_t mode) noexcept;
 
  hf_uart_err_t ConfigureRS485(const hf_uart_rs485_config_t& rs485_config) noexcept;
 
  hf_uart_err_t ConfigureIrDA(const hf_uart_irda_config_t& irda_config) noexcept;
 
  hf_uart_err_t ConfigureSoftwareFlowControl(bool enable, uint8_t xon_threshold = 20,
                                             uint8_t xoff_threshold = 80) noexcept;
 
  hf_uart_err_t ConfigureWakeup(const hf_uart_wakeup_config_t& wakeup_config) noexcept;
 
  hf_uart_err_t SetSignalInversion(uint32_t inverse_mask) noexcept;
 
  //==============================================================================
  // EVENT QUEUE ACCESS (User Creates Own Tasks)
  //==============================================================================
 
  QueueHandle_t GetEventQueue() const noexcept;
 
  bool IsEventQueueAvailable() const noexcept;
 
  hf_uart_err_t ConfigureInterrupts(uint32_t intr_enable_mask, uint8_t rxfifo_full_thresh = 100,
                                    uint8_t rx_timeout_thresh = 10) noexcept;
 
  hf_uart_err_t ResetEventQueue() noexcept;
 
  //==============================================================================
  // PATTERN DETECTION (ESP-IDF v5.5 Feature)
  //==============================================================================
 
  hf_uart_err_t EnablePatternDetection(char pattern_chr, uint8_t chr_num = 1, int chr_tout = 9,
                                       int post_idle = 0, int pre_idle = 0) noexcept;
 
  hf_uart_err_t DisablePatternDetection() noexcept;
 
  hf_uart_err_t ResetPatternQueue(int queue_length = 32) noexcept;
 
  int PopPatternPosition() noexcept;
 
  int PeekPatternPosition() noexcept;
 
  //==============================================================================
  // STATUS AND INFORMATION
  //==============================================================================
 
  hf_uart_err_t GetStatistics(hf_uart_statistics_t& statistics) const noexcept override;
 
  hf_uart_err_t GetDiagnostics(hf_uart_diagnostics_t& diagnostics) const noexcept override;
 
  hf_uart_err_t GetLastError() const noexcept;
 
  const hf_uart_config_t& GetPortConfig() const noexcept;
 
  hf_uart_operating_mode_t GetOperatingMode() const noexcept;
 
  hf_uart_mode_t GetCommunicationMode() const noexcept;
 
  bool IsWakeupEnabled() const noexcept;
 
  bool IsTransmitting() const noexcept;
 
  bool IsReceiving() const noexcept;
 
  bool IsBreakDetected() noexcept;
 
  uint16_t TxBytesWaiting() noexcept;
 
  //==============================================================================
  // PRINTF SUPPORT
  //==============================================================================
 
  int Printf(const char* format, ...) noexcept;
 
  int VPrintf(const char* format, va_list args) noexcept;
 
private:
  //==============================================================================
  // INITIALIZATION AND DEINITIALIZATION
  //==============================================================================
 
  bool Initialize() noexcept override;
 
  bool Deinitialize() noexcept override;
 
  //==============================================================================
  // INTERNAL STATE STRUCTURES
  //==============================================================================
 
  struct UartState {
    bool configured;                         
    bool enabled;                            
    hf_uart_config_t config;                 
    hf_uart_operating_mode_t operating_mode; 
    hf_uart_mode_t communication_mode;       
    hf_uart_err_t last_error;                
 
    UartState() noexcept
        : configured(false), enabled(false), config(),
          operating_mode(hf_uart_operating_mode_t::HF_UART_MODE_POLLING),
          communication_mode(hf_uart_mode_t::HF_UART_MODE_UART),
          last_error(hf_uart_err_t::UART_SUCCESS) {}
  };
 
  //==============================================================================
  // INTERNAL METHODS
  //==============================================================================
 
  hf_uart_err_t ValidateConfiguration() const noexcept;
 
  hf_uart_err_t PlatformInitialize() noexcept;
 
  hf_uart_err_t PlatformDeinitialize() noexcept;
 
  hf_uart_err_t InstallDriver() noexcept;
 
  hf_uart_err_t UninstallDriver() noexcept;
 
  hf_uart_err_t ConfigureUart() noexcept;
 
  hf_uart_err_t ConfigurePins() noexcept;
 
  hf_uart_err_t ConvertPlatformError(int32_t platform_error) noexcept;
 
  hf_uart_err_t UpdateStatistics(hf_uart_err_t result, uint64_t start_time_us) noexcept;
 
  void UpdateDiagnostics(hf_uart_err_t error) noexcept;
 
  [[nodiscard]] uint32_t GetTimeoutMs(uint32_t timeout_ms) const noexcept;
 
  int InternalPrintf(const char* format, va_list args) noexcept;
 
  //==============================================================================
  // MEMBER VARIABLES
  //==============================================================================
 
  mutable PlatformMutex mutex_;       
  hf_uart_config_t port_config_;  
  std::atomic<bool> initialized_; 
  uart_port_t uart_port_;         
 
  // Event queue (user creates own tasks)
  QueueHandle_t event_queue_; 
 
  // Operating mode and communication state
  hf_uart_operating_mode_t operating_mode_; 
  hf_uart_mode_t communication_mode_;       
  bool software_flow_enabled_;              
  bool wakeup_enabled_;                     
  bool break_detected_;                     
  bool tx_in_progress_;                     
 
  // Error tracking
  hf_uart_err_t last_error_; 
 
  // Statistics and diagnostics
  hf_uart_statistics_t statistics_;   
  hf_uart_diagnostics_t diagnostics_; 
 
  // Printf buffer
  char printf_buffer_[256]; 
 
public:
  // Add missing overrides for BaseUart pure virtuals
  uint16_t BytesAvailable() noexcept override;
  hf_uart_err_t FlushTx() noexcept override;
  hf_uart_err_t FlushRx() noexcept override;
  bool IsTxBusy() noexcept;
};