Merge pull request #523 from sparkfun/release_candidate

Patch v2.0

Author: nseidle

Firmware/LoRaSerial/Commands.ino

@@ -87,7 +87,7 @@ bool commandAT(const char * commandString)
       case ('B'): //ATB - Break the link
 
         //Compute the time delay
-        delayMillis = (VC_LINK_BREAK_MULTIPLIER + 2) * settings.heartbeatTimeout;
+        delayMillis = (LINK_BREAK_MULTIPLIER + 2) * settings.heartbeatTimeout;
 
         //Warn the user of the delay
         systemPrint("Delaying ");
@@ -111,7 +111,7 @@ bool commandAT(const char * commandString)
         //Idle the system to break the link
         //This is required on the server system which does not request an VC number assignment
         timer = millis();
-        while ((millis() - timer) < ((VC_LINK_BREAK_MULTIPLIER + 2) * settings.heartbeatTimeout))
+        while ((millis() - timer) < ((LINK_BREAK_MULTIPLIER + 2) * settings.heartbeatTimeout))
           petWDT();
         changeState(RADIO_RESET);
 
@@ -224,11 +224,11 @@ bool commandAT(const char * commandString)
         systemPrintln("  ATI8 - Display system unique ID");
         systemPrintln("  ATI9 - Display the maximum datagram size");
         systemPrintln("  ATI10 - Display radio metrics");
-        systemPrintln("  ATI11 - Return myVc value");
-        systemPrintln("  ATI12 - Display the VC details");
-        systemPrintln("  ATI13 - Display the SX1276 registers");
-        systemPrintln("  ATI14 - Dump the radioTxBuffer");
-        systemPrintln("  ATI15 - Dump the NVM unique ID table");
+
+        //Virtual circuit information commands
+        systemPrintln("  ATI30 - Return myVc value");
+        systemPrintln("  ATI31 - Display the VC details");
+        systemPrintln("  ATI32 - Dump the NVM unique ID table");
         return true;
 
       case ('0'): //ATI0 - Show user settable parameters
@@ -601,14 +601,22 @@ bool commandAT(const char * commandString)
         systemPrintln("    State History");
         displayRadioStateHistory();
         return true;
+    }
+  }
+  if ((commandString[2] == 'I') && (commandString[3] == '3') && (commandLength == 5))
+  {
+    switch (commandString[4])
+    {
+      default:
+        return false;
 
-      case ('1'): //ATI11 - Return myVc value
+      case ('0'): //ATI30 - Return myVc value
         systemPrintln();
         systemPrint("myVc: ");
         systemPrintln(myVc);
         return true;
 
-      case ('2'): //ATI12 - Display the VC details
+      case ('1'): //ATI31 - Display the VC details
         systemPrintTimestamp();
         systemPrint("VC ");
         systemPrint(cmdVc);
@@ -706,16 +714,7 @@ bool commandAT(const char * commandString)
         }
         return true;
 
-      case ('3'): //ATI13 - Display the SX1276 registers
-        printSX1276Registers();
-        return true;
-
-      case ('4'): //ATI14 - Dump the radioTxBuffer
-        systemPrintln("radioTxBuffer:");
-        dumpCircularBuffer(radioTxBuffer, radioTxTail, sizeof(radioTxBuffer), availableRadioTXBytes());
-        return true;
-
-      case ('5'): //ATI15 - Dump the NVM unique ID table
+      case ('2'): //ATI32 - Dump the NVM unique ID table
         systemPrintln("NVM Unique ID Table");
         for (vcIndex = 0; vcIndex < MAX_VC; vcIndex++)
         {
@@ -736,6 +735,33 @@ bool commandAT(const char * commandString)
         return true;
     }
   }
+  if ((commandString[2] == 'I') && (commandString[3] == '5') && (commandLength == 5))
+  {
+    switch (commandString[4])
+    {
+      default:
+        return false;
+
+      case ('0'): //ATI50 - Output 80000 bytes, stop when serial is full
+        for (uint16_t line = 0; line < 1000; line++)
+        {
+          const char * text = "ABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUVWXYZABCDEFGHIJKLMNOPQRSTUV";
+
+          if (line < 100)
+            systemWrite('0');
+          if (line < 10)
+            systemWrite('0');
+          systemPrint(line);
+          systemWrite(':');
+          systemPrintln(text);
+        }
+        return true;
+
+      case ('1'): //ATI51 - Display the SX1276 registers
+        printSX1276Registers();
+        return true;
+    }
+  }
 
   //Invalid command
   return false;
@@ -1165,6 +1191,8 @@ const COMMAND_ENTRY commands[] =
   {'S',   0,   0,    0,   1,    0, TYPE_BOOL,         valInt,         "FlowControl",          &tempSettings.flowControl},
   {'S',   0,   0,    0,   1,    0, TYPE_BOOL,         valInt,         "InvertCts",            &tempSettings.invertCts},
   {'S',   0,   0,    0,   1,    0, TYPE_BOOL,         valInt,         "InvertRts",            &tempSettings.invertRts},
+  {'S',   0,   0,    0, SERIAL_RX_BUFFER_SIZE, 0, TYPE_U16, valInt,   "RTSOffBytes",            &tempSettings.rtsOffBytes},
+  {'S',   0,   0,    0, SERIAL_RX_BUFFER_SIZE, 0, TYPE_U16, valInt,   "RTSOnBytes",            &tempSettings.rtsOnBytes},
   {'S',   0,   0,   10, 2000,   0, TYPE_U16,          valInt,         "SerialDelay",          &tempSettings.serialTimeoutBeforeSendingFrame_ms},
   {'S',   0,   0,    0,   0,    0, TYPE_SPEED_SERIAL, valSpeedSerial, "SerialSpeed",          &tempSettings.serialSpeed},
   {'S',   0,   0,    0,   1,    0, TYPE_BOOL,         valInt,         "UsbSerialWait",        &tempSettings.usbSerialWait},

Firmware/LoRaSerial/LoRaSerial.ino

@@ -82,6 +82,9 @@ const int FIRMWARE_VERSION_MINOR = 0;
 #define ENABLE_DEVELOPER false
 #endif  //ENABLE_DEVELOPER
 
+#define SERIAL_RX_BUFFER_SIZE     1024
+#define RTS_ON_BYTES              (SERIAL_RX_BUFFER_SIZE / 4)
+
 #include "settings.h"
 
 //Hardware connections
@@ -195,7 +198,7 @@ const uint8_t responseDelayDivisor = 4; //Add on to max response time after pack
 //Buffer to receive serial data from the USB or serial ports
 uint16_t rxHead = 0;
 uint16_t rxTail = 0;
-uint8_t serialReceiveBuffer[1024];
+uint8_t serialReceiveBuffer[SERIAL_RX_BUFFER_SIZE];
 
 //Buffer to store bytes for transmission via the long range radio
 uint16_t radioTxHead = 0;
@@ -490,6 +493,7 @@ bool trainingPreviousRxInProgress = false; //Previous RX status
 float originalChannel; //Original channel from HOP table while training is in progress
 uint8_t trainingPartnerID[UNIQUE_ID_BYTES]; //Unique ID of the training partner
 uint8_t myUniqueId[UNIQUE_ID_BYTES]; // Unique ID of this system
+uint32_t buttonPressedTime;
 
 //Virtual-Circuit
 int8_t cmdVc;   //VC index for ATI commands only

Firmware/LoRaSerial/Radio.ino

@@ -2355,7 +2355,7 @@ PacketType rcvDatagram()
 // * Received datagramType
 // * DATAGRAM_DUPLICATE
 // * DATAGRAM_BAD
-PacketType validateDatagram(VIRTUAL_CIRCUIT * vc, PacketType datagramType, uint8_t ackNumber, uint16_t freeBytes)
+PacketType validateDatagram(VIRTUAL_CIRCUIT * vc, PacketType datagramType, uint8_t ackNumber, int freeBytes)
 {
   if (ackNumber != vc->rmtTxAckNumber)
   {
@@ -2393,12 +2393,12 @@ PacketType validateDatagram(VIRTUAL_CIRCUIT * vc, PacketType datagramType, uint8
   }
 
   //Verify that there is sufficient space in the serialTransmitBuffer
-  if (inCommandMode || ((sizeof(serialTransmitBuffer) - availableTXBytes()) < rxDataBytes))
+  if (inCommandMode || (freeBytes < rxDataBytes))
   {
     if (settings.debugReceive || settings.debugDatagrams)
     {
       systemPrintTimestamp();
-      systemPrintln("Insufficient space in the serialTransmitBuffer");
+      systemPrintln("Insufficient space in the receive buffer");
     }
     insufficientSpace++;
 

Firmware/LoRaSerial/Serial.ino

@@ -14,7 +14,8 @@ bool isCTS()
 {
   if (pin_cts == PIN_UNDEFINED) return (true); //CTS not implmented on this board
   if (settings.flowControl == false) return (true); //CTS turned off
-  return (digitalRead(pin_cts) == HIGH) ^ settings.invertCts;
+  //The SAMD21 specification (page 448) indicates that CTS is low when data is flowing
+  return (digitalRead(pin_cts) == LOW) ^ settings.invertCts;
 }
 
 #define NEXT_RX_TAIL(n)   ((rxTail + n) % sizeof(serialReceiveBuffer))
@@ -35,6 +36,10 @@ void serialBufferOutput(uint8_t * data, uint16_t dataLength)
 {
   int length;
 
+  //Make sure there is enough room in the buffer
+  if ((sizeof(serialTransmitBuffer) - availableTXBytes()) < (dataLength + 32))
+    outputSerialData(true);
+
   length = 0;
   if ((txHead + dataLength) > sizeof(serialTransmitBuffer))
   {
@@ -55,6 +60,10 @@ void serialOutputByte(uint8_t data)
 {
   if (printerEndpoint == PRINT_TO_SERIAL)
   {
+    //Make sure there is enough room in the buffer
+    if ((sizeof(serialTransmitBuffer) - availableTXBytes()) < 32)
+      outputSerialData(true);
+
     //Add this byte to the serial output buffer
     serialTransmitBuffer[txHead++] = data;
     txHead %= sizeof(serialTransmitBuffer);
@@ -72,7 +81,8 @@ void updateRTS(bool assertRTS)
 {
   rtsAsserted = assertRTS;
   if (settings.flowControl && (pin_rts != PIN_UNDEFINED))
-    digitalWrite(pin_rts, assertRTS ^ settings.invertRts);
+    //The SAMD21 specification (page 448) indicates that RTS is low to enable data flow
+    digitalWrite(pin_rts, (assertRTS ? 0 : 1) ^ settings.invertRts);
 }
 
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
@@ -283,35 +293,37 @@ uint8_t readyOutgoingCommandPacket(uint16_t offset)
 //Scan for escape characters
 void updateSerial()
 {
+  int bufferSpace;
   uint16_t previousHead;
   int x;
 
   //Assert RTS when there is enough space in the receive buffer
   if ((!rtsAsserted) && (availableRXBytes() < (sizeof(serialReceiveBuffer) / 2))
-      && (availableTXBytes() < (sizeof(serialTransmitBuffer) / 4)))
+      && (availableTXBytes() <= RTS_ON_BYTES))
     updateRTS(true);
 
   //Attempt to empty the serialTransmitBuffer
   outputSerialData(false);
 
   //Look for local incoming serial
   previousHead = rxHead;
-  while (rtsAsserted && arch.serialAvailable() && (transactionComplete == false))
+  bufferSpace = sizeof(serialReceiveBuffer) - 1 - availableRXBytes();
+  while (bufferSpace-- && arch.serialAvailable() && (transactionComplete == false))
   {
     blinkSerialRxLed(true); //Turn on LED during serial reception
 
     //Take a break if there are ISRs to attend to
     petWDT();
     if (timeToHop == true) hopChannel();
 
-    //Deassert RTS when the buffer gets full
-    if (rtsAsserted && (sizeof(serialReceiveBuffer) - availableRXBytes()) < 32)
-      updateRTS(false);
-
     byte incoming = systemRead();
 
     serialReceiveBuffer[rxHead++] = incoming; //Push char to holding buffer
     rxHead %= sizeof(serialReceiveBuffer);
+
+    //Deassert RTS when the buffer gets full
+    if (rtsAsserted && (sizeof(serialReceiveBuffer) - availableRXBytes()) <= settings.rtsOffBytes)
+      updateRTS(false);
   } //End Serial.available()
   blinkSerialRxLed(false); //Turn off LED
 
@@ -417,7 +429,6 @@ void processSerialInput()
             commandLength--;
 
             //Erase the previous character
-            systemWrite(incoming);
             systemWrite(' ');
             systemWrite(incoming);
           }
@@ -931,10 +942,8 @@ void resetSerial()
 
   //Empty the buffers
   rxHead = rxTail;
-  radioTxHead = radioTxTail;
   txHead = txTail;
   commandRXHead = commandRXTail;
   commandTXHead = commandTXTail;
-  endOfTxData = &outgoingPacket[headerBytes];
   commandLength = 0;
 }

Firmware/LoRaSerial/States.ino

@@ -727,6 +727,14 @@ void updateRadioState()
             triggerEvent(TRIGGER_RX_DATA);
 
             //Place the data in the serial output buffer
+            if (settings.debugSerial)
+            {
+              systemPrint("Moving ");
+              systemPrint(rxDataBytes);
+              systemPrintln(" from incomingBuffer to serialTransmitBuffer");
+              dumpBuffer(rxData, length);
+              outputSerialData(true);
+            }
             serialBufferOutput(rxData, rxDataBytes);
 
             //Transmit ACK
@@ -756,6 +764,16 @@ void updateRadioState()
           case DATAGRAM_REMOTE_COMMAND:
             triggerEvent(TRIGGER_RX_COMMAND);
 
+            //Debug the remote command operation
+            if (settings.debugSerial)
+            {
+              systemPrint("Moving ");
+              systemPrint(rxDataBytes);
+              systemPrintln(" from incomingBuffer to commandRXBuffer");
+              dumpBuffer(rxData, length);
+              outputSerialData(true);
+            }
+
             //Determine the number of bytes received
             length = 0;
             if ((commandRXHead + rxDataBytes) > sizeof(commandRXBuffer))
@@ -778,9 +796,16 @@ void updateRadioState()
           case DATAGRAM_REMOTE_COMMAND_RESPONSE:
             triggerEvent(TRIGGER_RX_COMMAND_RESPONSE);
 
-            //Print received data. This is blocking but we do not use the serialTransmitBuffer because we're in command mode (and it's not much data to print).
-            for (int x = 0 ; x < rxDataBytes ; x++)
-              Serial.write(rxData[x]);
+            //Print received data.
+            if (settings.debugSerial)
+            {
+              systemPrint("Moving ");
+              systemPrint(rxDataBytes);
+              systemPrintln(" from incomingBuffer to serialTransmitBuffer");
+              dumpBuffer(rxData, length);
+              outputSerialData(true);
+            }
+            serialBufferOutput(rxData, rxDataBytes);
 
             //Transmit ACK
             P2P_SEND_ACK(TRIGGER_TX_ACK);
@@ -969,7 +994,7 @@ void updateRadioState()
       //----------
       //Always check for link timeout
       //----------
-      if ((millis() - linkDownTimer) >= (P2P_LINK_BREAK_MULTIPLIER * settings.heartbeatTimeout))
+      if ((millis() - linkDownTimer) >= (LINK_BREAK_MULTIPLIER * settings.heartbeatTimeout))
         //Break the link
         breakLink();
       break;
@@ -2472,7 +2497,7 @@ void updateRadioState()
         //Determine if the link has timed out
         vc = &virtualCircuitList[index];
         if ((vc->vcState != VC_STATE_LINK_DOWN) && (serverLinkBroken
-            || ((currentMillis - vc->lastTrafficMillis) > (VC_LINK_BREAK_MULTIPLIER * settings.heartbeatTimeout))))
+            || ((currentMillis - vc->lastTrafficMillis) > (LINK_BREAK_MULTIPLIER * settings.heartbeatTimeout))))
         {
           if (index == VC_SERVER)
           {
@@ -2898,7 +2923,10 @@ void breakLink()
   }
 
   //Flush the buffers
-  resetSerial();
+  if (!inCommandMode)
+    resetSerial();
+  radioTxHead = radioTxTail;
+  endOfTxData = &outgoingPacket[headerBytes];
 
   //Reset the radio and the link
   triggerEvent(TRIGGER_RADIO_RESET);
@@ -3063,7 +3091,11 @@ void vcBreakLink(int8_t vcIndex)
   //Flush the buffers
   outputSerialData(true);
   if (vcIndex == myVc)
+  {
     resetSerial();
+    radioTxHead = radioTxTail;
+    endOfTxData = &outgoingPacket[headerBytes];
+  }
 }
 
 //Place VC in LINK-UP state since it is receiving HEARTBEATs from the remote radio