Merge pull request #524 from sparkfun/release_candidate

Add comments to flow control calls

Author: nseidle

Firmware/LoRaSerial/LoRaSerial.ino

@@ -643,7 +643,7 @@ void setup()
 
   arch.beginWDT(); //Start watchdog timer
 
-  updateRTS(true); //Enable serial input
+  updateRTS(true); //We're ready for more data
 
   systemPrintTimestamp();
   systemPrintln("LRS");

Firmware/LoRaSerial/Serial.ino

@@ -76,7 +76,10 @@ void serialOutputByte(uint8_t data)
   }
 }
 
-//Update the output of the RTS pin (host says it's ok to send data when assertRTS = true)
+//Update the output of the RTS pin
+//LoRaSerial will drive RTS low when it is ready for data
+//Given false, we tell the host we *do not* need more data
+//Given true, we tell the host we are ready for more data
 void updateRTS(bool assertRTS)
 {
   rtsAsserted = assertRTS;
@@ -300,7 +303,7 @@ void updateSerial()
   //Assert RTS when there is enough space in the receive buffer
   if ((!rtsAsserted) && (availableRXBytes() < (sizeof(serialReceiveBuffer) / 2))
       && (availableTXBytes() <= RTS_ON_BYTES))
-    updateRTS(true);
+    updateRTS(true); //We're ready for more data
 
   //Attempt to empty the serialTransmitBuffer
   outputSerialData(false);

Firmware/LoRaSerial/System.ino

@@ -1100,9 +1100,6 @@ void updateLeds()
 {
   static uint8_t previousLedUse;
 
-  //If training button is being pressed, LEDs are being updated by that function
-  if (trainBtn != NULL && trainBtn->read()) return;
-
   //When changing patterns, start with the LEDs off
   if (previousLedUse != settings.selectLedUse)
   {