Add pairing states

Author: nseidle

Firmware/RTK_Surveyor/Base.ino

@@ -229,7 +229,5 @@ void SFE_UBLOX_GNSS::processRTCM(uint8_t incoming)
 {
   ntripServerProcessRTCM(incoming);
 
-#ifdef COMPILE_ESPNOW
   espnowProcessRTCM(incoming);
-#endif
 }

Firmware/RTK_Surveyor/Display.ino

@@ -331,8 +331,11 @@ void updateDisplay()
           //Do nothing. Quick, fall through state.
           break;
 
-        case (STATE_ESPNOW_PAIR):
-          paintEspNowPair();
+        case (STATE_ESPNOW_PAIRING_NOT_STARTED):
+          paintEspNowPairing();
+          break;
+        case (STATE_ESPNOW_PAIRING):
+          paintEspNowPairing();
           break;
 
         case (STATE_SHUTDOWN):
@@ -2151,7 +2154,7 @@ void paintDisplaySetup()
       printTextCenter("Bubble", 12 * 2, QW_FONT_8X16, 1, false);
       printTextCenter("Config", 12 * 3, QW_FONT_8X16, 1, true);
     }
-    else if (setupState == STATE_ESPNOW_PAIR)
+    else if (setupState == STATE_ESPNOW_PAIRING_NOT_STARTED)
     {
       printTextCenter("Base", 12 * 0, QW_FONT_8X16, 1, false);
       printTextCenter("Bubble", 12 * 1, QW_FONT_8X16, 1, false);
@@ -2191,7 +2194,7 @@ void paintDisplaySetup()
       printTextCenter("Bubble", 12 * 2, QW_FONT_8X16, 1, false);
       printTextCenter("Config", 12 * 3, QW_FONT_8X16, 1, true);
     }
-    else if (setupState == STATE_ESPNOW_PAIR)
+    else if (setupState == STATE_ESPNOW_PAIRING_NOT_STARTED)
     {
       printTextCenter("Rover", 12 * 0, QW_FONT_8X16, 1, false);
       printTextCenter("Bubble", 12 * 1, QW_FONT_8X16, 1, false);
@@ -2521,7 +2524,11 @@ void paintKeyProvisionFail(uint16_t displayTime)
 }
 
 //Show screen while ESP-Now is pairing
-void paintEspNowPair()
+void paintEspNowPairing()
 {
   displayMessage("ESP-Now Pairing", 0);
 }
+void paintEspNowPaired()
+{
+  displayMessage("ESP-Now Paired", 2000);
+}

Firmware/RTK_Surveyor/ESPNOW.ino

@@ -12,7 +12,6 @@
       We don't care if the ESP NOW packet is corrupt or not. RTCM has its own CRC. RTK needs valid RTCM once every
       few seconds so a single dropped frame is not critical.
 */
-#ifdef COMPILE_ESPNOW
 
 //Create a struct for ESP NOW pairing
 typedef struct PairMessage {
@@ -23,6 +22,7 @@ typedef struct PairMessage {
 } PairMessage;
 
 // Callback when data is sent
+#ifdef COMPILE_ESPNOW
 void espnowOnDataSent(const uint8_t *mac_addr, esp_now_send_status_t status)
 {
   //  Serial.print("Last Packet Send Status: ");
@@ -31,10 +31,12 @@ void espnowOnDataSent(const uint8_t *mac_addr, esp_now_send_status_t status)
   //  else
   //    Serial.println("Delivery Fail");
 }
+#endif
 
 // Callback when data is received
 void espnowOnDataRecieved(const uint8_t *mac, const uint8_t *incomingData, int len)
 {
+#ifdef COMPILE_ESPNOW
   if (espnowState == ESPNOW_PAIRING)
   {
     if (len == sizeof(PairMessage)) //First error check
@@ -66,10 +68,12 @@ void espnowOnDataRecieved(const uint8_t *mac, const uint8_t *incomingData, int l
     espnowIncomingRTCM = true;
     lastEspnowRssiUpdate = millis();
   }
+#endif
 }
 
 // Callback for all RX Packets
 // Get RSSI of all incoming management packets: https://esp32.com/viewtopic.php?t=13889
+#ifdef COMPILE_ESPNOW
 void promiscuous_rx_cb(void *buf, wifi_promiscuous_pkt_type_t type)
 {
   // All espnow traffic uses action frames which are a subtype of the mgmnt frames so filter out everything else.
@@ -79,11 +83,13 @@ void promiscuous_rx_cb(void *buf, wifi_promiscuous_pkt_type_t type)
   const wifi_promiscuous_pkt_t *ppkt = (wifi_promiscuous_pkt_t *)buf;
   packetRSSI = ppkt->rx_ctrl.rssi;
 }
+#endif
 
 //If WiFi is already enabled, simply add the LR protocol
 //If the radio is off entirely, start the radio, turn on only the LR protocol
 void espnowStart()
 {
+#ifdef COMPILE_ESPNOW
   if (wifiState == WIFI_OFF && espnowState == ESPNOW_OFF)
   {
     //Radio is off, turn it on
@@ -97,21 +103,19 @@ void espnowStart()
     //Enable WiFi + ESP-Now
     // Enable long range, PHY rate of ESP32 will be 512Kbps or 256Kbps
     esp_wifi_set_protocol(WIFI_IF_STA, WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N | WIFI_PROTOCOL_LR);
-    Serial.println("Wi-Fi on, ESP-Now added to protocols");
+    Serial.println("WiFi on, ESP-Now added to protocols");
   }
   //If ESP-Now is active, WiFi is active, do nothing
   else
   {
-    Serial.println("Wi-Fi already on, ESP-Now already on");
+    Serial.println("WiFi already on, ESP-Now already on");
   }
 
   // Init ESP-NOW
   if (esp_now_init() != ESP_OK) {
-    Serial.println("Error initializing ESP-NOW");
+    Serial.println("Error starting ESP-Now");
     return;
   }
-  else
-    Serial.println("ESP-NOW Initialized");
 
   // Use promiscuous callback to capture RSSI of packet
   esp_wifi_set_promiscuous(true);
@@ -143,12 +147,16 @@ void espnowStart()
       }
     }
   }
+
+  Serial.println("ESP-Now Started");
+#endif
 }
 
 //If WiFi is already enabled, simply remove the LR protocol
 //If WiFi is off, stop the radio entirely
 void espnowStop()
 {
+#ifdef COMPILE_ESPNOW
   if (espnowState == ESPNOW_OFF) return;
 
   if (wifiState == WIFI_OFF)
@@ -178,10 +186,8 @@ void espnowStop()
     Serial.println("Error deinitializing ESP-NOW");
     return;
   }
-
+#endif
   espnowSetState(ESPNOW_OFF);
-
-  Serial.println("ESP NOW Off");
 }
 
 //Start ESP-Now if needed, put ESP-Now into broadcast state
@@ -199,9 +205,11 @@ void espnowBeginPairing()
 //Regularly call during pairing to see if we've received a Pairing message
 bool espnowIsPaired()
 {
+#ifdef COMPILE_ESPNOW
   if (espnowState == ESPNOW_MAC_RECEIVED)
   {
     //Remove broadcast peer
+    uint8_t broadcastMac[6] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
     espnowRemovePeer(broadcastMac);
 
     if (esp_now_is_peer_exist(receivedMAC) == true)
@@ -221,15 +229,16 @@ bool espnowIsPaired()
     espnowSendPairMessage(receivedMAC);
 
     espnowSetState(ESPNOW_PAIRED);
-    Serial.println("Pairing compete");
-    return(true);
+    return (true);
   }
-  return(false);
+#endif
+  return (false);
 }
 
 //Create special pair packet to a given MAC
 esp_err_t espnowSendPairMessage(uint8_t *sendToMac)
 {
+#ifdef COMPILE_ESPNOW
   // Assemble message to send
   PairMessage pairMessage;
 
@@ -245,6 +254,9 @@ esp_err_t espnowSendPairMessage(uint8_t *sendToMac)
     pairMessage.crc += unitMACAddress[x];
 
   return (esp_now_send(sendToMac, (uint8_t *) &pairMessage, sizeof(pairMessage))); //Send packet to given MAC
+#else
+  return (ESP_OK);
+#endif
 }
 
 //Add a given MAC address to the peer list
@@ -255,6 +267,7 @@ esp_err_t espnowAddPeer(uint8_t *peerMac)
 
 esp_err_t espnowAddPeer(uint8_t *peerMac, bool encrypt)
 {
+#ifdef COMPILE_ESPNOW
   esp_now_peer_info_t peerInfo;
 
   memcpy(peerInfo.peer_addr, peerMac, 6);
@@ -268,15 +281,23 @@ esp_err_t espnowAddPeer(uint8_t *peerMac, bool encrypt)
   if (result != ESP_OK)
     log_d("Failed to add peer");
   return (result);
+#else
+  return (ESP_OK);
+#endif
 }
 
 //Remove a given MAC address from the peer list
 esp_err_t espnowRemovePeer(uint8_t *peerMac)
 {
+#ifdef COMPILE_ESPNOW
   esp_err_t result = esp_now_del_peer(peerMac);
   if (result != ESP_OK)
     log_d("Failed to remove peer");
   return (result);
+#else
+  return (ESP_OK);
+#endif
+
 }
 
 //Update the state of the ESP Now state machine
@@ -285,6 +306,8 @@ void espnowSetState(ESPNOWState newState)
   if (espnowState == newState)
     Serial.print("*");
   espnowState = newState;
+
+  Serial.print("espnowState: ");
   switch (newState)
   {
     case ESPNOW_OFF:
@@ -310,6 +333,7 @@ void espnowSetState(ESPNOWState newState)
 
 void espnowProcessRTCM(byte incoming)
 {
+#ifdef COMPILE_ESPNOW
   if (espnowState == ESPNOW_PAIRED)
   {
     //Move this byte into ESP NOW to send buffer
@@ -326,6 +350,5 @@ void espnowProcessRTCM(byte incoming)
       espnowOutgoingRTCM = true;
     }
   }
+#endif
 }
-
-#endif //ifdef COMPILE_ESPNOW

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -26,10 +26,10 @@ const int FIRMWARE_VERSION_MAJOR = 2;
 const int FIRMWARE_VERSION_MINOR = 4;
 
 #define COMPILE_WIFI //Comment out to remove WiFi functionality
-#define COMPILE_BT //Comment out to remove Bluetooth functionality
-#define COMPILE_AP //Comment out to remove Access Point functionality
-#define COMPILE_L_BAND //Comment out to remove L-Band functionality
-#define COMPILE_ESPNOW //Comment out to remove ESP-Now functionality
+//#define COMPILE_AP //Requires WiFi. Comment out to remove Access Point functionality
+//#define COMPILE_ESPNOW //Requires WiFi. Comment out to remove ESP-Now functionality.
+//#define COMPILE_BT //Comment out to remove Bluetooth functionality
+//#define COMPILE_L_BAND //Comment out to remove L-Band functionality
 #define ENABLE_DEVELOPER //Uncomment this line to enable special developer modes (don't check power button at startup)
 
 //Define the RTK board identifier:

Firmware/RTK_Surveyor/States.ino

@@ -240,7 +240,7 @@ void updateSystemState()
 
           bluetoothStop();
           bluetoothStart(); //Restart Bluetooth with 'Base' identifier
-          
+
           startUART2Tasks(); //Start monitoring the UART1 from ZED for NMEA and UBX data (enables logging)
 
           if (configureUbloxModuleBase() == true)
@@ -900,12 +900,35 @@ void updateSystemState()
         break;
 #endif  //COMPILE_L_BAND
 
-      case (STATE_ESPNOW_PAIR):
+      case (STATE_ESPNOW_PAIRING_NOT_STARTED):
         {
+#ifdef COMPILE_ESPNOW
+          paintEspNowPairing();
 
-espnowIsPaired()
+          //Start ESP-Now if needed, put ESP-Now into broadcast state
+          espnowBeginPairing();
 
-          //Display 'ESP-Now Pairing' while we wait
+          changeState(STATE_ESPNOW_PAIRING);
+#else
+          changeState(STATE_ROVER_NOT_STARTED);
+#endif
+        }
+        break;
+
+      case (STATE_ESPNOW_PAIRING):
+        {
+#ifdef COMPILE_ESPNOW
+          if (espnowIsPaired() == true)
+          {
+            paintEspNowPaired();
+            changeState(STATE_ROVER_NOT_STARTED);
+          }
+          else
+          {
+            uint8_t broadcastMac[6] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
+            espnowSendPairMessage(broadcastMac); //Send unit's MAC address over broadcast, no ack, no encryption
+          }
+#endif
         }
         break;
 
@@ -1051,8 +1074,11 @@ void changeState(SystemState newState)
         break;
 #endif  //COMPILE_L_BAND
 
-      case (STATE_ESPNOW_PAIR):
-        Serial.print("State: ESP-Now Pair");
+      case (STATE_ESPNOW_PAIRING_NOT_STARTED):
+        Serial.print("State: ESP-Now Pairing Not Started");
+        break;
+      case (STATE_ESPNOW_PAIRING):
+        Serial.print("State: ESP-Now Pairing");
         break;
 
       case (STATE_SHUTDOWN):

Firmware/RTK_Surveyor/Tasks.ino

@@ -412,7 +412,8 @@ void ButtonCheckTask(void *e)
           case STATE_BUBBLE_LEVEL:
           case STATE_WIFI_CONFIG_NOT_STARTED:
           case STATE_WIFI_CONFIG:
-          case STATE_ESPNOW_PAIR:
+          case STATE_ESPNOW_PAIRING_NOT_STARTED:
+          case STATE_ESPNOW_PAIRING:
             lastSystemState = systemState; //Remember this state to return after we mark an event
             requestChangeState(STATE_DISPLAY_SETUP);
             setupState = STATE_MARK_EVENT;
@@ -464,9 +465,9 @@ void ButtonCheckTask(void *e)
                 setupState = STATE_WIFI_CONFIG_NOT_STARTED;
                 break;
               case STATE_WIFI_CONFIG_NOT_STARTED:
-                setupState = STATE_ESPNOW_PAIR;
+                setupState = STATE_ESPNOW_PAIRING_NOT_STARTED;
                 break;
-              case STATE_ESPNOW_PAIR:
+              case STATE_ESPNOW_PAIRING_NOT_STARTED:
                 //If only one active profile do not show any profiles
                 index = getProfileNumberFromUnit(0);
                 displayProfile = getProfileNumberFromUnit(1);
@@ -531,7 +532,8 @@ void ButtonCheckTask(void *e)
           case STATE_BUBBLE_LEVEL:
           case STATE_WIFI_CONFIG_NOT_STARTED:
           case STATE_WIFI_CONFIG:
-          case STATE_ESPNOW_PAIR:
+          case STATE_ESPNOW_PAIRING_NOT_STARTED:
+          case STATE_ESPNOW_PAIRING:
             lastSystemState = systemState; //Remember this state to return after we mark an event
             requestChangeState(STATE_DISPLAY_SETUP);
             setupState = STATE_MARK_EVENT;
@@ -583,9 +585,9 @@ void ButtonCheckTask(void *e)
                 setupState = STATE_WIFI_CONFIG_NOT_STARTED;
                 break;
               case STATE_WIFI_CONFIG_NOT_STARTED:
-                setupState = STATE_ESPNOW_PAIR;
+                setupState = STATE_ESPNOW_PAIRING_NOT_STARTED;
                 break;
-              case STATE_ESPNOW_PAIR:
+              case STATE_ESPNOW_PAIRING_NOT_STARTED:
                 //If only one active profile do not show any profiles
                 index = getProfileNumberFromUnit(0);
                 displayProfile = getProfileNumberFromUnit(1);
@@ -618,11 +620,6 @@ void ButtonCheckTask(void *e)
   }
 }
 
-TODO once a user has selected 'Pair', send this once
-  //Start ESP-Now if needed, put ESP-Now into broadcast state
-  espnowBeginPairing();
-
-
 void idleTask(void *e)
 {
   int cpu = xPortGetCoreID();