Add button checking. Add training command.

Author: nseidle

Firmware/LoRaSerial_Firmware/Begin.ino

@@ -41,6 +41,8 @@ void beginBoard()
 
   pin_trigger = 13;
 
+  pin_setupButton = 0;
+
   //Debug
   pinMode(pin_trigger, OUTPUT);
   digitalWrite(pin_trigger, HIGH);
@@ -139,6 +141,15 @@ void beginLoRa()
     changeState(RADIO_BROADCASTING_RECEIVING_STANDBY);
 }
 
+void beginButton()
+{
+  if (pin_setupButton != 255)
+  {
+    trainBtn = new Button(pin_setupButton); //Create the button
+    trainBtn->begin();
+  }
+}
+
 void beginWDT()
 {
 #if defined(ARDUINO_ARCH_SAMD)

Firmware/LoRaSerial_Firmware/Commands.ino

@@ -59,6 +59,16 @@ void commandMode()
               reportOK();
               return;
               break;
+            case ('T'): //Enter training mode
+              reportOK();
+              beginTraining();
+              return;
+              break;
+            case ('F'): //Enter training mode and return to factory defaults
+              reportOK();
+              beginDefaultTraining();
+              return;
+              break;
             case ('Z'): //Reboots the radio
               reportOK();
               Serial.flush();
@@ -136,10 +146,6 @@ void commandMode()
                   reportOK();
                 }
                 break;
-              case ('T'): //AT&T - Disable debugging report
-                settings.displayPacketQuality = false;
-                reportOK();
-                break;
               default:
                 reportERROR();
                 break;
@@ -148,7 +154,7 @@ void commandMode()
           else
           {
             //RSSI
-            if (strcmp_P(commandBuffer, PSTR("AT&T=RSSI")) == 0) //Enable debugging report
+            if (strcmp_P(commandBuffer, PSTR("AT&T=RSSI")) == 0) //Enable packet quality reporting
             {
               settings.displayPacketQuality = true;
               reportOK();

Firmware/LoRaSerial_Firmware/LoRaSerial_Firmware.ino

@@ -73,6 +73,7 @@ uint8_t pin_linkLED = 255;
 uint8_t pin_activityLED = 255;
 uint8_t pin_txLED = 255;
 uint8_t pin_rxLED = 255;
+uint8_t pin_setupButton = 255;
 
 uint8_t pin_trigger = 255;
 //=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
@@ -117,6 +118,15 @@ WDTZero myWatchDog;
 #endif
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 
+//Buttons - Interrupt driven and debounce
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+#include <JC_Button.h> // http://librarymanager/All#JC_Button
+Button *trainBtn = NULL; //We can't instantiate the button here because we don't yet know what pin number to use
+
+const int trainButtonTime = 4000; //ms press and hold before entering training
+const int trainWithDefaultsButtonTime = 10000; //ms press and hold before entering training
+//-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
+
 //Global variables - Serial
 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
 //Buffer to store bytes incoming from serial before broadcasting over LoRa
@@ -169,6 +179,8 @@ bool expectingAck = false; //Used by various send packet functions
 
 float frequencyCorrection = 0; //Adjust receive freq based on the last packet received freqError
 
+unsigned long lastTrainBlink = 0; //Controls LED during training
+
 Settings originalSettings; //Create a duplicate of settings during training so that we can resort as needed
 uint8_t trainNetID; //New netID passed during training
 uint8_t trainEncryptionKey[16]; //New AES key passed during training
@@ -183,9 +195,7 @@ long stopTime = 0;
 
 void setup()
 {
-  //eepromErase();
-
-  Serial.begin(57600);
+  Serial.begin(57600); //Default for debug messages before board begins
 
 #if defined(ENABLE_DEVELOPER)
   //Wait for serial to come online for debug printing
@@ -206,18 +216,12 @@ void setup()
   beginBoard(); //Determine what hardware platform we are running on
 
   //settings.airSpeed = 19200;
-  //  settings.maxDwellTime = 400;
-  //  settings.frequencyHop = true;
   //settings.debug = true; //Enable trigger pin events
-  //  //settings.heartbeatTimeout = 2000;
-  //  settings.displayPacketQuality = false;
-  //settings.autoTuneFrequency = false;
-  //settings.encryptData = false; //No ecrypt, no scramble works
-  //settings.dataScrambling = false; //Encrypt, no scramble works
-  //settings.pointToPoint = false; //Encrypt, scramble works
 
   beginLoRa(); //Start radio
 
+  beginButton(); //Start watching the train button
+
   beginWDT(); //Start watchdog timer
 
   Serial.println(F("LRS"));
@@ -230,21 +234,9 @@ void loop()
 {
   petWDT();
 
-  //updateSerial(); //Store incoming and print outgoing
-
-  if (Serial.available())
-  {
-    byte incoming = Serial.read();
-
-    if (incoming == 't')
-    {
-      beginTraining();
-    }
-    else if (incoming == 'r')
-    {
-      beginDefaultTraining();
-    }
-  }
+  updateButton();
+
+  updateSerial(); //Store incoming and print outgoing
 
   updateRadioState(); //Ping/ack/send packets as needed
 }

Firmware/LoRaSerial_Firmware/Radio.ino

@@ -550,11 +550,17 @@ void generateHopTable()
   //Feed random number generator with our specific platform settings
   //Use settings that must be identical to have a functioning link.
   //For example, we do not use coding rate because two radios can communicate with different coding rate values
-  myRandSeed = settings.netID + settings.airSpeed + settings.numberOfChannels
+  myRandSeed = settings.airSpeed + settings.netID + settings.pointToPoint + settings.encryptData
+               + settings.dataScrambling 
                + (uint16_t)settings.frequencyMin + (uint16_t)settings.frequencyMax
-               + (uint16_t)settings.radioBandwidth + settings.radioSpreadFactor + settings.frequencyHop;
+               + settings.numberOfChannels + settings.frequencyHop + settings.maxDwellTime
+               + (uint16_t)settings.radioBandwidth + settings.radioSpreadFactor;
 
-  //TODO add pointToPoint, encryptData, encryptionKey, dataScrambling, maxDwellTime,
+  if (settings.encryptData == true)
+  {
+    for (int x = 0 ; x < sizeof(settings.encryptionKey) ; x++)
+      myRandSeed += settings.encryptionKey[x];
+  }
 
   //'Randomly' shuffle list based on our specific seed
   shuffle(channels, settings.numberOfChannels);

Firmware/LoRaSerial_Firmware/System.ino

@@ -1,3 +1,56 @@
+//Check the train button and change state accordingly
+void updateButton()
+{
+  if (trainBtn != NULL)
+  {
+    trainBtn->read();
+
+    if (trainState == TRAIN_NO_PRESS && trainBtn->pressedFor(trainButtonTime))
+    {
+      trainState = TRAIN_PRESSED_4S;
+      lastTrainBlink = millis();
+    }
+    else if (trainState == TRAIN_PRESSED_4S && trainBtn->wasReleased())
+    {
+      digitalWrite(pin_linkLED, LOW);
+
+      beginTraining();
+
+      trainState = TRAIN_NO_PRESS;
+    }
+    else if (trainState == TRAIN_PRESSED_4S && trainBtn->pressedFor(trainWithDefaultsButtonTime))
+    {
+      trainState = TRAIN_PRESSED_10S;
+    }
+    else if (trainState == TRAIN_PRESSED_10S && trainBtn->wasReleased())
+    {
+      digitalWrite(pin_linkLED, LOW);
+
+      beginDefaultTraining();
+
+      trainState = TRAIN_NO_PRESS;
+    }
+
+    //Blink LEDs according to our state while we wait for user to release button
+    if (trainState == TRAIN_PRESSED_4S)
+    {
+      if (millis() - lastTrainBlink > 500) //Slow blink
+      {
+        lastTrainBlink = millis();
+        digitalWrite(pin_linkLED, !digitalRead(pin_linkLED));
+      }
+    }
+    else if (trainState == TRAIN_PRESSED_10S)
+    {
+      if (millis() - lastTrainBlink > 100) //Fast blink
+      {
+        lastTrainBlink = millis();
+        digitalWrite(pin_linkLED, !digitalRead(pin_linkLED));
+      }
+    }
+  }
+}
+
 //Platform specific reset commands
 void systemReset()
 {

Firmware/LoRaSerial_Firmware/settings.h

@@ -31,6 +31,15 @@ typedef enum
   PROCESS_TRAINING_DATA_PACKET,
 } PacketType;
 
+//Train button states
+typedef enum
+{
+  TRAIN_NO_PRESS = 0,
+  TRAIN_PRESSED_4S,
+  TRAIN_PRESSED_10S,
+} TrainStates;
+TrainStates trainState = TRAIN_NO_PRESS;
+
 enum
 {
   TRIGGER_ACK_PROCESSED = 25,