Fancy wifi provisioning

.gitignore

@@ -3,5 +3,6 @@
 build/
 venv/
 cache/
+.cache/
 .idea/
 compile_commands.json

src/GlobalVars.h

@@ -29,7 +29,7 @@
 #include "network/connection.h"
 #include "network/manager.h"
 #include "network/wifihandler.h"
-#include "network/wifiprovisioning.h"
+#include "network/wifiprovisioning/wifi-provisioning.h"
 #include "sensors/SensorManager.h"
 #include "status/LEDManager.h"
 #include "status/StatusManager.h"
@@ -43,4 +43,4 @@ extern SlimeVR::Network::Manager networkManager;
 extern SlimeVR::Network::Connection networkConnection;
 extern BatteryMonitor battery;
 extern SlimeVR::WiFiNetwork wifiNetwork;
-extern SlimeVR::WifiProvisioning wifiProvisioning;
+extern SlimeVR::Network::WiFiProvisioning wifiProvisioning;

src/credentials.cpp

@@ -0,0 +1,36 @@
+/* SlimeVR Code is placed under the MIT license
+	Copyright (c) 2025 Gorbit99 & SlimeVR Contributors
+
+	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.
+*/
+
+// The OTA password is public, server should know it for OTA updates,
+// and devices don't have any authentication anyway.
+// We have password here to prevent random attacks on IOT things
+// that might try to hack all esp-based devices and upload malicious
+// firmware. We don't have any hardware buttons for the user to confirm
+// OTA update, so this is the best way we have.
+// OTA is allowed only for the first 60 seconds after device startup.
+
+const char* otaPassword
+	= "SlimeVR-OTA";  // YOUR OTA PASSWORD HERE, LEAVE EMPTY TO DISABLE OTA UPDATES
+
+const char* provisioningPassword
+	= "SlimeVR-Provisioning";  // YOUR PROVISIONING PASSWORD HERE, LEAVE EMPTY TO
+							   // DISABLE WIFI PROVISIONING

src/credentials.h

@@ -20,17 +20,7 @@
 	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 	THE SOFTWARE.
 */
-#ifndef SLIMEVR_CREDENTIALS_H_
-#define SLIMEVR_CREDENTIALS_H_
+#pragma once
 
-// The OTA password is public, server should know it for OTA updates,
-// and devices don't have any authentication anyway.
-// We have password here to prevent random attacks on IOT things
-// that might try to hack all esp-based devices and upload malicious
-// firmware. We don't have any hardware buttons for the user to confirm
-// OTA update, so this is the best way we have.
-// OTA is allowed only for the first 60 seconds after device startup.
-const char* otaPassword
-	= "SlimeVR-OTA";  // YOUR OTA PASSWORD HERE, LEAVE EMPTY TO DISABLE OTA UPDATES
-
-#endif  // SLIMEVR_CREDENTIALS_H_
+extern const char* otaPassword;
+extern const char* provisioningPassword;

src/main.cpp

@@ -43,7 +43,7 @@ SlimeVR::Configuration::Configuration configuration;
 SlimeVR::Network::Manager networkManager;
 SlimeVR::Network::Connection networkConnection;
 SlimeVR::WiFiNetwork wifiNetwork;
-SlimeVR::WifiProvisioning wifiProvisioning;
+SlimeVR::Network::WiFiProvisioning wifiProvisioning;
 
 #if DEBUG_MEASURE_SENSOR_TIME_TAKEN
 SlimeVR::Debugging::TimeTakenMeasurer sensorMeasurer{"Sensors"};

src/network/connection.cpp

@@ -23,6 +23,8 @@
 
 #include "connection.h"
 
+#include <cstdint>
+#include <cstring>
 #include <string_view>
 
 #include "GlobalVars.h"
@@ -407,6 +409,38 @@ void Connection::sendFlexData(uint8_t sensorId, float flexLevel) {
 	));
 }
 
+// PACKET_PROVISIONING_NEW_TRACER 29
+void Connection::sendProvisioningNewTracker(uint8_t mac[6]) {
+	MUST(m_Connected);
+	ProvisioningNewTrackerPacket packet{};
+	memcpy(packet.mac, mac, sizeof(packet.mac));
+	MUST(sendPacket(SendPacketType::ProvisioningNewTracker, packet));
+}
+
+// PACKET_PROVISIONING_STATUS 30
+void Connection::sendProvisioningStatus(
+	uint8_t mac[6],
+	ProvisioningPackets::ConnectionStatus status
+) {
+	MUST(m_Connected);
+	ProvisioningStatusPacket packet{
+		.status = status,
+	};
+	memcpy(packet.mac, mac, sizeof(packet.mac));
+	MUST(sendPacket(SendPacketType::ProvisioningStatus, packet));
+}
+
+// PACKET_PROVISIONING_FAILED 31
+void Connection::sendProvisioningFailed(
+	uint8_t mac[6],
+	ProvisioningPackets::ConnectionError error
+) {
+	MUST(m_Connected);
+	ProvisioningFailedPacket packet{.error = error};
+	memcpy(packet.mac, mac, sizeof(packet.mac));
+	MUST(sendPacket(SendPacketType::ProvisioningFailed, packet));
+}
+
 #if ENABLE_INSPECTION
 void Connection::sendInspectionRawIMUData(
 	uint8_t sensorId,
@@ -779,6 +813,23 @@ void Connection::update() {
 			configuration.save();
 			break;
 		}
+
+		case ReceivePacketType::StartWiFiProvisioning: {
+			StartWiFiProvisioningPacket wifiProvisioningPacket{};
+			memcpy(
+				&wifiProvisioningPacket,
+				m_Packet + 12,
+				sizeof(StartWiFiProvisioningPacket)
+			);
+
+			if (wifiProvisioningPacket.start) {
+				wifiProvisioning.startProvisioning();
+			} else {
+				wifiProvisioning.stopProvisioning();
+			}
+
+			break;
+		}
 	}
 }
 

src/network/connection.h

@@ -25,12 +25,15 @@
 
 #include <Arduino.h>
 #include <WiFiUdp.h>
+#include <sys/types.h>
 
+#include <cstdint>
 #include <optional>
 
 #include "../configuration/SensorConfig.h"
 #include "featureflags.h"
 #include "globals.h"
+#include "network/wifiprovisioning/provisioning-packets.h"
 #include "packets.h"
 #include "quat.h"
 #include "sensors/sensor.h"
@@ -98,6 +101,19 @@ class Connection {
 	// PACKET_FLEX_DATA 26
 	void sendFlexData(uint8_t sensorId, float flexLevel);
 
+	// PACKET_PROVISIONING_NEW_TRACER 29
+	void sendProvisioningNewTracker(uint8_t mac[6]);
+
+	// PACKET_PROVISIONING_STATUS 30
+	void sendProvisioningStatus(
+		uint8_t mac[6],
+		ProvisioningPackets::ConnectionStatus status
+	);
+
+	// PACKET_PROVISIONING_FAILED 31
+	void
+	sendProvisioningFailed(uint8_t mac[6], ProvisioningPackets::ConnectionError error);
+
 #if ENABLE_INSPECTION
 	void sendInspectionRawIMUData(
 		uint8_t sensorId,

src/network/manager.h

@@ -26,7 +26,7 @@
 #include "globals.h"
 #include "packets.h"
 #include "wifihandler.h"
-#include "wifiprovisioning.h"
+#include "wifiprovisioning/wifi-provisioning.h"
 
 namespace SlimeVR::Network {
 

src/network/packets.h

@@ -28,6 +28,7 @@
 
 #include "../consts.h"
 #include "../sensors/sensor.h"
+#include "network/wifiprovisioning/provisioning-packets.h"
 
 enum class SendPacketType : uint8_t {
 	HeartBeat = 0,
@@ -55,6 +56,9 @@ enum class SendPacketType : uint8_t {
 	AcknowledgeConfigChange = 24,
 	FlexData = 26,
 	// PositionData = 27,
+	ProvisioningNewTracker = 29,
+	ProvisioningStatus = 30,
+	ProvisioningFailed = 31,
 	Bundle = 100,
 	Inspection = 105,
 };
@@ -69,6 +73,7 @@ enum class ReceivePacketType : uint8_t {
 	SensorInfo = 15,
 	FeatureFlags = 22,
 	SetConfigFlag = 25,
+	StartWiFiProvisioning = 28,
 };
 
 enum class InspectionPacketType : uint8_t {
@@ -231,6 +236,24 @@ struct SetConfigFlagPacket {
 	bool newState{};
 };
 
+struct StartWiFiProvisioningPacket {
+	bool start;
+};
+
+struct ProvisioningNewTrackerPacket {
+	uint8_t mac[6];
+};
+
+struct ProvisioningStatusPacket {
+	uint8_t mac[6];
+	SlimeVR::Network::ProvisioningPackets::ConnectionStatus status;
+};
+
+struct ProvisioningFailedPacket {
+	uint8_t mac[6];
+	SlimeVR::Network::ProvisioningPackets::ConnectionError error;
+};
+
 #pragma pack(pop)
 
 #endif  // SLIMEVR_PACKETS_H_

src/network/wifihandler.cpp

@@ -20,10 +20,9 @@
 	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 	THE SOFTWARE.
 */
-#include "network/wifihandler.h"
-
 #include "GlobalVars.h"
 #include "globals.h"
+#include "network/wifihandler.h"
 #if !ESP8266
 #include "esp_wifi.h"
 #include "esp_wifi_types.h"
@@ -52,14 +51,19 @@ bool WiFiNetwork::isConnected() const {
 }
 
 void WiFiNetwork::setWiFiCredentials(const char* SSID, const char* pass) {
+	wifiProvisioning.stopSearchForProvider();
 	wifiProvisioning.stopProvisioning();
 	tryConnecting(false, SSID, pass);
 	retriedOnG = false;
-	// Reset state, will get back into provisioning if can't connect
-	hadWifi = false;
 	wifiState = WiFiReconnectionStatus::ServerCredAttempt;
 }
 
+void WiFiNetwork::setProvisionedWiFiCredentials(const char* SSID, const char* pass) {
+	tryConnecting(false, SSID, pass);
+	retriedOnG = false;
+	wifiState = WiFiReconnectionStatus::ProvisionedAttempt;
+}
+
 IPAddress WiFiNetwork::getAddress() { return WiFi.localIP(); }
 
 void WiFiNetwork::setUp() {
@@ -107,7 +111,6 @@ void WiFiNetwork::setUp() {
 
 void WiFiNetwork::onConnected() {
 	wifiState = WiFiReconnectionStatus::Success;
-	wifiProvisioning.stopProvisioning();
 	statusManager.setStatus(SlimeVR::Status::WIFI_CONNECTING, false);
 	hadWifi = true;
 	wifiHandlerLogger.info(
@@ -144,7 +147,7 @@ String WiFiNetwork::getPassword() {
 WiFiNetwork::WiFiReconnectionStatus WiFiNetwork::getWiFiState() { return wifiState; }
 
 void WiFiNetwork::upkeep() {
-	wifiProvisioning.upkeepProvisioning();
+	wifiProvisioning.tick();
 
 	if (WiFi.status() == WL_CONNECTED) {
 		if (!isConnected()) {
@@ -199,29 +202,25 @@ void WiFiNetwork::upkeep() {
 				wifiState = WiFiReconnectionStatus::Failed;
 			}
 			return;
+		case WiFiReconnectionStatus::ProvisionedAttempt:  // Couldn't connect with
+														  // credentials received from
+														  // provisioning
+			if (!tryProvisionedCredentials()) {
+				wifiState = WiFiReconnectionStatus::Failed;
+			}
 		case WiFiReconnectionStatus::Failed:  // Couldn't connect with second set of
 											  // credentials or server credentials
-// Return to the default PHY Mode N.
-#if ESP8266
-			if constexpr (USE_ATTENUATION) {
-				WiFi.setOutputPower(20.0 - ATTENUATION_N);
-			}
-			WiFi.setPhyMode(WIFI_PHY_MODE_11N);
-#endif
-			// Start smart config
-			if (!hadWifi && !WiFi.smartConfigDone()
-				&& millis() - wifiConnectionTimeout
-					   >= static_cast<uint32_t>(WiFiTimeoutSeconds * 1000)) {
-				if (WiFi.status() != WL_IDLE_STATUS) {
-					wifiHandlerLogger.error(
-						"Can't connect from any credentials, error: %d, reason: %s.",
-						static_cast<int>(statusToFailure(WiFi.status())),
-						statusToReasonString(WiFi.status())
-					);
-					wifiConnectionTimeout = millis();
-				}
-				wifiProvisioning.startProvisioning();
+			if (startedProvisioning) {
+				return;
 			}
+			wifiHandlerLogger.error(
+				"Can't connect from any credentials, error: %d, reason: %s.",
+				static_cast<int>(statusToFailure(WiFi.status())),
+				statusToReasonString(WiFi.status())
+			);
+			wifiHandlerLogger.info("Starting wifi provisioning");
+			wifiProvisioning.startSearchForProvider();
+			startedProvisioning = true;
 			return;
 	}
 }
@@ -355,6 +354,20 @@ bool WiFiNetwork::tryServerCredentials() {
 	return tryConnecting(true);
 }
 
+bool WiFiNetwork::tryProvisionedCredentials() {
+	if (WiFi.status() != WL_DISCONNECTED) {
+		return false;
+	}
+
+	if (retriedOnG) {
+		return false;
+	}
+
+	retriedOnG = true;
+
+	return tryConnecting(true);
+}
+
 bool WiFiNetwork::tryConnecting(bool phyModeG, const char* SSID, const char* pass) {
 #if ESP8266
 	if (phyModeG) {