Merge branch 'release_candidate' into Fix_#362

Author: PaulZC

Firmware/RTK_Everywhere/Begin.ino

@@ -324,7 +324,6 @@ void beginBoard()
 
         // In the fullness of time, pin_Cellular_PWR_ON will (probably) be controlled by the Cellular Library
         DMW_if systemPrintf("pin_Cellular_PWR_ON: %d\r\n", pin_Cellular_PWR_ON);
-        digitalWrite(pin_Cellular_PWR_ON, LOW);
         pinMode(pin_Cellular_PWR_ON, OUTPUT);
         digitalWrite(pin_Cellular_PWR_ON, LOW);
 
@@ -483,6 +482,19 @@ void beginVersion()
     }
 }
 
+void beginSPI(bool force) // Call after beginBoard
+{
+    static bool started = false;
+
+    bool spiNeeded = present.ethernet_ws5500 || present.microSd;
+
+    if (force || (spiNeeded && !started))
+    {
+        SPI.begin(pin_SCK, pin_POCI, pin_PICO);
+        started = true;
+    }
+}
+
 void beginSD()
 {
     if (present.microSd == false)
@@ -624,7 +636,7 @@ void resetSPI()
     sdDeselectCard();
 
     // Flush SPI interface
-    SPI.begin(pin_SCK, pin_POCI, pin_PICO);
+    beginSPI(true);
     SPI.beginTransaction(SPISettings(400000, MSBFIRST, SPI_MODE0));
     for (int x = 0; x < 10; x++)
         SPI.transfer(0XFF);
@@ -634,7 +646,7 @@ void resetSPI()
     sdSelectCard();
 
     // Flush SD interface
-    SPI.begin(pin_SCK, pin_POCI, pin_PICO);
+    beginSPI(true);
     SPI.beginTransaction(SPISettings(400000, MSBFIRST, SPI_MODE0));
     for (int x = 0; x < 10; x++)
         SPI.transfer(0XFF);

Firmware/RTK_Everywhere/Developer.ino

@@ -12,6 +12,7 @@
 void menuEthernet() {systemPrintln("**Ethernet not compiled**");}
 void ethernetBegin() {}
 IPAddress ethernetGetIpAddress() {return IPAddress((uint32_t)0);}
+IPAddress ethernetGetSubnetMask() {return IPAddress((uint32_t)0);}
 void ethernetUpdate() {}
 void ethernetVerifyTables() {}
 
@@ -152,14 +153,17 @@ void discardTcpServerBytes(RING_BUFFER_OFFSET previousTail, RING_BUFFER_OFFSET n
 
 void menuWiFi() {systemPrintln("**WiFi not compiled**");}
 bool wifiConnect(unsigned long timeout) {return false;}
+bool wifiConnect(unsigned long timeout, bool useAPSTAMode, bool *wasInAPmode) {return false;}
 IPAddress wifiGetGatewayIpAddress() {return IPAddress((uint32_t)0);}
 IPAddress wifiGetIpAddress() {return IPAddress((uint32_t)0);}
+IPAddress wifiGetSubnetMask() {return IPAddress((uint32_t)0);}
 int wifiGetRssi() {return -999;}
 String wifiGetSsid() {return "**WiFi Not compiled**";}
 bool wifiIsConnected() {return false;}
 bool wifiIsNeeded() {return false;}
 int wifiNetworkCount() {return 0;}
 void wifiPrintNetworkInfo() {}
+void wifiSetApMode() {}
 void wifiStart() {}
 void wifiStop() {}
 void wifiUpdate() {}

Firmware/RTK_Everywhere/Display.ino

@@ -1470,17 +1470,12 @@ void displayBatteryVsEthernet(std::vector<iconPropertyBlinking> *iconList)
         paintBatteryLevel(iconList);
     else // if (present.ethernet_ws5500 == true)
     {
-        if (online.ethernetStatus == ETH_NOT_STARTED)
-            return; // If Ethernet has not stated because not needed, don't display the icon
+        if (online.ethernetStatus != ETH_CONNECTED)
+            return; // Only display the Ethernet icon if we are successfully connected (no blinking)
 
         iconPropertyBlinking prop;
         prop.icon = EthernetIconProperties.iconDisplay[present.display_type];
-
-        if (online.ethernetStatus == ETH_CONNECTED)
-            prop.duty = 0b11111111;
-        else
-            prop.duty = 0b01010101;
-
+        prop.duty = 0b11111111;
         iconList->push_back(prop);
     }
 }
@@ -2812,7 +2807,7 @@ void paintGettingKeys()
 
 void paintGettingEthernetIP()
 {
-    displayMessage("Getting IP", 0);
+    displayMessage("Getting IP", 1000);
 }
 
 // If an L-Band is indoors without reception, we have a ~2s wait for the RTC to come online

Firmware/RTK_Everywhere/Ethernet.ino

@@ -35,6 +35,17 @@ void menuEthernet()
             systemPrintln(settings.ethernetSubnet.toString().c_str());
         }
 
+        //------------------------------
+        // Display the network layer menu items
+        //------------------------------
+
+        systemPrint("d) Default network: ");
+        networkPrintName(settings.defaultNetworkType);
+        systemPrintln();
+
+        systemPrint("f) Ethernet / WiFi Failover: ");
+        systemPrintf("%s\r\n", settings.enableNetworkFailover ? "Enabled" : "Disabled");
+
         systemPrintln("x) Exit");
 
         byte incoming = getUserInputCharacterNumber();
@@ -96,6 +107,24 @@ void menuEthernet()
             else
                 systemPrint("Error: invalid Subnet Mask");
         }
+
+        //------------------------------
+        // Get the network layer parameters
+        //------------------------------
+
+        else if (incoming == 'd')
+        {
+            // Toggle the network type
+            settings.defaultNetworkType += 1;
+            if (settings.defaultNetworkType > NETWORK_TYPE_USE_DEFAULT)
+                settings.defaultNetworkType = 0;
+        }
+        else if (incoming == 'f')
+        {
+            // Toggle failover support
+            settings.enableNetworkFailover ^= 1;
+        }
+
         else if (incoming == 'x')
             break;
         else if (incoming == INPUT_RESPONSE_GETCHARACTERNUMBER_EMPTY)
@@ -133,6 +162,12 @@ IPAddress ethernetGetIpAddress()
     return ETH.localIP();
 }
 
+// Return the subnet mask for the Ethernet controller
+IPAddress ethernetGetSubnetMask()
+{
+    return ETH.subnetMask();
+}
+
 // Determine if Ethernet is needed. Saves RAM...
 bool ethernetIsNeeded()
 {

Firmware/RTK_Everywhere/MQTT_Client.ino

@@ -122,7 +122,9 @@ static int mqttClientConnectionAttemptsTotal; // Count the number of connection
 
 static volatile uint32_t mqttClientLastDataReceived; // Last time data was received via MQTT
 
-static NetworkSecureWiFiClient *mqttSecureClient;
+static char *mqttClientPrivateKeyBuffer; // Buffer for client private key
+
+static RTKNetworkSecureClient *mqttSecureClient;
 
 static volatile uint8_t mqttClientState = MQTT_CLIENT_OFF;
 
@@ -554,7 +556,7 @@ void mqttClientUpdate()
         }
 
         // Allocate the mqttSecureClient structure
-        mqttSecureClient = new NetworkSecureWiFiClient();
+        mqttSecureClient = new RTKNetworkSecureClient();
         if (!mqttSecureClient)
         {
             systemPrintln("ERROR: Failed to allocate the mqttSecureClient structure!");

Firmware/RTK_Everywhere/NVM.ino

@@ -346,7 +346,7 @@ void recordSystemSettingsToFile(File *settingsFile)
             // Record constellation settings
             for (int x = 0; x < rtkSettingsEntries[i].qualifier; x++)
             {
-                char tempString[50]; // ubxConstellation_BeiDou=1
+                char tempString[50]; // constellation_BeiDou=1
                 snprintf(tempString, sizeof(tempString), "%s%s=%d", rtkSettingsEntries[i].name,
                          settings.ubxConstellations[x].textName, settings.ubxConstellations[x].enabled);
                 settingsFile->println(tempString);
@@ -1424,6 +1424,20 @@ int8_t getProfileNumberFromUnit(uint8_t profileUnit)
     return (-1);
 }
 
+// Returns the number of available profiles
+// https://stackoverflow.com/questions/8871204/count-number-of-1s-in-binary-representation
+uint8_t getProfileCount()
+{
+    int count = 0;
+    uint8_t n = activeProfiles;
+    while (n != 0)
+    {
+        n = n & (n - 1);
+        count++;
+    }
+    return (count);
+}
+
 // Record large character blob to file
 void recordFile(const char *fileID, char *fileContents, uint32_t fileSize)
 {

Firmware/RTK_Everywhere/Network.ino

@@ -232,20 +232,6 @@ void menuTcpUdp()
         if (settings.enableUdpServer)
             systemPrintf("7) UDP Server Port: %ld\r\n", settings.udpServerPort);
 
-        if (present.ethernet_ws5500 == true)
-        {
-            //------------------------------
-            // Display the network layer menu items
-            //------------------------------
-
-            systemPrint("d) Default network: ");
-            networkPrintName(settings.defaultNetworkType);
-            systemPrintln();
-
-            systemPrint("f) Ethernet / WiFi Failover: ");
-            systemPrintf("%s\r\n", settings.enableNetworkFailover ? "Enabled" : "Disabled");
-        }
-
         //------------------------------
         // Finish the menu and get the input
         //------------------------------
@@ -317,23 +303,6 @@ void menuTcpUdp()
             getNewSetting("Enter the UDP port to use", 0, 65535, &settings.udpServerPort);
         }
 
-        //------------------------------
-        // Get the network layer parameters
-        //------------------------------
-
-        else if ((incoming == 'd') && (present.ethernet_ws5500 == true))
-        {
-            // Toggle the network type
-            settings.defaultNetworkType += 1;
-            if (settings.defaultNetworkType > NETWORK_TYPE_USE_DEFAULT)
-                settings.defaultNetworkType = 0;
-        }
-        else if ((incoming == 'f') && (present.ethernet_ws5500 == true))
-        {
-            // Toggle failover support
-            settings.enableNetworkFailover ^= 1;
-        }
-
         //------------------------------
         // Handle exit and invalid input
         //------------------------------
@@ -464,6 +433,23 @@ NETWORK_DATA *networkGet(uint8_t networkType, bool updateRequestedNetwork)
     return network;
 }
 
+//----------------------------------------
+// Get the broadast IP address
+//----------------------------------------
+IPAddress networkGetBroadcastIpAddress(uint8_t networkType)
+{
+    IPAddress ip;
+    IPAddress mask;
+    IPAddress temp;
+
+    // Get the local network address and subnet mask
+    ip = networkGetIpAddress(networkType);
+    mask = networkGetSubnetMask(networkType);
+
+    // Return the local network broadcast IP address
+    return IPAddress((uint32_t)ip | (~(uint32_t)mask));
+}
+
 //----------------------------------------
 // Get the IP address
 //----------------------------------------
@@ -476,6 +462,19 @@ IPAddress networkGetIpAddress(uint8_t networkType)
     return IPAddress((uint32_t)0);
 }
 
+//----------------------------------------
+// Get the subnet mask
+//----------------------------------------
+IPAddress networkGetSubnetMask(uint8_t networkType)
+{
+    // Determine the network address
+    if (networkType == NETWORK_TYPE_ETHERNET)
+        return ethernetGetSubnetMask();
+    else if (networkType == NETWORK_TYPE_WIFI)
+        return wifiGetSubnetMask();
+    return IPAddress((uint32_t)0);
+}
+
 //----------------------------------------
 // Get the network type
 //----------------------------------------

Firmware/RTK_Everywhere/RTKNetworkClient.h

@@ -259,22 +259,21 @@ class RTKNetworkClientType : public RTKNetworkClient
     }
 };
 
-#ifdef COMPILE_WIFI
-class NetworkSecureWiFiClient : public RTKNetworkClient
+class RTKNetworkSecureClient : public RTKNetworkClient
 {
   protected:
     NetworkClientSecure _client;
 
   public:
-    NetworkSecureWiFiClient() : _client{WiFiClientSecure()}, RTKNetworkClient(&_client, NETWORK_TYPE_WIFI)
+    RTKNetworkSecureClient() : _client{NetworkClientSecure()}, RTKNetworkClient(&_client, NETWORK_TYPE_WIFI)
     {
     }
 
-    NetworkSecureWiFiClient(WiFiClient &client) : _client{client}, RTKNetworkClient(&_client, NETWORK_TYPE_WIFI)
+    RTKNetworkSecureClient(NetworkClientSecure &client) : _client{client}, RTKNetworkClient(&_client, NETWORK_TYPE_WIFI)
     {
     }
 
-    ~NetworkSecureWiFiClient()
+    ~RTKNetworkSecureClient()
     {
         this->~RTKNetworkClient();
     }
@@ -372,6 +371,4 @@ class NetworkSecureWiFiClient : public RTKNetworkClient
     }
 };
 
-#endif // COMPILE_WIFI
-
 #endif // __NETWORK_CLIENT_H__