LIN_master_HardwareSerial.cpp

Go to the documentation of this file.

 
// include files
#include <LIN_master_HardwareSerial.h>
 
 
LIN_Master_Base::state_t LIN_Master_HardwareSerial::_sendBreak(void)
{
  // if state is wrong, exit immediately
  if (this->state != LIN_Master_Base::STATE_IDLE)
  {
    // print debug message
    DEBUG_PRINT(1, "wrong state 0x%02X", this->state);
 
    // set error state and return immediately
    this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) LIN_Master_Base::ERROR_STATE);
    this->state = LIN_Master_Base::STATE_DONE;
    this->_disableTransmitter();
    return this->state;
  }
 
  // empty buffers, just in case...
  this->pSerial->flush();
  while (this->pSerial->available())
    this->pSerial->read();
 
  // set half baudrate for BREAK (w/o timeout)
  this->pSerial->begin(this->baudrate >> 1);
  while(!(*(this->pSerial)));
  
  // optionally enable transmitter
  this->_enableTransmitter();
 
  // send BREAK (>=13 bit low)
  this->pSerial->write(this->bufTx[0]);
 
  // progress state
  this->state = LIN_Master_Base::STATE_BREAK;
 
  // print debug message
  DEBUG_PRINT(3, " ");
 
  // return state
  return this->state;
 
} // LIN_Master_HardwareSerial::_sendBreak()
 
 
 
LIN_Master_Base::state_t LIN_Master_HardwareSerial::_sendFrame(void)
{
  // if state is wrong, exit immediately
  if (this->state != LIN_Master_Base::STATE_BREAK)
  {
    // print debug message
    DEBUG_PRINT(1, "wrong state 0x%02X", this->state);
 
    // set error state and return immediately
    this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) LIN_Master_Base::ERROR_STATE);
    this->state = LIN_Master_Base::STATE_DONE;
    this->_disableTransmitter();
    return this->state;
  }
 
  // byte(s) received (likely BREAK echo)
  if (this->pSerial->available())
  {
    // store echo in Rx
    this->bufRx[0] = this->pSerial->read();
 
    // restore nominal baudrate (w/o timeout)
    this->pSerial->begin(this->baudrate);
    while(!(*(this->pSerial)));
 
    // send rest of frame (request frame: SYNC+ID+DATA[]+CHK; response frame: SYNC+ID)
    this->pSerial->write(this->bufTx+1, this->lenTx-1);
 
    // progress state
    this->state = LIN_Master_Base::STATE_BODY;
 
  } // BREAK echo received
  
  // no byte(s) received
  else
  {
    // check for timeout
    if (micros() - this->timeStart > this->timeoutFrame)
    {
      // print debug message
      DEBUG_PRINT(1, "Rx timeout");
 
      // set error state and return immediately
      this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) LIN_Master_Base::ERROR_TIMEOUT);
      this->state = LIN_Master_Base::STATE_DONE;
      this->_disableTransmitter();
      return this->state;
    }
 
  } // no byte(s) received
  
  // print debug message
  DEBUG_PRINT(2, " ");
  
  // return state
  return this->state;
 
} // LIN_Master_HardwareSerial::_sendFrame()
 
 
 
LIN_Master_Base::state_t LIN_Master_HardwareSerial::_receiveFrame(void)
{
  // if state is wrong, exit immediately
  if (this->state != LIN_Master_Base::STATE_BODY)
  {
    // print debug message
    DEBUG_PRINT(1, "wrong state 0x%02X", this->state);
 
    // set error state and return immediately
    this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) LIN_Master_Base::ERROR_STATE);
    this->state = LIN_Master_Base::STATE_DONE;
    this->_disableTransmitter();
    return this->state;
  }
 
  // optionally disable transmitter for slave response frames. Len==2 because BREAK is handled already handled in _sendFrame()
  if ((this->type == LIN_Master_Base::SLAVE_RESPONSE) && (this->pSerial->available() == 2))
    this->_disableTransmitter();
 
  // frame body received (-1 because BREAK is handled already handled in _sendFrame())
  if (this->pSerial->available() >= this->lenRx-1)
  {
    // store bytes in Rx
    this->pSerial->readBytes(this->bufRx+1, this->lenRx-1);
 
    // check frame for errors
    this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) this->_checkFrame());
 
    // optionally disable transmitter after frame is completed
    this->_disableTransmitter();
 
    // progress state
    this->state = LIN_Master_Base::STATE_DONE;
 
  } // frame body received
  
  // frame body received not yet received
  else
  {
    // check for timeout
    if (micros() - this->timeStart > this->timeoutFrame)
    {
      // print debug message
      DEBUG_PRINT(1, "Rx timeout");
 
      // set error state and return immediately
      this->error = (LIN_Master_Base::error_t) ((int) this->error | (int) LIN_Master_Base::ERROR_TIMEOUT);
      this->state = LIN_Master_Base::STATE_DONE;
      this->_disableTransmitter();
      return this->state;
    }
 
  } // not enough bytes received
  
  // print debug message
  DEBUG_PRINT(2, " ");
  
  // return state
  return this->state;
 
} // LIN_Master_HardwareSerial::_receiveFrame()
 
 
LIN_Master_HardwareSerial::LIN_Master_HardwareSerial(HardwareSerial &Interface, const char NameLIN[], const int8_t PinTxEN) : 
  LIN_Master_Base::LIN_Master_Base(NameLIN, PinTxEN)
{
  // Debug serial initialized in begin() -> no debug output here
 
  // store pointer to used HW serial
  this->pSerial = &Interface;
 
  // must not open connection here, else (at least) ESP32 and ESP8266 fail
 
} // LIN_Master_HardwareSerial::LIN_Master_HardwareSerial()
 
 
 
void LIN_Master_HardwareSerial::begin(uint16_t Baudrate)
{  
  // call base class method
  LIN_Master_Base::begin(Baudrate);
 
  // open serial interface with optional timeout
  this->pSerial->begin(this->baudrate);
  #if defined(LIN_MASTER_LIN_PORT_TIMEOUT) && (LIN_MASTER_LIN_PORT_TIMEOUT > 0)
    uint32_t startMillis = millis();
    while ((!(*(this->pSerial))) && (millis() - startMillis < LIN_MASTER_LIN_PORT_TIMEOUT));
  #else
    while(!(*(this->pSerial)));
  #endif
 
  // print debug message
  DEBUG_PRINT(2, "ok");
 
} // LIN_Master_HardwareSerial::begin()
 
 
 
void LIN_Master_HardwareSerial::end()
{
  // call base class method
  LIN_Master_Base::end();
    
  // close serial interface
  this->pSerial->end();
 
  // print debug message
  DEBUG_PRINT(2, " ");
 
} // LIN_Master_HardwareSerial::end()
 
/*-----------------------------------------------------------------------------
    END OF FILE
-----------------------------------------------------------------------------*/