Merge pull request #574 from LeeLeahy2/mp-hop-timer-debug

MP: Add debugHopTimer setting to compute and display link uptime

Author: nseidle

Firmware/LoRaSerial/Commands.ino

@@ -720,19 +720,29 @@ bool commandAT(const char * commandString)
         return true;
 
       case ('1'): //ATI31 - Display the VC details
-        systemPrintTimestamp();
-        systemPrint("VC ");
-        systemPrint(cmdVc);
-        systemPrint(": ");
-        if (!vc->flags.valid)
-          systemPrintln("Down, Not valid");
-        else
+        if ((settings.operatingMode == MODE_VIRTUAL_CIRCUIT) && (!vc->flags.valid))
         {
-          systemPrintln(vcStateNames[vc->vcState]);
           systemPrintTimestamp();
-          systemPrint("    ID: ");
-          systemPrintUniqueID(vc->uniqueId);
-          systemPrintln(vc->flags.valid ? " (Valid)" : " (Invalid)");
+          systemPrint("VC ");
+          systemPrint(cmdVc);
+          systemPrint(": ");
+          if (!vc->flags.valid)
+            systemPrintln("Down, Not valid");
+        }
+        else
+        {
+          if (settings.operatingMode == MODE_VIRTUAL_CIRCUIT)
+          {
+            systemPrintTimestamp();
+            systemPrint("VC ");
+            systemPrint(cmdVc);
+            systemPrint(": ");
+            systemPrintln(vcStateNames[vc->vcState]);
+            systemPrintTimestamp();
+            systemPrint("    ID: ");
+            systemPrintUniqueID(vc->uniqueId);
+            systemPrintln(vc->flags.valid ? " (Valid)" : " (Invalid)");
+          }
 
           //Heartbeat metrics
           systemPrintTimestamp();
@@ -762,57 +772,60 @@ bool commandAT(const char * commandString)
           outputSerialData(true);
           petWDT();
 
-          //Transmitter metrics
-          systemPrintTimestamp();
-          systemPrintln("    Sent");
-          systemPrintTimestamp();
-          systemPrint("        Frames: ");
-          systemPrintln(vc->framesSent);
-          systemPrintTimestamp();
-          systemPrint("        Messages: ");
-          systemPrintln(vc->messagesSent);
-          outputSerialData(true);
-          petWDT();
+          if ((settings.operatingMode == MODE_VIRTUAL_CIRCUIT) && (!vc->flags.valid))
+          {
+            //Transmitter metrics
+            systemPrintTimestamp();
+            systemPrintln("    Sent");
+            systemPrintTimestamp();
+            systemPrint("        Frames: ");
+            systemPrintln(vc->framesSent);
+            systemPrintTimestamp();
+            systemPrint("        Messages: ");
+            systemPrintln(vc->messagesSent);
+            outputSerialData(true);
+            petWDT();
 
-          //Receiver metrics
-          systemPrintTimestamp();
-          systemPrintln("    Received");
-          systemPrintTimestamp();
-          systemPrint("        Frames: ");
-          systemPrintln(vc->framesReceived);
-          systemPrintTimestamp();
-          systemPrint("        Messages: ");
-          systemPrintln(vc->messagesReceived);
-          systemPrintTimestamp();
-          systemPrint("        Bad Lengths: ");
-          systemPrintln(vc->badLength);
-          systemPrintTimestamp();
-          systemPrint("        Link Failures: ");
-          systemPrintln(linkFailures);
-          outputSerialData(true);
-          petWDT();
+            //Receiver metrics
+            systemPrintTimestamp();
+            systemPrintln("    Received");
+            systemPrintTimestamp();
+            systemPrint("        Frames: ");
+            systemPrintln(vc->framesReceived);
+            systemPrintTimestamp();
+            systemPrint("        Messages: ");
+            systemPrintln(vc->messagesReceived);
+            systemPrintTimestamp();
+            systemPrint("        Bad Lengths: ");
+            systemPrintln(vc->badLength);
+            systemPrintTimestamp();
+            systemPrint("        Link Failures: ");
+            systemPrintln(linkFailures);
+            outputSerialData(true);
+            petWDT();
 
-          //ACK Management metrics
-          systemPrintTimestamp();
-          systemPrintln("    ACK Management");
-          systemPrintTimestamp();
-          systemPrint("        Last RX ACK number: ");
-          systemPrintln(vc->rxAckNumber);
-          systemPrintTimestamp();
-          systemPrint("        Next RX ACK number: ");
-          systemPrintln(vc->rmtTxAckNumber);
-          systemPrintTimestamp();
-          systemPrint("        Last TX ACK number: ");
-          systemPrintln(vc->txAckNumber);
-          if (txDestVc == cmdVc)
-          {
+            //ACK Management metrics
             systemPrintTimestamp();
-            systemPrint("        ackTimer: ");
-            if (ackTimer)
-              systemPrintTimestamp(ackTimer + timestampOffset);
-            else
-              systemPrint("Not Running");
-            systemPrintln();
+            systemPrintln("    ACK Management");
+            systemPrintTimestamp();
+            systemPrint("        Last RX ACK number: ");
+            systemPrintln(vc->rxAckNumber);
+            systemPrintTimestamp();
+            systemPrint("        Next RX ACK number: ");
+            systemPrintln(vc->rmtTxAckNumber);
+            systemPrintTimestamp();
+            systemPrint("        Last TX ACK number: ");
+            systemPrintln(vc->txAckNumber);
+            if (txDestVc == cmdVc)
+            {
+              systemPrintTimestamp();
+              systemPrint("        ackTimer: ");
+              if (ackTimer)
+                systemPrintTimestamp(ackTimer + timestampOffset);
+              else
+                systemPrint("Not Running");
+              systemPrintln();
+            }
           }
         }
         return true;

Firmware/LoRaSerial/States.ino

@@ -1160,6 +1160,8 @@ void updateRadioState()
               //Start and adjust freq hop ISR based on remote's remaining clock
               startChannelTimer();
               channelTimerStart -= settings.maxDwellTime;
+              if (!settings.server)
+                virtualCircuitList[VC_SERVER].firstHeartbeatMillis = millis();
               syncChannelTimer(txSyncClocksUsec, 1);
               triggerEvent(TRIGGER_RX_SYNC_CLOCKS);
 
@@ -1320,6 +1322,8 @@ void updateRadioState()
 
               //Start and adjust freq hop ISR based on remote's remaining clock
               channelTimerStart -= settings.maxDwellTime;
+              if (!settings.server)
+                virtualCircuitList[VC_SERVER].firstHeartbeatMillis = millis();
               syncChannelTimer(txSyncClocksUsec, 1);
 
               if (settings.debugSync)
@@ -1434,6 +1438,9 @@ void updateRadioState()
             //Sync clock if server sent the heartbeat
             if (settings.server == false)
             {
+              if (!settings.server)
+                virtualCircuitList[VC_SERVER].lastTrafficMillis = millis();
+
               //Adjust freq hop ISR based on server's remaining clock
               syncChannelTimer(txHeartbeatUsec, 0);
 
@@ -1495,8 +1502,15 @@ void updateRadioState()
           if ((millis() - lastPacketReceived) > ((uint32_t)settings.heartbeatTimeout * LINK_BREAK_MULTIPLIER))
           {
             if (settings.debugSync)
-            {
               systemPrintln("HEARTBEAT Timeout");
+            if ((!settings.server) && settings.debugHopTimer)
+            {
+              systemPrint("Link Uptime: ");
+              systemPrintln(virtualCircuitList[VC_SERVER].lastTrafficMillis
+                            - virtualCircuitList[VC_SERVER].firstHeartbeatMillis);
+            }
+            if (settings.debugSync || settings.debugHopTimer)
+            {
               outputSerialData(true);
               dumpClockSynchronization();
             }

Firmware/LoRaSerial/settings.h

@@ -487,6 +487,7 @@ typedef struct struct_settings {
   bool debug = false; //Print basic events: ie, radio state changes
   bool debugDatagrams = false; //Print the datagrams
   bool debugHeartbeat = false; //Print the HEARTBEAT timing values
+  bool debugHopTimer = false; //Print the hop timer when the link fails
 
   bool debugNvm = false; //Debug NVM operation
   bool debugRadio = false; //Print radio info