Added SmartConfig support for WiFi configuration via phone app

Refactor WiFi code
Send firmware and hardware information in handshake

src/defines.h

@@ -111,4 +111,7 @@
 #define sensorIdTime 1000
 #define sensorIdInterval 100
 
-#define batteryADCMultiplier 1.0 / 1024.0 * 5.0
+#define batteryADCMultiplier 1.0 / 1024.0 * 5.0
+
+#define FIRMWARE_BUILD_NUMBER 1
+#define FIRMWARE_VERSION "0.0.1-REV1"

src/main.cpp

@@ -25,6 +25,7 @@
 #include "ota.h"
 #include "sensor.h"
 #include "configuration.h"
+#include "wifi.h"
 #include "udpclient.h"
 #include "defines.h"
 #include "credentials.h"

src/udpclient.cpp

@@ -24,6 +24,7 @@
 #include "udpclient.h"
 #include "configuration.h"
 #include "defines.h"
+#include "wifi.h"
 
 #define TIMEOUT 3000UL
 
@@ -38,16 +39,19 @@ commandRecievedCallback fp_commandCallback;
 IPAddress broadcast = IPAddress(255, 255, 255, 255);
 
 int port = 6969;
-IPAddress host;
+IPAddress host = IPAddress(255, 255, 255, 255);
 bool connected = false;
 unsigned long lastConnectionAttemptMs;
 unsigned long lastPacketMs;
-unsigned long lastWifiReportTime = 0;
-bool isWifiConnected = false;
 
 uint8_t serialBuffer[128];
 size_t serialLength = 0;
 
+bool sensorStateNotified1 = false;
+bool sensorStateNotified2 = false;
+unsigned long lastSensorInfoPacket = 0;
+
+
 template <typename T>
 unsigned char * convert_to_chars(T src, unsigned char * target)
 {
@@ -315,6 +319,31 @@ void sendSensorInfo(char const sensorId, char const sensorState, int type)
     }
 }
 
+void sendHandshake() {
+    if (Udp.beginPacket(host, port) > 0)
+    {
+        sendType(3);
+        Udp.write(convert_to_chars((uint64_t) 0, buf), sizeof(uint64_t));
+        Udp.write(convert_to_chars((uint32_t) BOARD, buf), sizeof(uint32_t));
+        Udp.write(convert_to_chars((uint32_t) IMU, buf), sizeof(uint32_t));
+        Udp.write(convert_to_chars((uint32_t) 0, buf), sizeof(uint32_t)); // TODO Send actual IMU hw version read from the chip
+        Udp.write(convert_to_chars((uint32_t) 0, buf), sizeof(uint32_t));
+        Udp.write(convert_to_chars((uint32_t) 0, buf), sizeof(uint32_t));
+        Udp.write(convert_to_chars((uint32_t) FIRMWARE_BUILD_NUMBER, buf), sizeof(uint32_t));
+        Udp.write(FIRMWARE_VERSION, sizeof(FIRMWARE_VERSION));
+        if (Udp.endPacket() == 0)
+        {
+            Serial.print("Write error: ");
+            Serial.println(Udp.getWriteError());
+        }
+    }
+    else
+    {
+        Serial.print("Write error: ");
+        Serial.println(Udp.getWriteError());
+    }
+}
+
 void returnLastPacket(int len) {
     if (Udp.beginPacket(host, port) > 0)
     {
@@ -337,10 +366,6 @@ void setCommandRecievedCallback(commandRecievedCallback callback)
     fp_commandCallback = callback;
 }
 
-bool sensorStateNotified1 = false;
-bool sensorStateNotified2 = false;
-unsigned long lastSensorInfoPacket = 0;
-
 void updateSensorState(Sensor * const sensor, Sensor * const sensor2) {
     if(millis() - lastSensorInfoPacket > 1000) {
         lastSensorInfoPacket = millis();
@@ -351,9 +376,13 @@ void updateSensorState(Sensor * const sensor, Sensor * const sensor2) {
     }
 }
 
+void onWiFiConnected() {
+    Udp.begin(port);
+}
+
 void clientUpdate(Sensor * const sensor, Sensor * const sensor2)
 {
-    if (isWifiConnected)
+    if (isWiFiConnected())
     {
         if(connected) {
             int packetSize = Udp.parsePacket();
@@ -445,73 +474,6 @@ void clientUpdate(Sensor * const sensor, Sensor * const sensor2)
     }
 }
 
-bool startWPSPBC() {
-    // from https://gist.github.com/copa2/fcc718c6549721c210d614a325271389
-    // wpstest.ino
-    Serial.println("WPS config start");
-    bool wpsSuccess = WiFi.beginWPSConfig();
-    if(wpsSuccess) {
-        // Well this means not always success :-/ in case of a timeout we have an empty ssid
-        String newSSID = WiFi.SSID();
-        if(newSSID.length() > 0) {
-            // WPSConfig has already connected in STA mode successfully to the new station. 
-            Serial.printf("WPS finished. Connected successfully to SSID '%s'\n", newSSID.c_str());
-        } else {
-            wpsSuccess = false;
-        }
-    }
-    return wpsSuccess; 
-}
-
-void setUpWiFi(DeviceConfig * const config) {
-    Serial.print("Connecting to wifi ");
-    WiFi.mode(WIFI_STA);
-    WiFi.hostname("SlimeVR");
-    WiFi.begin(WiFi.SSID().c_str(), WiFi.psk().c_str());
-}
-
-namespace {
-    void reportWifiError() {
-        if(lastWifiReportTime + 1000 < millis()) {
-            lastWifiReportTime = millis();
-            Serial.print(".");
-        }
-    }
-}
-
-void wifiUpkeep() {
-    if(isWifiConnected)
-        return;
-
-    if(WiFi.status() == WL_DISCONNECTED)
-    {
-        // WiFi is in disconnected state, wait until it connects or erros out
-        reportWifiError();
-        return;
-    }
-    if(WiFi.status() != WL_CONNECTED) {
-        // Wifi is not connected, try connecting with WPS
-        //Serial.printf("\nCould not connect to WiFi. state='%d'\n", WiFi.status());
-        //Serial.println("Please press WPS button on your router, until mode is indicated.");
-
-        //while(true) {
-            if(!startWPSPBC()) {
-                Serial.println("Failed to connect with WPS");
-            } else {
-                WiFi.begin(WiFi.SSID().c_str(), WiFi.psk().c_str()); // reading data from EPROM, 
-                // WiFi will start connecting here until errors out or connects
-            }
-        //}
-    }
-
-    if(WiFi.status() == WL_CONNECTED && !isWifiConnected) {
-        // Wasn't connected, but now connected, stop waiting
-        isWifiConnected = true;
-        Serial.printf("\nConnected successfully to SSID '%s', ip address %s\n", WiFi.SSID().c_str(), WiFi.localIP().toString().c_str());
-        Udp.begin(port);
-    }
-}
-
 bool isConnected() {
     return connected;
 }
@@ -530,11 +492,13 @@ void connectClient()
             for (int i = 0; i < len; ++i)
                 Serial.print((byte)incomingPacket[i]);
             Serial.println();
-
+            // Handshake is different, it has 3 in the first byte, not the 4th, and data starts right after
             switch (incomingPacket[0])
             {
             case PACKET_HANDSHAKE:
-                // Assume handshake sucessful
+                // Assume handshake sucessful, don't check it
+                // But proper handshake should contain "Hey OVR =D 5" ASCII string right after the packet number
+                // Starting on 14th byte (packet number, 12 bytes greetings, null-terminator) we can transfer SlimeVR handshake data
                 host = Udp.remoteIP();
                 port = Udp.remotePort();
                 lastPacketMs = now;
@@ -557,20 +521,7 @@ void connectClient()
     {
         lastConnectionAttemptMs = now;
         Serial.println("Looking for the server...");
-        if (Udp.beginPacket(broadcast, port) > 0)
-        {
-            Udp.write(handshake, 12);
-            if (Udp.endPacket() == 0)
-            {
-                Serial.print("Write error: ");
-                Serial.println(Udp.getWriteError());
-            }
-        }
-        else
-        {
-            Serial.print("Write error: ");
-            Serial.println(Udp.getWriteError());
-        }
+        sendHandshake();
 #ifndef SEND_UPDATES_UNCONNECTED
         digitalWrite(LOADING_LED, LOW);
 #endif

src/udpclient.h

@@ -73,8 +73,7 @@ void sendRawCalibrationData(int * const data, int type);
 void setConfigRecievedCallback(configRecievedCallback);
 void setCommandRecievedCallback(commandRecievedCallback);
 void sendSerial(uint8_t *const data, int length, int type);
-void setUpWiFi(DeviceConfig * const config);
-void wifiUpkeep();
+void onWiFiConnected();
 bool isConnected();
 
 template<typename T> T convert_chars(unsigned char* src);

src/wifi.cpp

@@ -0,0 +1,72 @@
+/*
+    SlimeVR Code is placed under the MIT license
+    Copyright (c) 2021 Eiren Rain
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.
+*/
+
+#include "wifi.h"
+#include "udpclient.h"
+#include "defines.h"
+
+unsigned long lastWifiReportTime = 0;
+unsigned long wifiConnectionTimeout = millis();
+bool isWifiConnected = false;
+
+namespace {
+    void reportWifiError() {
+        if(lastWifiReportTime + 1000 < millis()) {
+            lastWifiReportTime = millis();
+            Serial.print(".");
+        }
+    }
+}
+
+bool isWiFiConnected() {
+    return isWifiConnected;
+}
+
+void setUpWiFi(DeviceConfig * const config) {
+    Serial.println("Setting up WiFi");
+    WiFi.mode(WIFI_STA);
+    WiFi.hostname("SlimeVR FBT Tracker");
+    WiFi.begin(WiFi.SSID().c_str(), WiFi.psk().c_str());
+    wifiConnectionTimeout = millis();
+}
+
+void onConnected() {
+    isWifiConnected = true;
+    Serial.printf("\nConnected successfully to SSID '%s', ip address %s\n", WiFi.SSID().c_str(), WiFi.localIP().toString().c_str());
+    onWiFiConnected();
+}
+
+void wifiUpkeep() {
+    if(WiFi.status() != WL_CONNECTED) {
+        reportWifiError();
+        if(!WiFi.smartConfigDone() && wifiConnectionTimeout + 11000 < millis()) {
+            WiFi.beginSmartConfig();
+        }
+        return;
+    }
+    if(!isWifiConnected) {
+        onConnected();
+        return;
+    }
+    return; // Everything else is not used with smart config
+}

src/wifi.h

@@ -21,13 +21,13 @@
     THE SOFTWARE.
 */
 
-#ifndef _WIFICREDENTIALS_H_
-#define _WIFICREDENTIALS_H_ 1
+#ifndef _WIFI_H_
+#define _WIFI_H_
 
-// Default wifi credentials
-char* networkName = "";
-char* networkPassword = "";
-char* host = "";
-int port = 6969;
+#include "configuration.h"
 
-#endif // _WIFICREDENTIALS_H_
+bool isWiFiConnected();
+void setUpWiFi(DeviceConfig * const config);
+void wifiUpkeep();
+
+#endif // _WIFI_H_