uart_component_esp8266.h

Go to the documentation of this file.

#pragma once
 
#ifdef USE_ESP8266
 
#include <HardwareSerial.h>
#include <vector>
#include "esphome/core/component.h"
#include "esphome/core/hal.h"
#include "esphome/core/log.h"
#include "software_serial_rx_decoder.h"
#include "uart_component.h"
 
namespace esphome::uart {
 
class ESP8266SoftwareSerial {
 public:
  void setup(InternalGPIOPin *tx_pin, InternalGPIOPin *rx_pin, uint32_t baud_rate, uint8_t stop_bits,
             uint32_t data_bits, UARTParityOptions parity, size_t rx_buffer_size);
 
  uint8_t read_byte();
  uint8_t peek_byte();
 
  void flush();
 
  void write_byte(uint8_t data);
 
  size_t available();
 
 protected:
  static void gpio_intr(ESP8266SoftwareSerial *arg);
  static void gpio_intr_edge(ESP8266SoftwareSerial *arg);
 
  void wait_(uint32_t *wait, const uint32_t &start, uint32_t bit_time);
  bool read_bit_(uint32_t *wait, const uint32_t &start, uint32_t bit_time);
  void write_bit_(bool bit, uint32_t *wait, const uint32_t &start, uint32_t bit_time);
 
  void rx_finalize_pending_();
  void ESPHOME_ALWAYS_INLINE rx_sync_() {
    if (this->rx_.pending())
      this->rx_finalize_pending_();
  }
 
  // Members ordered largest to smallest to minimize padding
  uint32_t bit_time_{0};
  InternalGPIOPin *gpio_tx_pin_{nullptr};
  ISRInternalGPIOPin tx_pin_;
  InternalGPIOPin *gpio_rx_pin_{nullptr};
  ISRInternalGPIOPin rx_pin_;
  SoftwareSerialRxDecoder rx_;
  UARTParityOptions parity_;
  uint8_t stop_bits_;
  uint8_t data_bits_;
};
 
class ESP8266UartComponent final : public UARTComponent, public Component {
 public:
  void setup() override;
  void dump_config() override;
  float get_setup_priority() const override { return setup_priority::BUS; }
 
  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;
  size_t available_for_write() override;
  UARTFlushResult flush() override;
 
  uint32_t get_config();
 
  void load_settings(bool dump_config) override;
  using UARTComponent::load_settings;  // also bring in the no-arg overload for convenience
 
 protected:
  void check_logger_conflict() override;
 
  HardwareSerial *hw_serial_{nullptr};
  ESP8266SoftwareSerial *sw_serial_{nullptr};
 
 private:
  static bool serial0_in_use;   // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
  static bool serial0_swapped;  // NOLINT(cppcoreguidelines-avoid-non-const-global-variables)
};
 
}  // namespace esphome::uart
#endif  // USE_ESP8266