improve input buffer validity and cleaning

Author: fabik111

src/ConfiguratorAgents/agents/BLE/BLEAgent.cpp

@@ -110,7 +110,7 @@ ConfiguratorAgent::AgentConfiguratorStates BLEAgentClass::poll() {
       }
       break;
     case BLEEvent::DISCONNECTED:
-      _inputStreamCharacteristic.writeValue("");
+      clearInputBuffer();
       clear();
       _state = AgentConfiguratorStates::INIT;
       break;
@@ -190,15 +190,16 @@ int BLEAgentClass::writeBytes(const uint8_t *data, size_t len) {
 void BLEAgentClass::handleDisconnectRequest() {
 }
 
+void BLEAgentClass::clearInputBuffer() {
+  // clear the input buffer
+  _inputStreamCharacteristic.writeValue("");
+}
+
 ConfiguratorAgent::AgentConfiguratorStates BLEAgentClass::handlePeerConnected() {
   AgentConfiguratorStates nextState = _state;
 
   TransmissionResult res = sendAndReceive();
   switch (res) {
-    case TransmissionResult::INVALID_DATA:
-      // clear the input buffer
-      _inputStreamCharacteristic.writeValue("");
-      break;
     case TransmissionResult::PEER_NOT_AVAILABLE:
       disconnectPeer();
       nextState = AgentConfiguratorStates::INIT;
@@ -246,7 +247,7 @@ bool BLEAgentClass::setManufacturerData() {
 
 
 void BLEAgentClass::disconnectPeer() {
-  _inputStreamCharacteristic.writeValue("");
+  clearInputBuffer();
   uint32_t start = millis();
   BLE.disconnect();
   do {

src/ConfiguratorAgents/agents/BLE/BLEAgent.h

@@ -56,6 +56,7 @@ class BLEAgentClass : public ConfiguratorAgent, BoardConfigurationProtocol {
   uint8_t readByte();
   int writeBytes(const uint8_t *data, size_t len);
   void handleDisconnectRequest();
+  void clearInputBuffer();
 };
 
 extern BLEAgentClass BLEAgent;

src/ConfiguratorAgents/agents/BoardConfigurationProtocol/BoardConfigurationProtocol.cpp

@@ -115,6 +115,7 @@ BoardConfigurationProtocol::TransmissionResult BoardConfigurationProtocol::sendA
       if (res == PacketManager::ReceivingState::ERROR) {
         DEBUG_DEBUG("BoardConfigurationProtocol::%s Error receiving packet", __FUNCTION__);
         sendNak();
+        clearInputBuffer();
         transmissionRes = TransmissionResult::INVALID_DATA;
         break;
       } else if (res == PacketManager::ReceivingState::RECEIVED) {

src/ConfiguratorAgents/agents/BoardConfigurationProtocol/BoardConfigurationProtocol.h

@@ -35,6 +35,7 @@ class BoardConfigurationProtocol {
   virtual int writeBytes(const uint8_t *data, size_t len) = 0;
   virtual void handleDisconnectRequest() = 0;
   virtual bool isPeerConnected() = 0;
+  virtual void clearInputBuffer() = 0;
 
 private:
   bool sendStatus(StatusMessage msg);

src/ConfiguratorAgents/agents/BoardConfigurationProtocol/PacketManager.cpp

@@ -25,6 +25,7 @@ uint8_t PACKET_END[] = { 0xaa, 0x55 };
 #define CRC16_FINAL_XOR_VALUE 0xffff
 #define CRC16_REFLECT_DATA true
 #define CRC16_REFLECT_RESULT true
+#define BYTES_VALIDITY_MS 10000
 
 bool PacketManager::createPacket(OutputPacketBuffer &outputMsg, MessageType type, const uint8_t *data, size_t len) {
   uint16_t packetLen = len + PACKET_HEADERS_OVERHEAD;
@@ -61,6 +62,12 @@ PacketManager::ReceivingState PacketManager::handleReceivedByte(ReceivedData &re
     _state = ReceivingState::WAITING_HEADER;
   }
 
+  if (millis() - _lastByteReceivedTs > BYTES_VALIDITY_MS) {
+    clearInputBuffers();
+  }
+
+  _lastByteReceivedTs = millis();
+
   switch (_state) {
     case ReceivingState::WAITING_HEADER:  _state = handle_WaitingHeader (byte); break;
     case ReceivingState::WAITING_PAYLOAD: _state = handle_WaitingPayload(byte); break;
@@ -89,6 +96,7 @@ void PacketManager::clear() {
 }
 
 void PacketManager::clearInputBuffers() {
+  _lastByteReceivedTs = 0;
   _tempInputMessageHeader.clear();
   _tempInputMessagePayload.reset();
   _tempInputMessageEnd.clear();

src/ConfiguratorAgents/agents/BoardConfigurationProtocol/PacketManager.h

@@ -33,6 +33,7 @@ class PacketManager {
   InputPacketBuffer _tempInputMessageHeader;
   InputPacketBuffer _tempInputMessagePayload;
   InputPacketBuffer _tempInputMessageEnd;
+  uint32_t _lastByteReceivedTs = 0;
 
   ReceivingState handle_WaitingHeader(uint8_t byte);
   ReceivingState handle_WaitingPayload(uint8_t byte);

src/ConfiguratorAgents/agents/Serial/SerialAgent.cpp

@@ -96,6 +96,7 @@ ConfiguratorAgent::AgentConfiguratorStates SerialAgentClass::handleInit() {
       } else if (res == PacketManager::ReceivingState::ERROR) {
         DEBUG_DEBUG("SerialAgentClass::%s Error receiving packet", __FUNCTION__);
         Packet.clear();
+        clearInputBuffer();
       }
     }
   }
@@ -143,4 +144,10 @@ void SerialAgentClass::handleDisconnectRequest() {
   _disconnectRequest = true;
 }
 
+void SerialAgentClass::clearInputBuffer() {
+  while (Serial.available()) {
+    Serial.read();
+  }
+}
+
 SerialAgentClass SerialAgent;

src/ConfiguratorAgents/agents/Serial/SerialAgent.h

@@ -39,6 +39,7 @@ class SerialAgentClass : public ConfiguratorAgent, BoardConfigurationProtocol {
   uint8_t readByte();
   int writeBytes(const uint8_t *data, size_t len);
   void handleDisconnectRequest();
+  void clearInputBuffer();
 };
 
 extern SerialAgentClass SerialAgent;