Decouple WiFi and ESPNOW states.

Make wifiStart/Stop and esnowStart/Stop friendly and independent.

Author: nseidle

Firmware/RTK_Surveyor/Base.ino

@@ -229,7 +229,7 @@ void SFE_UBLOX_GNSS::processRTCM(uint8_t incoming)
 {
   ntripServerProcessRTCM(incoming);
 
-  if (wifiState == WIFI_ESPNOW_PAIRED)
+  if (wifiState == ESPNOW_PAIRED)
   {
     //Move this byte into ESP NOW to send buffer
     espnowOutgoing[espnowOutgoingSpot++] = incoming;

Firmware/RTK_Surveyor/Begin.ino

@@ -842,7 +842,7 @@ void beginRadio()
 {
   if (settings.radioType == RADIO_EXTERNAL)
   {
-    wifiStop();
+    espnowStop();
 
     //Nothing to start. UART2 of ZED is connected to external Radio port and is configured at configureUbloxModule()
   }

Firmware/RTK_Surveyor/Display.ino

@@ -2,7 +2,7 @@
 // Constants
 //----------------------------------------
 
-//A bitfield is used to flag which icon needs to be illuminated 
+//A bitfield is used to flag which icon needs to be illuminated
 //systemState will dictate most of the icons needed
 
 //Left top
@@ -602,16 +602,26 @@ void paintBatteryLevel()
 //Display Bluetooth icon, Bluetooth MAC, WiFi, or ESP NOW depending on connection state
 uint32_t paintWirelessIcon()
 {
-  uint32_t icons;
+  uint32_t icons = 0;
 
   //TODO resolve if both BT and WiFi are on/connected
   icons = 0;
   if (online.display == true)
   {
+    //Deal with each icon individiually
+    //The ESPNOW_PAIRED is the only state where data is moving between units,
+    //and thus is the only state that affects icon placement
+    
     //Bluetooth icon if paired, or Bluetooth MAC address if not paired
-    if (bluetoothGetState() == BT_CONNECTED && wifiState == WIFI_OFF)
+    if (bluetoothGetState() == BT_CONNECTED)
     {
-      icons = ICON_BT_SYMBOL;
+      if (espnowState != ESPNOW_PAIRED)
+        icons |= ICON_BT_SYMBOL;
+      else
+        icons |= ICON_BT_SYMBOL_RIGHT;
+
+      //TODO deal with arrows when ESP Now paired
+
       if (systemState <= STATE_BASE_NOT_STARTED)
       {
         if (online.rxRtcmCorrectionData)
@@ -620,58 +630,57 @@ uint32_t paintWirelessIcon()
       else if (systemState <= STATE_BUBBLE_LEVEL)
         icons |= ICON_UP_ARROW;
     }
-    else if (wifiState == WIFI_NOTCONNECTED)
+    else
+    {
+      if (espnowState != ESPNOW_PAIRED)
+        icons |= ICON_MAC_ADDRESS;
+      else
+        icons |= ICON_MAC_ADDRESS_2DIGIT;
+    }
+
+    if (wifiState == WIFI_NOTCONNECTED)
     {
       //Blink WiFi icon
-      blinking_icons ^= ICON_WIFI_SYMBOL_LEFT;
-      if (blinking_icons & ICON_WIFI_SYMBOL_LEFT)
-        icons = ICON_WIFI_SYMBOL_LEFT;
+      if (espnowState != ESPNOW_PAIRED)
+      {
+        blinking_icons ^= ICON_WIFI_SYMBOL_LEFT;
+        if (blinking_icons & ICON_WIFI_SYMBOL_LEFT)
+          icons |= ICON_WIFI_SYMBOL_LEFT;
+      }
+      else
+      {
+        //Move to center
+        blinking_icons ^= ICON_WIFI_SYMBOL_CENTER;
+        if (blinking_icons & ICON_WIFI_SYMBOL_CENTER)
+          icons |= ICON_WIFI_SYMBOL_CENTER;
+      }
     }
     else if (wifiState == WIFI_CONNECTED)
     {
-      icons = ICON_WIFI_SYMBOL_LEFT;
+      if (espnowState != ESPNOW_PAIRED)
+        icons |= ICON_WIFI_SYMBOL_LEFT;
+      else
+        icons |= ICON_WIFI_SYMBOL_CENTER;
+
+      //TODO deal with arrows when ESP now paired
 
       //If we are connected to NTRIP Client, show download arrow
       if ((online.ntripClient == true) && online.rxRtcmCorrectionData)
         icons |= ICON_DOWN_ARROW;
       else if (online.ntripServer == true)
         icons |= ICON_UP_ARROW;
     }
-    else if (wifiState == WIFI_ESPNOW_PAIRED)
+
+    if (espnowState == ESPNOW_PAIRED)
     {
-      //If ESPNOW is on, and we are in base mode, show animated icon
-      if(systemState >= STATE_BASE_NOT_STARTED && systemState <= STATE_BASE_FIXED_TRANSMITTING)
-      {
-        //Display ESPNOW and BT (either MAC or symbol)
-        icons = ICON_ESPNOW_SYMBOL;
-        if (bluetoothGetState() == BT_CONNECTED)
-          icons |= ICON_BT_SYMBOL_RIGHT;
-        else
-          icons |= ICON_MAC_ADDRESS_2DIGIT;
-      }
-      
+      //If ESPNOW is paired, and we are in base mode, show animated icon
+      if (systemState >= STATE_BASE_NOT_STARTED && systemState <= STATE_BASE_FIXED_TRANSMITTING)
+        icons |= ICON_ESPNOW_SYMBOL;
+
       //If ESPNOW is on, and we've received a packet, move BT to make room
       else if (espnowRSSI > -255)
-      {
-        //Display ESPNOW and BT (either MAC or symbol)
-        icons = ICON_ESPNOW_SYMBOL;
-        if (bluetoothGetState() == BT_CONNECTED)
-          icons |= ICON_BT_SYMBOL_RIGHT;
-        else
-          icons |= ICON_MAC_ADDRESS_2DIGIT; //Display 2 digit MAC
-      }
-
-      //No ESPNOW icon
-      else
-      {
-        if (bluetoothGetState() == BT_CONNECTED)
-          icons = ICON_BT_SYMBOL;
-        else
-          icons = ICON_MAC_ADDRESS; //Display full MAC
-      }
+        icons |= ICON_ESPNOW_SYMBOL;
     }
-    else
-      icons = ICON_MAC_ADDRESS;
   }
   return icons;
 }

Firmware/RTK_Surveyor/ESPNOW.ino

@@ -26,19 +26,19 @@ typedef struct PairMessage {
 #ifdef COMPILE_WIFI
 void espnowOnDataSent(const uint8_t *mac_addr, esp_now_send_status_t status)
 {
-//  Serial.print("Last Packet Send Status: ");
-//  if (status == ESP_NOW_SEND_SUCCESS)
-//    Serial.println("Delivery Success");
-//  else
-//    Serial.println("Delivery Fail");
+  //  Serial.print("Last Packet Send Status: ");
+  //  if (status == ESP_NOW_SEND_SUCCESS)
+  //    Serial.println("Delivery Success");
+  //  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_WIFI
-  if (wifiState == WIFI_ESPNOW_PAIRING)
+  if (espnowState == ESPNOW_PAIRING)
   {
     if (len == sizeof(PairMessage)) //First error check
     {
@@ -53,7 +53,7 @@ void espnowOnDataRecieved(const uint8_t *mac, const uint8_t *incomingData, int l
       if (tempCRC == pairMessage.crc) //2nd error check
       {
         memcpy(&receivedMAC, pairMessage.macAddress, 6);
-        wifiSetState(WIFI_ESPNOW_MAC_RECEIVED);
+        espnowSetState(ESPNOW_MAC_RECEIVED);
       }
       //else Pair CRC failed
     }
@@ -86,17 +86,29 @@ void promiscuous_rx_cb(void *buf, wifi_promiscuous_pkt_type_t type)
 }
 #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_WIFI
-  // If we are in WIFI_OFF or WIFI_ON, CONNECTED, NOTCONNECTED, doesn't matter
-  // General WiFi will be turned off/disconnected and replaced by ESP NOW
 
-  // Set device as a Wi-Fi Station
-  WiFi.mode(WIFI_STA);
-
-  // Enable long range, PHY rate of ESP32 will be 512Kbps or 256Kbps
-  esp_wifi_set_protocol(WIFI_IF_STA, WIFI_PROTOCOL_LR);
+  if (wifiState == WIFI_OFF && espnowState == ESPNOW_OFF)
+  {
+    //Radio is off, turn it on
+    WiFi.mode(WIFI_STA);
+  }
+  //If WiFi is on but ESP NOW is off, then enable LR protocol
+  else if (wifiState > WIFI_OFF && espnowState == ESPNOW_OFF)
+  {
+    //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);
+  }
+  //If ESP-Now is active, WiFi is active, do nothing
+  else
+  {
+    Serial.println("Wi-Fi on, ESP-Now on");
+  }
 
   // Init ESP-NOW
   if (esp_now_init() != ESP_OK) {
@@ -108,18 +120,18 @@ void espnowStart()
   esp_wifi_set_promiscuous(true);
   esp_wifi_set_promiscuous_rx_cb(&promiscuous_rx_cb);
 
-  // Register send callbacks
+  // Register callbacks
   //esp_now_register_send_cb(espnowOnDataSent);
   esp_now_register_recv_cb(espnowOnDataRecieved);
 
   if (settings.espnowPeerCount == 0)
   {
-    wifiSetState(WIFI_ESPNOW_ON);
+    espnowSetState(ESPNOW_ON);
   }
   else
   {
     //If we already have peers, move to paired state
-    wifiSetState(WIFI_ESPNOW_PAIRED);
+    espnowSetState(ESPNOW_PAIRED);
 
     log_d("Adding %d espnow peers", settings.espnowPeerCount);
     for (int x = 0 ; x < settings.espnowPeerCount ; x++)
@@ -140,27 +152,60 @@ void espnowStart()
 #endif
 }
 
-//Begin broadcasting our MAC and wait for remote unit to respond
-void espnowBeginPairing()
+//If WiFi is already enabled, simply remove the LR protocol
+//If WiFi is off, stop the radio entirely
+void espnowStop()
 {
-#ifndef COMPILE_WIFI
-  return;
-#endif
+#ifdef COMPILE_WIFI
+  if(espnowState == ESPNOW_OFF) return;
 
-  if (wifiState != WIFI_ESPNOW_ON
-      || wifiState != WIFI_ESPNOW_PAIRING
-      || wifiState != WIFI_ESPNOW_MAC_RECEIVED
-      || wifiState != WIFI_ESPNOW_PAIRED
-     )
+  if (wifiState > WIFI_OFF)
   {
-    espnowStart();
+    //Radio is on, turn it off entirely
+    WiFi.mode(WIFI_OFF);
+    Serial.println("WiFi Radio off entirely");
+  }
+  //If WiFi is on, then disable LR protocol
+  else if (wifiState > WIFI_OFF)
+  {
+    // Return protocol to default settings (no WIFI_PROTOCOL_LR for ESP NOW)
+    esp_wifi_set_protocol(WIFI_IF_STA, WIFI_PROTOCOL_11B | WIFI_PROTOCOL_11G | WIFI_PROTOCOL_11N);
+    Serial.println("WiFi protocol on, LR protocol off");
+  }
+
+  // Turn off promiscuous WiFi mode
+  esp_wifi_set_promiscuous(false);
+  esp_wifi_set_promiscuous_rx_cb(NULL);
+
+  // Deregister callbacks
+  //esp_now_unregister_send_cb();
+  esp_now_unregister_recv_cb();
+
+  // Deinit ESP-NOW
+  if (esp_now_deinit() != ESP_OK) {
+    Serial.println("Error deinitializing ESP-NOW");
+    return;
   }
 
+  espnowSetState(ESPNOW_OFF);
+
+  Serial.println("ESP NOW Off");
+#else
+  Serial.println("Error - WiFi not compiled");
+#endif
+}
+
+//Begin broadcasting our MAC and wait for remote unit to respond
+void espnowBeginPairing()
+{
+#ifdef COMPILE_WIFI
+  espnowStart();
+
   // To begin pairing, we must add the broadcast MAC to the peer list
   uint8_t broadcastMac[6] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
   espnowAddPeer(broadcastMac, false); // Encryption is not supported for multicast addresses
 
-  wifiSetState(WIFI_ESPNOW_PAIRING);
+  espnowSetState(ESPNOW_PAIRING);
 
   //Begin sending our MAC every 250ms until a remote device sends us there info
   randomSeed(millis());
@@ -177,7 +222,7 @@ void espnowBeginPairing()
     {
       delay(1);
 
-      if (wifiState == WIFI_ESPNOW_MAC_RECEIVED)
+      if (espnowState == ESPNOW_MAC_RECEIVED)
       {
         //Remove broadcast peer
         espnowRemovePeer(broadcastMac);
@@ -198,7 +243,7 @@ void espnowBeginPairing()
         //Send message directly to the received MAC (not unicast), then exit
         espnowSendPairMessage(receivedMAC);
 
-        wifiSetState(WIFI_ESPNOW_PAIRED);
+        espnowSetState(ESPNOW_PAIRED);
         Serial.println("Pairing compete");
         return;
       }
@@ -210,6 +255,9 @@ void espnowBeginPairing()
   }
 
   Serial.println("User pressed button. Pairing canceled.");
+#else
+  Serial.println("WiFi not compiled");
+#endif
 }
 
 //Create special pair packet to a given MAC
@@ -275,3 +323,32 @@ esp_err_t espnowRemovePeer(uint8_t *peerMac)
   return (ESP_OK);
 #endif
 }
+
+//Update the state of the ESP Now state machine
+void espnowSetState (byte newState)
+{
+  if (espnowState == newState)
+    Serial.print("*");
+  espnowState = newState;
+  switch (newState)
+  {
+    default:
+      Serial.printf("Unknown ESPNOW state: %d\r\n", newState);
+      break;
+    case ESPNOW_OFF:
+      Serial.println("ESPNOW_OFF");
+      break;
+    case ESPNOW_ON:
+      Serial.println("ESPNOW_ON");
+      break;
+    case ESPNOW_PAIRING:
+      Serial.println("ESPNOW_PAIRING");
+      break;
+    case ESPNOW_MAC_RECEIVED:
+      Serial.println("ESPNOW_MAC_RECEIVED");
+      break;
+    case ESPNOW_PAIRED:
+      Serial.println("ESPNOW_PAIRED");
+      break;
+  }
+}

Firmware/RTK_Surveyor/RTK_Surveyor.ino

@@ -26,7 +26,7 @@ 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_BT //Comment out to remove Bluetooth functionality
 #define COMPILE_AP //Comment out to remove Access Point functionality
 #define ENABLE_DEVELOPER //Uncomment this line to enable special developer modes (don't check power button at startup)
 
@@ -835,7 +835,7 @@ void updateRadio()
 {
   if (settings.radioType == RADIO_ESPNOW)
   {
-    if (wifiState == WIFI_ESPNOW_PAIRED)
+    if (espnowState == ESPNOW_PAIRED)
     {
       //If it's been longer than a few ms since we last added a byte to the buffer
       //then we've reached the end of the RTCM stream. Send partial buffer.