ESPEasy/lib/ESPEasySerial/Port_ESPEasySerial_base.h

#ifndef ESPEASYSERIAL_PORT_ESPEASYSERIAL_BASE_H
#define ESPEASYSERIAL_PORT_ESPEASYSERIAL_BASE_H

#include "ESPEasySerialPort.h"

#include "ESPEasySerial_common_defines.h"
#include "ESPEasySerialConfig.h"

#include <Stream.h>

class Port_ESPEasySerial_base {
public:

  Port_ESPEasySerial_base();
  virtual ~Port_ESPEasySerial_base();

  virtual void   begin(unsigned long baud) = 0;

  virtual void   end()                   = 0;
  virtual int    available(void)         = 0;
  virtual int    availableForWrite(void) = 0;

  // return -1 when data is unavailable (arduino api)
  virtual int    peek(void) = 0;
  virtual int    read(void) = 0;
  virtual size_t read(uint8_t *buffer,
                      size_t   size) = 0;

  inline size_t  read(char *buffer, size_t size)
  {
    return read((uint8_t *)buffer, size);
  }

  virtual void   flush(void)        = 0;
  virtual void   flush(bool txOnly) = 0;
  virtual size_t write(uint8_t)     = 0;
  virtual size_t write(const uint8_t *buffer,
                       size_t         size) = 0;


  inline size_t write(const char *buffer, size_t size)
  {
    return write((uint8_t *)buffer, size);
  }

  inline size_t write(const char *s)
  {
    return (s) ? write((uint8_t *)s, strlen(s)) : 0;
  }

  inline size_t write(unsigned long n)
  {
    return write((uint8_t)n);
  }

  inline size_t write(long n)
  {
    return write((uint8_t)n);
  }

  inline size_t write(unsigned int n)
  {
    return write((uint8_t)n);
  }

  inline size_t write(int n)
  {
    return write((uint8_t)n);
  }

  virtual int getBaudRate() const;

  virtual operator bool() const = 0;

  virtual void   setDebugOutput(bool) = 0;


  // Set buffer size, should be called before calling begin()
  virtual size_t setRxBufferSize(size_t new_size) = 0;
  virtual size_t setTxBufferSize(size_t new_size) = 0;
  virtual bool   setRS485Mode(int8_t rtsPin, bool enableCollisionDetection) = 0;



  const ESPEasySerialConfig& getSerialConfig() const {
    return _config;
  }

#ifdef ESP8266
  void setPortConfig(unsigned long baud,
                     SerialConfig  config,
                     SerialMode    mode)
  {
    _config.setPortConfig(baud, config, mode);
  }

#endif // ifdef ESP8266

#ifdef ESP32
  void setPortConfig(unsigned long baud, uint32_t config)
  {
    _config.setPortConfig(baud, config);
  }

#endif // ifdef ESP32

  virtual String getPortDescription() const;

protected:

  ESPEasySerialConfig _config;
};


#endif // ifndef ESPEASYSERIAL_PORT_ESPEASYSERIAL_BASE_H