Merge pull request #500 from LeeLeahy2/training-settings

Add trainingSettings

Author: nseidle

Firmware/LoRaSerial/LoRaSerial.ino

@@ -509,7 +509,8 @@ unsigned long retransmitTimeout = 0; //Throttle back re-transmits
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 const Settings defaultSettings;
 Settings settings; //Active settings used by the radio
-Settings tempSettings; //Create a duplicate of settings during training so that we can resort as needed
+Settings tempSettings; //Temporary settings used for command processing
+Settings trainingSettings; //Settings used for training other radios
 
 char platformPrefix[25]; //Used for printing platform specific device name, ie "SAMD21 1W 915MHz"
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

Firmware/LoRaSerial/Radio.ino

@@ -1237,88 +1237,88 @@ void updateRadioParameters(uint8_t * rxData)
   memcpy(&params, rxData, sizeof(params));
 
   //Update the radio parameters
-  tempSettings.autoTuneFrequency = params.autoTuneFrequency;
-  tempSettings.frequencyHop = params.frequencyHop;
-  tempSettings.frequencyMax = params.frequencyMax;
-  tempSettings.frequencyMin = params.frequencyMin;
-  tempSettings.maxDwellTime = params.maxDwellTime;
-  tempSettings.numberOfChannels = params.numberOfChannels;
-  tempSettings.radioBandwidth = params.radioBandwidth;
-  tempSettings.radioBroadcastPower_dbm = params.radioBroadcastPower_dbm;
-  tempSettings.radioCodingRate = params.radioCodingRate;
-  tempSettings.radioPreambleLength = params.radioPreambleLength;
-  tempSettings.radioSpreadFactor = params.radioSpreadFactor;
-  tempSettings.radioSyncWord = params.radioSyncWord;
-  tempSettings.txToRxUsec = params.txToRxUsec;
+  trainingSettings.autoTuneFrequency = params.autoTuneFrequency;
+  trainingSettings.frequencyHop = params.frequencyHop;
+  trainingSettings.frequencyMax = params.frequencyMax;
+  trainingSettings.frequencyMin = params.frequencyMin;
+  trainingSettings.maxDwellTime = params.maxDwellTime;
+  trainingSettings.numberOfChannels = params.numberOfChannels;
+  trainingSettings.radioBandwidth = params.radioBandwidth;
+  trainingSettings.radioBroadcastPower_dbm = params.radioBroadcastPower_dbm;
+  trainingSettings.radioCodingRate = params.radioCodingRate;
+  trainingSettings.radioPreambleLength = params.radioPreambleLength;
+  trainingSettings.radioSpreadFactor = params.radioSpreadFactor;
+  trainingSettings.radioSyncWord = params.radioSyncWord;
+  trainingSettings.txToRxUsec = params.txToRxUsec;
 
   //Update the radio protocol parameters
-  tempSettings.dataScrambling = params.dataScrambling;
-  tempSettings.enableCRC16 = params.enableCRC16;
-  tempSettings.encryptData = params.encryptData;
-  memcpy(tempSettings.encryptionKey, params.encryptionKey, sizeof(tempSettings.encryptionKey));
-  tempSettings.framesToYield = params.framesToYield;
-  tempSettings.heartbeatTimeout = params.heartbeatTimeout;
-  tempSettings.maxResends = params.maxResends;
-  tempSettings.netID = params.netID;
-  tempSettings.operatingMode = params.operatingMode;
-  tempSettings.overheadTime = params.overheadTime;
-  tempSettings.selectLedUse = params.selectLedUse;
-  tempSettings.server = params.server;
-  tempSettings.verifyRxNetID = params.verifyRxNetID;
+  trainingSettings.dataScrambling = params.dataScrambling;
+  trainingSettings.enableCRC16 = params.enableCRC16;
+  trainingSettings.encryptData = params.encryptData;
+  memcpy(trainingSettings.encryptionKey, params.encryptionKey, sizeof(trainingSettings.encryptionKey));
+  trainingSettings.framesToYield = params.framesToYield;
+  trainingSettings.heartbeatTimeout = params.heartbeatTimeout;
+  trainingSettings.maxResends = params.maxResends;
+  trainingSettings.netID = params.netID;
+  trainingSettings.operatingMode = params.operatingMode;
+  trainingSettings.overheadTime = params.overheadTime;
+  trainingSettings.selectLedUse = params.selectLedUse;
+  trainingSettings.server = params.server;
+  trainingSettings.verifyRxNetID = params.verifyRxNetID;
 
   //Update the debug parameters
   if (params.copyDebug)
   {
-    tempSettings.copyDebug = params.copyDebug;
-    tempSettings.debug = params.debug;
-    tempSettings.debugDatagrams = params.debugDatagrams;
-    tempSettings.debugHeartbeat = params.debugHeartbeat;
-    tempSettings.debugNvm = params.debugNvm;
-    tempSettings.debugRadio = params.debugRadio;
-    tempSettings.debugReceive = params.debugReceive;
-    tempSettings.debugSerial = params.debugSerial;
-    tempSettings.debugStates = params.debugStates;
-    tempSettings.debugSync = params.debugSync;
-    tempSettings.debugTraining = params.debugTraining;
-    tempSettings.debugTransmit = params.debugTransmit;
-    tempSettings.displayRealMillis = params.displayRealMillis;
-    tempSettings.printAckNumbers = params.printAckNumbers;
-    tempSettings.printChannel = params.printChannel;
-    tempSettings.printFrequency = params.printFrequency;
-    tempSettings.printLinkUpDown = params.printLinkUpDown;
-    tempSettings.printPacketQuality = params.printPacketQuality;
-    tempSettings.printPktData = params.printPktData;
-    tempSettings.printRfData = params.printRfData;
-    tempSettings.printTimestamp = params.printTimestamp;
-    tempSettings.printTxErrors = params.printTxErrors;
+    trainingSettings.copyDebug = params.copyDebug;
+    trainingSettings.debug = params.debug;
+    trainingSettings.debugDatagrams = params.debugDatagrams;
+    trainingSettings.debugHeartbeat = params.debugHeartbeat;
+    trainingSettings.debugNvm = params.debugNvm;
+    trainingSettings.debugRadio = params.debugRadio;
+    trainingSettings.debugReceive = params.debugReceive;
+    trainingSettings.debugSerial = params.debugSerial;
+    trainingSettings.debugStates = params.debugStates;
+    trainingSettings.debugSync = params.debugSync;
+    trainingSettings.debugTraining = params.debugTraining;
+    trainingSettings.debugTransmit = params.debugTransmit;
+    trainingSettings.displayRealMillis = params.displayRealMillis;
+    trainingSettings.printAckNumbers = params.printAckNumbers;
+    trainingSettings.printChannel = params.printChannel;
+    trainingSettings.printFrequency = params.printFrequency;
+    trainingSettings.printLinkUpDown = params.printLinkUpDown;
+    trainingSettings.printPacketQuality = params.printPacketQuality;
+    trainingSettings.printPktData = params.printPktData;
+    trainingSettings.printRfData = params.printRfData;
+    trainingSettings.printTimestamp = params.printTimestamp;
+    trainingSettings.printTxErrors = params.printTxErrors;
   }
 
   //Update the serial parameters
   if (params.copySerial)
   {
-    tempSettings.copySerial = params.copySerial;
-    tempSettings.echo = params.echo;
-    tempSettings.flowControl = params.flowControl;
-    tempSettings.invertCts = params.invertCts;
-    tempSettings.invertRts = params.invertRts;
-    tempSettings.serialSpeed = params.serialSpeed;
-    tempSettings.serialTimeoutBeforeSendingFrame_ms = params.serialTimeoutBeforeSendingFrame_ms;
-    tempSettings.usbSerialWait = params.usbSerialWait;
+    trainingSettings.copySerial = params.copySerial;
+    trainingSettings.echo = params.echo;
+    trainingSettings.flowControl = params.flowControl;
+    trainingSettings.invertCts = params.invertCts;
+    trainingSettings.invertRts = params.invertRts;
+    trainingSettings.serialSpeed = params.serialSpeed;
+    trainingSettings.serialTimeoutBeforeSendingFrame_ms = params.serialTimeoutBeforeSendingFrame_ms;
+    trainingSettings.usbSerialWait = params.usbSerialWait;
   }
 
   //Update the training values
-  tempSettings.clientFindPartnerRetryInterval = params.clientFindPartnerRetryInterval;
+  trainingSettings.clientFindPartnerRetryInterval = params.clientFindPartnerRetryInterval;
   //The trainingKey is already the same
-  tempSettings.trainingTimeout = params.trainingTimeout;
+  trainingSettings.trainingTimeout = params.trainingTimeout;
 
   //Update the trigger parameters
   if (params.copyTriggers)
   {
-    tempSettings.copyTriggers = params.copyTriggers;
-    tempSettings.triggerEnable = params.triggerEnable;
-    tempSettings.triggerEnable2 = params.triggerEnable2;
-    tempSettings.triggerWidth = params.triggerWidth;
-    tempSettings.triggerWidthIsMultiplier = params.triggerWidthIsMultiplier;
+    trainingSettings.copyTriggers = params.copyTriggers;
+    trainingSettings.triggerEnable = params.triggerEnable;
+    trainingSettings.triggerEnable2 = params.triggerEnable2;
+    trainingSettings.triggerWidth = params.triggerWidth;
+    trainingSettings.triggerWidthIsMultiplier = params.triggerWidthIsMultiplier;
   }
 }
 
@@ -1334,7 +1334,7 @@ bool xmitDatagramTrainRadioParameters(const uint8_t * clientID)
   radioCallHistory[RADIO_CALL_xmitDatagramTrainRadioParameters] = millis();
 
   //Initialize the radio parameters
-  memcpy(&params, &tempSettings, sizeof(settings));
+  memcpy(&params, &trainingSettings, sizeof(settings));
   params.server = false;
 
   //Add the destination (client) ID

Firmware/LoRaSerial/Train.ino

@@ -87,9 +87,9 @@ void beginTrainingServer()
 
   systemPrintln("Server radio protocol parameters");
   systemPrint("  netID: ");
-  systemPrintln(tempSettings.netID);
+  systemPrintln(trainingSettings.netID);
   systemPrint("  Encryption key: ");
-  displayEncryptionKey(tempSettings.encryptionKey);
+  displayEncryptionKey(trainingSettings.encryptionKey);
   systemPrintln();
   outputSerialData(true);
 
@@ -104,14 +104,14 @@ void beginTrainingServer()
 void commonTrainingInitialization()
 {
   //Save the current settings
-  tempSettings = settings;
+  trainingSettings = settings;
 
   //Use common radio settings between the client and server for training
   settings = defaultSettings;
   settings.dataScrambling = true;           //Scramble the data
   settings.enableCRC16 = true;              //Use CRC-16
   settings.encryptData = true;              //Enable packet encryption
-  memcpy(&settings.encryptionKey, &tempSettings.trainingKey, AES_KEY_BYTES); //Common encryption key
+  memcpy(&settings.encryptionKey, &trainingSettings.trainingKey, AES_KEY_BYTES); //Common encryption key
   settings.frequencyHop = false;            //Stay on the training frequency
   settings.maxResends = 1;                  //Don't waste time retransmitting
   settings.netID = 'T';                     //NetID for training
@@ -124,37 +124,37 @@ void commonTrainingInitialization()
   selectHeaderAndTrailerBytes();
 
   //Debug training if requested
-  if (tempSettings.debugTraining)
+  if (trainingSettings.debugTraining)
   {
-    settings.selectLedUse = tempSettings.selectLedUse;
+    settings.selectLedUse = trainingSettings.selectLedUse;
     //Ignore copyDebug
-    settings.debug = tempSettings.debug;
-    settings.debugDatagrams = tempSettings.debugDatagrams;
-    settings.debugHeartbeat = tempSettings.debugHeartbeat;
-    settings.debugNvm = tempSettings.debugNvm;
-    settings.debugRadio = tempSettings.debugRadio;
-    settings.debugReceive = tempSettings.debugReceive;
-    settings.debugSerial = tempSettings.debugSerial;
-    settings.debugStates = tempSettings.debugStates;
-    settings.debugSync = tempSettings.debugSync;
-    settings.debugTraining = tempSettings.debugTraining;
-    settings.debugTransmit = tempSettings.debugTransmit;
-    settings.displayRealMillis = tempSettings.displayRealMillis;
-    settings.printAckNumbers = tempSettings.printAckNumbers;
-    settings.printChannel = tempSettings.printChannel;
-    settings.printFrequency = tempSettings.printFrequency;
-    settings.printLinkUpDown = tempSettings.printLinkUpDown;
-    settings.printPacketQuality = tempSettings.printPacketQuality;
-    settings.printPktData = tempSettings.printPktData;
-    settings.printRfData = tempSettings.printRfData;
-    settings.printTimestamp = tempSettings.printTimestamp;
-    settings.printTxErrors = tempSettings.printTxErrors;
+    settings.debug = trainingSettings.debug;
+    settings.debugDatagrams = trainingSettings.debugDatagrams;
+    settings.debugHeartbeat = trainingSettings.debugHeartbeat;
+    settings.debugNvm = trainingSettings.debugNvm;
+    settings.debugRadio = trainingSettings.debugRadio;
+    settings.debugReceive = trainingSettings.debugReceive;
+    settings.debugSerial = trainingSettings.debugSerial;
+    settings.debugStates = trainingSettings.debugStates;
+    settings.debugSync = trainingSettings.debugSync;
+    settings.debugTraining = trainingSettings.debugTraining;
+    settings.debugTransmit = trainingSettings.debugTransmit;
+    settings.displayRealMillis = trainingSettings.displayRealMillis;
+    settings.printAckNumbers = trainingSettings.printAckNumbers;
+    settings.printChannel = trainingSettings.printChannel;
+    settings.printFrequency = trainingSettings.printFrequency;
+    settings.printLinkUpDown = trainingSettings.printLinkUpDown;
+    settings.printPacketQuality = trainingSettings.printPacketQuality;
+    settings.printPktData = trainingSettings.printPktData;
+    settings.printRfData = trainingSettings.printRfData;
+    settings.printTimestamp = trainingSettings.printTimestamp;
+    settings.printTxErrors = trainingSettings.printTxErrors;
 
     //Ignore copyTriggers
-    settings.triggerEnable = tempSettings.triggerEnable;
-    settings.triggerEnable2 = tempSettings.triggerEnable2;
-    settings.triggerWidth = tempSettings.triggerWidth;
-    settings.triggerWidthIsMultiplier = tempSettings.triggerWidthIsMultiplier;
+    settings.triggerEnable = trainingSettings.triggerEnable;
+    settings.triggerEnable2 = trainingSettings.triggerEnable2;
+    settings.triggerWidth = trainingSettings.triggerWidth;
+    settings.triggerWidthIsMultiplier = trainingSettings.triggerWidthIsMultiplier;
   }
 
   //Reset cylon variables
@@ -180,7 +180,7 @@ void commonTrainingInitialization()
 void endClientServerTraining(uint8_t event)
 {
   triggerEvent(event);
-  settings = tempSettings; //Return to original radio settings
+  settings = trainingSettings; //Return to original radio settings
 
   if (settings.debugTraining)
   {