LIN_slave_SoftwareSerial.cpp

Go to the documentation of this file.

 
// include files
#include <LIN_slave_SoftwareSerial.h>
 
// assert platform which supports SoftwareSerial. Note: ARDUINO_ARCH_ESP32 requires library ESPSoftwareSerial
#if defined(_LIN_SLAVE_SW_SERIAL_H_) 
 
 
/**************************
 * PROTECTED METHODS
**************************/
 
bool LIN_Slave_SoftwareSerial::_getBreakFlag()
{
  // return BREAK detection flag
  return this->flagBreak;
 
} // LIN_Slave_SoftwareSerial::_getBreakFlag()
 
 
 
void LIN_Slave_SoftwareSerial::_resetBreakFlag()
{
  // clear BREAK detection flag
  this->flagBreak = false;
 
} // LIN_Slave_SoftwareSerial::_resetBreakFlag()
 
 
 
/**************************
 * PUBLIC METHODS
**************************/
 
#if defined(ARDUINO_ARCH_RENESAS)   // for Renesas core inverse logic is parameter for begin()
  LIN_Slave_SoftwareSerial::LIN_Slave_SoftwareSerial(uint8_t PinRx, uint8_t PinTx, bool InverseLogic, uint16_t MinFramePause, 
    LIN_Slave_Base::version_t Version, const char NameLIN[], uint32_t TimeoutRx, const int8_t PinTxEN):
    LIN_Slave_Base(Version, NameLIN, TimeoutRx, PinTxEN), SWSerial(PinRx, PinTx)
#else
  LIN_Slave_SoftwareSerial::LIN_Slave_SoftwareSerial(uint8_t PinRx, uint8_t PinTx, bool InverseLogic, uint16_t MinFramePause, 
    LIN_Slave_Base::version_t Version, const char NameLIN[], uint32_t TimeoutRx, const int8_t PinTxEN):
    LIN_Slave_Base(Version, NameLIN, TimeoutRx, PinTxEN), SWSerial(PinRx, PinTx, InverseLogic)
#endif
{  
  // Debug serial initialized in begin() -> no debug output here
 
  // store parameters in class variables
  this->pinRx = PinRx;
  this->pinTx = PinTx;
  this->inverseLogic = InverseLogic;
  this->minFramePause = MinFramePause;
 
} // LIN_Slave_SoftwareSerial::LIN_Slave_SoftwareSerial()
 
 
 
void LIN_Slave_SoftwareSerial::begin(uint16_t Baudrate)
{
  // call base class method
  LIN_Slave_Base::begin(Baudrate);  
 
  // open serial interface incl. used pins. Timeout not required here
  this->SWSerial.end();
  #if defined(ARDUINO_ARCH_RENESAS)
    this->SWSerial.begin(this->baudrate, SERIAL_8N1, this->inverseLogic);
  #else
    this->SWSerial.begin(this->baudrate);
  #endif
 
  // initialize variables
  this->_resetBreakFlag();
 
  // print debug message
  DEBUG_PRINT(2, "ok");
 
} // LIN_Slave_SoftwareSerial::begin()
 
 
 
void LIN_Slave_SoftwareSerial::end()
{
  // call base class method
  LIN_Slave_Base::end();
    
  // close serial interface
  this->SWSerial.end();
 
  // print debug message
  DEBUG_PRINT(2, " ");
 
} // LIN_Slave_SoftwareSerial::end()
 
 
 
void LIN_Slave_SoftwareSerial::handler()
{
  // sync frames based on inter-frame pause (not standard compliant!) 
  static uint32_t   usLastByte = 0;
  
  // byte received -> check it
  if (this->available())
  {
    // ESP32 & ESP8266 (BREAK is dropped due to missing stop bit): if SYNC=0x55 received and long time since last byte, start new frame  
    #if defined(ARDUINO_ARCH_ESP32) || defined(ARDUINO_ARCH_ESP8266)
      if ((this->_serialPeek() == 0x55) && ((micros() - usLastByte) > this->minFramePause))
      {
        // set BREAK flag
        this->flagBreak = true;
 
        // print debug message
        DEBUG_PRINT(3, "BRK detected");
 
      }
 
    // STM32 (BREAK is received, but value !=0x00): if byte received and long time since last byte, start new frame and remove byte from queue
    #elif defined(ARDUINO_ARCH_STM32)
      if ((micros() - usLastByte) > this->minFramePause)
      {
        // set BREAK flag
        this->flagBreak = true;
 
        // remove byte from FiFo buffer
        this->_serialRead();
 
        // print debug message
        DEBUG_PRINT(3, "BRK detected");
 
      }
 
    // other architectures (BREAK is received): if BREAK=0x00 received and long time since last byte, start new frame and remove 0x00 from queue
    #else
      if ((this->_serialPeek() == 0x00) && ((micros() - usLastByte) > this->minFramePause))
      {
        // set BREAK flag
        this->flagBreak = true;
 
        // remove 0x00 from FiFo buffer
        this->_serialRead();
 
        // print debug message
        DEBUG_PRINT(3, "BRK detected");
 
      }
    #endif
 
    // store time of this receive
    usLastByte = micros();
 
    // call base-class handler
    LIN_Slave_Base::handler();
 
    // SoftwareSerial is blocking while sending -> skip reading echo
    if (this->state == LIN_Slave_Base::STATE_RECEIVING_ECHO)
    {
      // propagate to DONE immediately
      this->state = LIN_Slave_Base::STATE_DONE;
 
      // optionally disable RS485 transmitter
      _disableTransmitter();
    }
 
  } // if byte received
 
} // LIN_Slave_SoftwareSerial::handler()
 
 
#endif // _LIN_SLAVE_SW_SERIAL_H_
 
/*-----------------------------------------------------------------------------
    END OF FILE
-----------------------------------------------------------------------------*/