Merge pull request #526 from LeeLeahy2/vc-unique-id

VC: Pass the unique ID to the PC during VC state changes

Author: nseidle

Firmware/LoRaSerial/Commands.ino

@@ -787,6 +787,7 @@ bool sendRemoteCommand(const char * commandString)
     systemPrintln(" from commandBuffer into commandTXBuffer");
   }
   remoteCommandResponse = false;
+  waitRemoteCommandResponse = true;
   return true;
 }
 

Firmware/LoRaSerial/LoRaSerial.ino

@@ -230,6 +230,7 @@ const long minEscapeTime_ms = 2000; //Serial traffic must stop this amount befor
 bool inCommandMode = false; //Normal data is prevented from entering serial output when in command mode
 uint8_t commandLength = 0;
 bool remoteCommandResponse;
+bool waitRemoteCommandResponse;
 
 bool rtsAsserted; //When RTS is asserted, host says it's ok to send data
 bool forceRadioReset = false; //Goes true when a setting requires a link/radio reset to work

Firmware/LoRaSerial/Serial.ino

@@ -354,6 +354,10 @@ void updateSerial()
   {
     commandLength = availableRXCommandBytes();
 
+    //Don't overflow the command buffer, save space for the zero termination
+    if (commandLength >= sizeof(commandBuffer))
+      commandLength = sizeof(commandBuffer) - 1;
+
     for (x = 0 ; x < commandLength ; x++)
     {
       commandBuffer[x] = commandRXBuffer[commandRXTail++];
@@ -395,6 +399,7 @@ void processSerialInput()
   radioHead = radioTxHead;
   while (availableRXBytes()
          && (availableRadioTXBytes() < (sizeof(radioTxBuffer) - maxEscapeCharacters))
+         && ((!inCommandMode) || (!waitRemoteCommandResponse))
          && (transactionComplete == false))
   {
     //Take a break if there are ISRs to attend to
@@ -413,17 +418,22 @@ void processSerialInput()
     //Process serial into either rx buffer or command buffer
     if (inCommandMode == true)
     {
-      if (incoming == '\r' && commandLength > 0)
+      //Check for end of command
+      if ((incoming == '\r') || (incoming == ';'))
       {
-        printerEndpoint = PRINT_TO_SERIAL;
-        systemPrintln();
-        if (settings.debugSerial)
+        //Ignore end of command if no command in the buffer
+        if (commandLength > 0)
         {
-          systemPrint("processSerialInput moved ");
-          systemPrint(commandLength);
-          systemPrintln(" from serialReceiveBuffer into commandBuffer");
+          systemPrintln();
+          if (settings.debugSerial)
+          {
+            systemPrint("processSerialInput moved ");
+            systemPrint(commandLength);
+            systemPrintln(" from serialReceiveBuffer into commandBuffer");
+          }
+          checkCommand(); //Process command buffer
+          break;
         }
-        checkCommand(); //Process command buffer
       }
       else if (incoming == '\n')
         ; //Do nothing
@@ -448,7 +458,23 @@ void processSerialInput()
         {
           //Move this character into the command buffer
           commandBuffer[commandLength++] = incoming;
-          commandLength %= sizeof(commandBuffer);
+
+          //Don't allow the command to overflow the command buffer
+          //Process the long command instead
+          //Save room for the zero termination
+          if (commandLength >= (sizeof(commandBuffer) - 1))
+          {
+            printerEndpoint = PRINT_TO_SERIAL;
+            systemPrintln();
+            if (settings.debugSerial)
+            {
+              systemPrint("processSerialInput moved ");
+              systemPrint(commandLength);
+              systemPrintln(" from serialReceiveBuffer into commandBuffer");
+            }
+            checkCommand(); //Process command buffer
+            break;
+          }
         }
       }
     }

Firmware/LoRaSerial/States.ino

@@ -806,6 +806,7 @@ void updateRadioState()
               outputSerialData(true);
             }
             serialBufferOutput(rxData, rxDataBytes);
+            waitRemoteCommandResponse = false;
 
             //Transmit ACK
             P2P_SEND_ACK(TRIGGER_TX_ACK);
@@ -2982,6 +2983,7 @@ void discardPreviousData()
   txTail = txHead;
   commandRXTail = commandRXHead;
   commandTXTail = commandTXHead;
+  waitRemoteCommandResponse = false;
 }
 
 //Output VC link status
@@ -3047,6 +3049,10 @@ void vcSendPcStateMessage(int8_t vcIndex, uint8_t state)
   //Build the VC state message
   VC_STATE_MESSAGE message;
   message.vcState = state;
+  if (virtualCircuitList[vcIndex].flags.valid)
+    memcpy(&message.uniqueId[0], &virtualCircuitList[vcIndex].uniqueId[0], sizeof(message.uniqueId));
+  else
+    memset(message.uniqueId, UNIQUE_ID_ERASE_VALUE, sizeof(message.uniqueId));
 
   //Build the message header
   VC_SERIAL_MESSAGE_HEADER header;

Firmware/LoRaSerial/Virtual_Circuit_Protocol.h

@@ -140,10 +140,15 @@ typedef struct _VC_SERIAL_MESSAGE_HEADER
 } VC_SERIAL_MESSAGE_HEADER;
 
 #define VC_SERIAL_HEADER_BYTES  (sizeof(VC_SERIAL_MESSAGE_HEADER)) //Length of the serial VC header in bytes
+#define UNIQUE_ID_ERASE_VALUE   0xff
+#ifndef UNIQUE_ID_BYTES
+#define UNIQUE_ID_BYTES         16
+#endif  //UNIQUE_ID_BYTES
 
 typedef struct _VC_STATE_MESSAGE
 {
-  uint8_t vcState;        //VC state
+  uint8_t vcState;                   //VC state
+  uint8_t uniqueId[UNIQUE_ID_BYTES]; //Unique ID for the LoRaSerial radio, all 0xFF if unknown
 } VC_STATE_MESSAGE;
 
 typedef enum

Firmware/Tools/VcServerTest.c

@@ -28,6 +28,8 @@
 typedef struct _VIRTUAL_CIRCUIT
 {
   int vcState;
+  uint8_t uniqueId[UNIQUE_ID_BYTES];
+  bool valid;
 } VIRTUAL_CIRCUIT;
 
 bool commandStatus;
@@ -304,6 +306,7 @@ void radioToPcLinkStatus(VC_SERIAL_MESSAGE_HEADER * header, uint8_t length)
   int newState;
   int previousState;
   int srcVc;
+  uint8_t uniqueId[UNIQUE_ID_BYTES];
   VC_STATE_MESSAGE * vcMsg;
 
   //Remember the previous state
@@ -315,6 +318,47 @@ void radioToPcLinkStatus(VC_SERIAL_MESSAGE_HEADER * header, uint8_t length)
   newState = vcMsg->vcState;
   virtualCircuitList[srcVc].vcState = newState;
 
+  //Save the LoRaSerial radio's unique ID
+  //Determine if the PC's value is valid
+  memset(uniqueId, UNIQUE_ID_ERASE_VALUE, sizeof(uniqueId));
+  if (!virtualCircuitList[srcVc].valid)
+  {
+    //Determine if the radio knows the value
+    if (memcmp(vcMsg->uniqueId, uniqueId, sizeof(uniqueId)) != 0)
+    {
+      //The radio knows the value, save it in the PC
+      memcpy(virtualCircuitList[srcVc].uniqueId, vcMsg->uniqueId, sizeof(vcMsg->uniqueId));
+      virtualCircuitList[srcVc].valid = true;
+
+      //Display this ID value
+      printf("VC %d unique ID: %02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x\n",
+             srcVc,
+             vcMsg->uniqueId[0], vcMsg->uniqueId[1], vcMsg->uniqueId[2], vcMsg->uniqueId[3],
+             vcMsg->uniqueId[4], vcMsg->uniqueId[5], vcMsg->uniqueId[6], vcMsg->uniqueId[7],
+             vcMsg->uniqueId[8], vcMsg->uniqueId[9], vcMsg->uniqueId[10], vcMsg->uniqueId[11],
+             vcMsg->uniqueId[12], vcMsg->uniqueId[13], vcMsg->uniqueId[14], vcMsg->uniqueId[15]);
+    }
+  }
+  else
+  {
+    //Determine if the radio has changed for this VC
+    if ((memcmp(vcMsg->uniqueId, virtualCircuitList[srcVc].uniqueId, sizeof(vcMsg->uniqueId)) != 0)
+        && (memcmp(vcMsg->uniqueId, uniqueId, sizeof(uniqueId)) != 0))
+    {
+      //The radio knows the value, save it in the PC
+      memcpy(virtualCircuitList[srcVc].uniqueId, vcMsg->uniqueId, sizeof(vcMsg->uniqueId));
+      virtualCircuitList[srcVc].valid = true;
+
+      //Display this ID value
+      printf("VC %d unique ID: %02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x\n",
+             srcVc,
+             vcMsg->uniqueId[0], vcMsg->uniqueId[1], vcMsg->uniqueId[2], vcMsg->uniqueId[3],
+             vcMsg->uniqueId[4], vcMsg->uniqueId[5], vcMsg->uniqueId[6], vcMsg->uniqueId[7],
+             vcMsg->uniqueId[8], vcMsg->uniqueId[9], vcMsg->uniqueId[10], vcMsg->uniqueId[11],
+             vcMsg->uniqueId[12], vcMsg->uniqueId[13], vcMsg->uniqueId[14], vcMsg->uniqueId[15]);
+    }
+  }
+
   //Display the state if requested
   if (DISPLAY_STATE_TRANSITION)
     printf("VC%d: %s --> %s\n", srcVc, vcStateNames[previousState], vcStateNames[newState]);