LIN_slave_SoftwareSerial.h

Go to the documentation of this file.

 
// assert platform which supports SoftwareSerial. Note: ARDUINO_ARCH_ESP32 requires library ESPSoftwareSerial
#if defined(ARDUINO_ARCH_AVR) || defined(ARDUINO_ARCH_ESP8266) || defined(ARDUINO_ARCH_ESP32) || \
  defined(ARDUINO_ARCH_MEGAAVR) || defined(ARDUINO_ARCH_STM32) || defined(ARDUINO_ARCH_RENESAS)
 
/*-----------------------------------------------------------------------------
  MODULE DEFINITION FOR MULTIPLE INCLUSION
-----------------------------------------------------------------------------*/
#ifndef _LIN_SLAVE_SW_SERIAL_H_
#define _LIN_SLAVE_SW_SERIAL_H_
 
 
/*-----------------------------------------------------------------------------
  INCLUDE FILES
-----------------------------------------------------------------------------*/
 
// include required libraries
#include <LIN_slave_Base.h>
#include <SoftwareSerial.h>
 
 
/*-----------------------------------------------------------------------------
  GLOBAL CLASS
-----------------------------------------------------------------------------*/
 
class LIN_Slave_SoftwareSerial : public LIN_Slave_Base
{
  // PRIVATE VARIABLES
  private:
 
    SoftwareSerial        SWSerial;           
    uint8_t               pinRx;              
    uint8_t               pinTx;              
    bool                  inverseLogic;       
    bool                  flagBreak;          
    uint16_t              minFramePause;      
 
 
  // PROTECTED METHODS
  protected:
 
    bool _getBreakFlag(void);
 
    void _resetBreakFlag(void);
 
 
    inline uint8_t _serialPeek(void) { return this->SWSerial.peek(); }
 
    inline uint8_t _serialRead(void) { return this->SWSerial.read(); }
 
    inline void _serialWrite(uint8_t buf[], uint8_t num)
    { 
      // Renesas does not support stopListening()/listen()
      #if defined(ARDUINO_ARCH_RENESAS)
        this->SWSerial.write(buf, num); 
        this->SWSerial.flush();
      
      // Disable receive to avoid inter-byte pauses on AVR
      #else
        this->SWSerial.stopListening();
        this->SWSerial.write(buf, num); 
        this->SWSerial.flush();
        this->SWSerial.listen();
      #endif
    }
 
 
  // PUBLIC METHODS
  public:
 
    LIN_Slave_SoftwareSerial(uint8_t PinRx, uint8_t PinTx, bool InverseLogic = false, uint16_t MinFramePause=1000L, 
      LIN_Slave_Base::version_t Version = LIN_Slave_Base::LIN_V2, const char NameLIN[] = "Slave", uint32_t TimeoutRx = 1500L, const int8_t PinTxEN = INT8_MIN);
 
    void begin(uint16_t Baudrate = 19200);
    
    void end(void);
 
    inline bool available(void) { return this->SWSerial.available(); }
 
    virtual void handler(void);
 
}; // class LIN_Slave_SoftwareSerial
 
 
/*-----------------------------------------------------------------------------
    END OF MODULE DEFINITION FOR MULTIPLE INLUSION
-----------------------------------------------------------------------------*/
#endif // _LIN_MASTER_SW_SERIAL_H_
 
#else // ARDUINO_ARCH_AVR || ARDUINO_ARCH_ESP8266 || ARDUINO_ARCH_ESP32 || ARDUINO_ARCH_MEGAAVR || ARDUINO_ARCH_STM32 || ARDUINO_ARCH_RENESAS
 
  #error architecture not yet supported
 
#endif
 
/*-----------------------------------------------------------------------------
    END OF FILE
-----------------------------------------------------------------------------*/