ESPHome  2023.8.3
uart_component.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <vector>
4 #include <cstring>
5 #include "esphome/core/defines.h"
7 #include "esphome/core/hal.h"
8 #include "esphome/core/log.h"
9 #ifdef USE_UART_DEBUGGER
11 #endif
12 
13 namespace esphome {
14 namespace uart {
15 
20 };
21 
22 #ifdef USE_UART_DEBUGGER
27 };
28 #endif
29 
30 const LogString *parity_to_str(UARTParityOptions parity);
31 
33  public:
34  void write_array(const std::vector<uint8_t> &data) { this->write_array(&data[0], data.size()); }
35  void write_byte(uint8_t data) { this->write_array(&data, 1); };
36  void write_str(const char *str) {
37  const auto *data = reinterpret_cast<const uint8_t *>(str);
38  this->write_array(data, strlen(str));
39  };
40 
41  virtual void write_array(const uint8_t *data, size_t len) = 0;
42 
43  bool read_byte(uint8_t *data) { return this->read_array(data, 1); };
44  virtual bool peek_byte(uint8_t *data) = 0;
45  virtual bool read_array(uint8_t *data, size_t len) = 0;
46 
48  virtual int available() = 0;
50  virtual void flush() = 0;
51 
52  void set_tx_pin(InternalGPIOPin *tx_pin) { this->tx_pin_ = tx_pin; }
53  void set_rx_pin(InternalGPIOPin *rx_pin) { this->rx_pin_ = rx_pin; }
54  void set_rx_buffer_size(size_t rx_buffer_size) { this->rx_buffer_size_ = rx_buffer_size; }
55  size_t get_rx_buffer_size() { return this->rx_buffer_size_; }
56 
57  void set_stop_bits(uint8_t stop_bits) { this->stop_bits_ = stop_bits; }
58  uint8_t get_stop_bits() const { return this->stop_bits_; }
59  void set_data_bits(uint8_t data_bits) { this->data_bits_ = data_bits; }
60  uint8_t get_data_bits() const { return this->data_bits_; }
61  void set_parity(UARTParityOptions parity) { this->parity_ = parity; }
62  UARTParityOptions get_parity() const { return this->parity_; }
63  void set_baud_rate(uint32_t baud_rate) { baud_rate_ = baud_rate; }
64  uint32_t get_baud_rate() const { return baud_rate_; }
65 
66 #ifdef USE_UART_DEBUGGER
67  void add_debug_callback(std::function<void(UARTDirection, uint8_t)> &&callback) {
68  this->debug_callback_.add(std::move(callback));
69  }
70 #endif
71 
72  protected:
73  virtual void check_logger_conflict() = 0;
74  bool check_read_timeout_(size_t len = 1);
75 
79  uint32_t baud_rate_;
80  uint8_t stop_bits_;
81  uint8_t data_bits_;
83 #ifdef USE_UART_DEBUGGER
85 #endif
86 };
87 
88 } // namespace uart
89 } // namespace esphome
virtual bool read_array(uint8_t *data, size_t len)=0
uint32_t get_baud_rate() const
void set_tx_pin(InternalGPIOPin *tx_pin)
bool read_byte(uint8_t *data)
void set_stop_bits(uint8_t stop_bits)
void set_data_bits(uint8_t data_bits)
void set_parity(UARTParityOptions parity)
virtual int available()=0
Return available number of bytes.
UARTParityOptions get_parity() const
void set_baud_rate(uint32_t baud_rate)
virtual bool peek_byte(uint8_t *data)=0
virtual void flush()=0
Block until all bytes have been written to the UART bus.
std::string size_t len
Definition: helpers.h:289
void set_rx_buffer_size(size_t rx_buffer_size)
void write_str(const char *str)
void write_byte(uint8_t data)
bool check_read_timeout_(size_t len=1)
void add_debug_callback(std::function< void(UARTDirection, uint8_t)> &&callback)
CallbackManager< void(UARTDirection, uint8_t)> debug_callback_
virtual void check_logger_conflict()=0
void set_rx_pin(InternalGPIOPin *rx_pin)
const LogString * parity_to_str(UARTParityOptions parity)
Definition: uart.cpp:33
void write_array(const std::vector< uint8_t > &data)