![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/ESP32-Wi-Fi-Provisioning-via-BLE-f.jpg?resize=1200%2C675&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\nTable of Contents:<\/strong><\/p>\n\n\n\n Wi-Fi provisioning is the process of connecting a new Wi-Fi device (station) to a Wi-Fi network (access point). In this case, we want to connect an ESP32 to a Wi-Fi network. The provisioning process involves loading the ESP32 with the name of the network (SSID) and password that we want to connect to.<\/p>\n\n\n\n The ESP32 supports Wi-Fi provisioning over SoftAP (access point) or via Bluetooth Low Energy. In this tutorial, we’ll cover Wi-Fi provisioning via Bluetooth.<\/p>\n\n\n\n To provision the ESP32 via BLE, we need to use another BLE-enabled device, usually a smartphone to connect to the ESP32 via BLE and send the Wi-Fi credentials. We can use an Android or iOS app or a Web Bluetooth app.<\/p>\n\n\n\n Espressif developed Android and iOS apps that support Wi-Fi provisioning for its devices like the ESP32 boards. Alternatively, you can create your own BLE app.<\/p>\n\n\n\n After the provisioning process, the ESP32 can connect to the desired Wi-Fi network with the provided network credentials.<\/p>\n\n\n Here’s a quick summary of how it works:<\/p>\n\n\n\n To connect and send the credentials to the ESP32 via BLE, we’ll use the Wi-Fi Provisioning App developed by Espressif (alternatively, you can create your own BLE app).<\/p>\n\n\n\n Before proceeding, make sure you install the Wi-Fi provisioning app on your smartphone:<\/p>\n\n\n\n The following code will prepare the ESP32 for Wi-Fi provisioning via BLE. This is the minimal code required to do that. We adapted this code slightly from the official example<\/a> that also supports WiFi provisioning via an access point.<\/p>\n\n\n\n Copy the following code to the Arduino IDE.<\/p>\n\n\n View raw code<\/a><\/p>\n\n\n\n Let’s take a quick look at how the code works (or skip to the next section<\/a>).<\/p>\n\n\n\n First, you include the required libraries, the WiFiProv.h<\/span> for Wi-Fi provisioning and the WiFi.h<\/span> for Wi-Fi related functions.<\/p>\n\n\n\n Then, we declare some variables to hold details for the provisioning service. <\/p>\n\n\n\n The pop<\/span> variable is the proof of possession, it’s like a password so that you can connect the smartphone to this specific device. For testing, we’ll use the default value.<\/p>\n\n\n\n The service_name<\/span> is the name of our BLE device. If you’re using the Espressif app, like we’ll do in this tutorial, the service name must start with the prefix PROV_<\/span>.<\/p>\n\n\n\n The service_key<\/span> is used when using Wi-Fi Provisioning via Access Point (not included in this guide). Set it to NULL<\/span> because it’s not needed.<\/p>\n\n\n\n The reset_provisioned<\/span> is a boolean variable indicating whether the library should delete previously provisioned data.<\/p>\n\n\n\n In the setup()<\/span>, set a function that will run when a Wi-Fi event occurs. In this case, it will call the SysProvEvent()<\/span> function when any Wi-Fi event occurs. Then, on the SysProvEvent()<\/span> function we’ll decide what happens according to the Wi-Fi event detected.<\/p>\n\n\n\n You may also like: ESP32 Useful Wi-Fi Library Functions (Arduino IDE)<\/a><\/p>\n\n\n\n Starting the Wi-Fi provisioning process is as easy as using WiFiProv.beginProvision()<\/span> with the proper arguments.<\/p>\n\n\n\n We also print the BLE provision details in a QR code that can be detected by the Wi-Fi Provisioning app.<\/p>\n\n\n\n The different Wi-Fi events will be passed to the SysProvEenvent()<\/span>.<\/p>\n\n\n\n When the ESP32 connects to a network and is assigned an IP address, it detects the ARDUINO_EVENT_WIFI_STA_GOT_IP<\/span> event. When this happens, we print the ESP32 IP address (you can run other tasks as needed, or add a flag variable to indicate that the ESP32 is connected to WiFi and that we can run wifi-related tasks in the loop()<\/span>).<\/p>\n\n\n\n The ARDUINO_EVENT_PROV_START<\/span> event happens when the provisioning process starts. This happens when we call the WiFiProv.beginProvision()<\/span> function in the setup()<\/span>.<\/p>\n\n\n\n This event is triggered when the board receives the credentials via Wi-Fi provisioning. In this case, we print the received SSID and password. Alternatively, you can save the credentials permanently to a file if that’s useful for your project.<\/p>\n\n\n\n This event will run if the credentials provided via Wi-Fi provisioning will fail to connect to the network.<\/p>\n\n\n\n The ARDUINO_EVEN_PROV_CRED_SUCCESS<\/span> event will run if the ESP32 successfully connects to the network using the credentials provided via Wi-Fi provisioning.<\/p>\n\n\n\n Finally, when the provisioning process ends, the ARDUINO_EVENT_PROV_END<\/span> is triggered.<\/p>\n\n\n\n This code takes up a lot of space and may not be able to flash with the default settings on some chips.<\/p>\n\n\n\n If you see an Error like this: “Sketch too big” during the uploading process, in Arduino IDE go to Tools <\/strong>> Partition scheme<\/strong> > choose anything that has more than 1.4MB APP, for example: “Huge APP (3MB No OTA\/1MB SPIFFS<\/strong>“.<\/p>\n\n\n If you don’t have the partition scheme option on your Tools <\/strong>menu, you need to select a different ESP32 board model\u2014for example, the ESP32 Wrover Module.<\/p>\n\n\n\n After uploading the code to the ESP32, open the Serial Monitor at a baud rate of 115200. Press the ESP32 RST button, so it starts running the code.<\/p>\n\n\n\n Note:<\/strong> you may get a PSRAM error. You can ignore it.<\/p>\n\n\n\n You’ll get something similar on your Serial Monitor.<\/p>\n\n\n\n Now, open the Espressif WiFi Provisioning App on your smartphone and click on Provision Device<\/strong>. It has the option to scan the QR code, but I couldn’t make it work. Click on “I don’t have a QR code<\/strong>“.<\/p>\n\n\n\n It will list all Bluetooth Devices within its range with the “PROV_<\/strong>” prefix. Our code sets the ESP32 as a BLE Device called “PROV_123<\/strong>“\u2014click on that device.<\/p>\n\n\n\n Then, you need to enter the proof of possession\u2014it must be the same used in the code. We’re using the default values, so it will be abcd1234<\/em>. After, it will list all Wi-Fi networks within its range (if it doesn’t list your network, you may need to enter it manually by clicking on “Join Other Network”).<\/p>\n\n\n\n Finally, enter the password for your Wi-Fi network and click Connect. The Wi-Fi credentials should be sent to the ESP32 after a few seconds.<\/p>\n\n\n\n On the Serial monitor, you can see that the ESP32 received the Wi-Fi credentials and connected successfully to the network (it printed its IP address on the network it connected to).<\/p>\n\n\n That’s it. Wi-Fi provisioning was successfully implemented on the ESP32.<\/p>\n\n\n\n To add this feature to your projects that use Wi-Fi, I suggest creating a global variable that indicates whether the ESP32 is already connected to the internet. That variable will change to true<\/span> when the ARDUINO_EVENT_WIFI_STA_GOT_IP<\/span> is triggered.<\/p>\n\n\n\n Then, in the loop()<\/span>, check the state of that variable. If it’s true, run your Wi-Fi-related tasks. If not, simply wait for the board to establish a connection.<\/p>\n\n\n\n We’ll create a web server example with this feature soon, so stay tuned.<\/p>\n\n\n\n In this tutorial, we’ve shown you how to add Wi-Fi Provisioning via BLE to your ESP32 devices. Using this feature is simple and easy thanks to the WiFiProv<\/span> library and the Espressif Provisioning app.<\/p>\n\n\n\n This is a great option for IoT projects that require Wi-Fi credentials to connect to the internet, without the need to hard-code them while developing, which makes the project much more versatile.<\/p>\n\n\n\n We’ll create more tutorials about this subject soon, so stay tuned. You may also like reading:<\/p>\n\n\n\n We hope you’ve found this tutorial useful. Learn more about the ESP32 with our resources.<\/p>\n\n\n\n <\/p>\n","protected":false},"excerpt":{"rendered":" In this tutorial, you’ll learn how to set up Wi-Fi provisioning via BLE on the ESP32. The Wi-Fi provisioning service allows you to configure Wi-Fi credentials over Bluetooth Low Energy. … <\/p>\n\n
Wi-Fi Provisioning<\/h2>\n\n\n\n
Provisioning over BLE<\/h3>\n\n\n\n
![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/ESP32-Wi-Fi-Provisioning-via-BLE-How-it-Works.png?resize=1024%2C530&quality=100&strip=all&ssl=1\")
\n
Wi-Fi Provisioning App<\/h2>\n\n\n\n
Installing the Wi-Fi Provisioning App<\/h3>\n\n\n\n
\n
![\"Wi-Fi](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/WiFi_provisioning_app_espressif.png?resize=679%2C236&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\nESP32 WiFi Provisioning via BLE – Code<\/h2>\n\n\n\n
\/*********\n Rui Santos & Sara Santos - Random Nerd Tutorials\n Complete project details at https:\/\/RandomNerdTutorials.com\/esp32-wi-fi-provisioning-ble-arduino\/\n\n Please read README.md file in this folder, or on the web: https:\/\/github.com\/espressif\/arduino-esp32\/tree\/master\/libraries\/WiFiProv\/examples\/WiFiProv\n Note: This sketch takes up a lot of space for the app and may not be able to flash with default setting on some chips.\n If you see Error like this: "Sketch too big"\n In Arduino IDE go to: Tools > Partition scheme > chose anything that has more than 1.4MB APP\n - for example "No OTA (2MB APP\/2MB SPIFFS)"\n*********\/\n\n#include "WiFiProv.h"\n#include "WiFi.h"\n\nconst char * pop = "abcd1234"; \/\/ Proof of possession - otherwise called a PIN - string provided by the device, entered by the user in the phone app\nconst char * service_name = "PROV_123"; \/\/ Name of your device (the Espressif apps expects by default device name starting with "Prov_")\nconst char * service_key = NULL; \/\/ Password used for SofAP method (NULL = no password needed)\nbool reset_provisioned = true; \/\/ When true the library will automatically delete previously provisioned data.\n\n\/\/ WARNING: SysProvEvent is called from a separate FreeRTOS task (thread)!\nvoid SysProvEvent(arduino_event_t *sys_event) {\n switch (sys_event->event_id) {\n case ARDUINO_EVENT_WIFI_STA_GOT_IP:\n Serial.print("\\nConnected IP address : ");\n Serial.println(IPAddress(sys_event->event_info.got_ip.ip_info.ip.addr));\n break;\n case ARDUINO_EVENT_WIFI_STA_DISCONNECTED: Serial.println("\\nDisconnected. Connecting to the AP again... "); break;\n case ARDUINO_EVENT_PROV_START: Serial.println("\\nProvisioning started\\nGive Credentials of your access point using smartphone app"); break;\n case ARDUINO_EVENT_PROV_CRED_RECV:\n {\n Serial.println("\\nReceived Wi-Fi credentials");\n Serial.print("\\tSSID : ");\n Serial.println((const char *)sys_event->event_info.prov_cred_recv.ssid);\n Serial.print("\\tPassword : ");\n Serial.println((char const *)sys_event->event_info.prov_cred_recv.password);\n break;\n }\n case ARDUINO_EVENT_PROV_CRED_FAIL:\n {\n Serial.println("\\nProvisioning failed!\\nPlease reset to factory and retry provisioning\\n");\n if (sys_event->event_info.prov_fail_reason == NETWORK_PROV_WIFI_STA_AUTH_ERROR) {\n Serial.println("\\nWi-Fi AP password incorrect");\n } else {\n Serial.println("\\nWi-Fi AP not found....Add API \\" nvs_flash_erase() \\" before beginProvision()");\n }\n break;\n }\n case ARDUINO_EVENT_PROV_CRED_SUCCESS: Serial.println("\\nProvisioning Successful"); break;\n case ARDUINO_EVENT_PROV_END: Serial.println("\\nProvisioning Ends"); break;\n default: break;\n }\n}\n\nvoid setup() {\n Serial.begin(115200);\n WiFi.onEvent(SysProvEvent);\n\n Serial.println("Begin Provisioning using BLE");\n \/\/ Sample uuid that user can pass during provisioning using BLE\n uint8_t uuid[16] = {0xb4, 0xdf, 0x5a, 0x1c, 0x3f, 0x6b, 0xf4, 0xbf,\n 0xea, 0x4a, 0x82, 0x03, 0x04, 0x90, 0x1a, 0x02 };\n WiFiProv.beginProvision(\n NETWORK_PROV_SCHEME_BLE, NETWORK_PROV_SCHEME_HANDLER_FREE_BLE, NETWORK_PROV_SECURITY_1, pop, service_name, service_key, uuid, reset_provisioned\n );\n log_d("ble qr");\n WiFiProv.printQR(service_name, pop, "ble");\n}\n\nvoid loop() {\n \n}\n<\/code><\/pre>\n\tHow the Code Works<\/h3>\n\n\n\n
Including Libraries<\/h4>\n\n\n\n
#include \"WiFiProv.h\"\n#include \"WiFi.h\"<\/code><\/pre>\n\n\n\nProvisioning Details<\/h4>\n\n\n\n
const char * pop = \"abcd1234\"; \/\/ Proof of possession - otherwise called a PIN - string provided by the device, entered by the user in the phone app<\/code><\/pre>\n\n\n\nconst char * service_name = \"PROV_123\"; \/\/ Name of your device (the Espressif apps expects by default device name starting with \"Prov_\")<\/code><\/pre>\n\n\n\nconst char * service_key = NULL; \/\/ Password used for SofAP method (NULL = no password needed)<\/code><\/pre>\n\n\n\nbool reset_provisioned = true; \/\/ When true the library will automatically delete previously provisioned data.<\/code><\/pre>\n\n\n\nWi-Fi Event Callback Function<\/h4>\n\n\n\n
WiFi.onEvent(SysProvEvent);<\/code><\/pre>\n\n\n\nStarting WiFi Provisioning<\/h4>\n\n\n\n
WiFiProv.beginProvision(WIFI_PROV_SCHEME_BLE, WIFI_PROV_SCHEME_HANDLER_FREE_BTDM, WIFI_PROV_SECURITY_1, pop, service_name, service_key, uuid, reset_provisioned);<\/code><\/pre>\n\n\n\nPrint QR Code<\/h4>\n\n\n\n
log_d(\"ble qr\");\nWiFiProv.printQR(service_name, pop, \"ble\");<\/code><\/pre>\n\n\n\nDetecting WiFi Events<\/h4>\n\n\n\n
ARDUINO_EVENT_WIFI_STA_GOT_IP<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_WIFI_STA_GOT_IP:\n Serial.print(\"\\nConnected IP address : \");\n Serial.println(IPAddress(sys_event->event_info.got_ip.ip_info.ip.addr));\n break;<\/code><\/pre>\n\n\n\nARDUINO_EVENT_PROV_START<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_PROV_START:\n Serial.println(\"\\nProvisioning started\\nGive Credentials of your access point using smartphone app\");\n break;<\/code><\/pre>\n\n\n\nARDUINO_EVENT_PROV_CRED_RECV<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_PROV_CRED_RECV: {\n Serial.println(\"\\nReceived Wi-Fi credentials\");\n Serial.print(\"\\tSSID : \");\n Serial.println((const char *) sys_event->event_info.prov_cred_recv.ssid);\n Serial.print(\"\\tPassword : \");\n Serial.println((char const *) sys_event->event_info.prov_cred_recv.password);\n break;\n}<\/code><\/pre>\n\n\n\nARDUINO_EVENT_PROV_CRED_FAIL<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_PROV_CRED_FAIL: {\n Serial.println(\"\\nProvisioning failed!\\nPlease reset to factory and retry provisioning\\n\");\n if(sys_event->event_info.prov_fail_reason == WIFI_PROV_STA_AUTH_ERROR)\n Serial.println(\"\\nWi-Fi AP password incorrect\");\n else\n Serial.println(\"\\nWi-Fi AP not found....Add API \\\" nvs_flash_erase() \\\" before beginProvision()\");\n break;\n}<\/code><\/pre>\n\n\n\nARDUINO_EVENT_PROV_CRED_SUCCESS<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_PROV_CRED_SUCCESS:\n Serial.println(\"\\nProvisioning Successful\");\n break;<\/code><\/pre>\n\n\n\nARDUINO_EVENT_PROV_END<\/strong><\/h5>\n\n\n\n
case ARDUINO_EVENT_PROV_END:\n Serial.println(\"\\nProvisioning Ends\");\n break;<\/code><\/pre>\n\n\n\nInstructions for Uploading the Code<\/h2>\n\n\n\n
![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/ESP32-selecting-different-partition-scheme.png?resize=468%2C511&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\nTesting the Code<\/h2>\n\n\n\n
Begin Provisioning using BLE\n\nProvisioning started\nGive Credentials of your access point using smartphone app<\/code><\/pre>\n\n\n![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/ESP32-start-wi-fi-provisioning.png?resize=666%2C539&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n![\"Wifi](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/1-Wifi-provisioning-scan-devices-e.png?resize=358%2C722&quality=100&strip=all&ssl=1\")
<\/figure>\n<\/div>\n\n\n\n![\"Wi-Fi](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/2-Wifi-provisioning-find-devices-e.png?resize=358%2C722&quality=100&strip=all&ssl=1\")
<\/figure>\n<\/div>\n<\/div>\n\n\n\n![\"Espressif](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/3-Wifi-provisioning-proof-of-possession-e.png?resize=357%2C722&quality=100&strip=all&ssl=1\")
<\/figure><\/div><\/div>\n\n\n\n![\"Wi-Fi](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/4-Wifi-provisioning-find-networks-e.png?resize=356%2C722&quality=100&strip=all&ssl=1\")
<\/figure>\n<\/div>\n<\/div>\n\n\n\n![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/5-Wifi-provisioning-insert-SSID-password-e.png?resize=358%2C722&quality=100&strip=all&ssl=1\")
<\/figure><\/div><\/div>\n\n\n\n![\"WiFi](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/7-wifi-provisioning-success-e.png?resize=358%2C720&quality=100&strip=all&ssl=1\")
<\/figure><\/div><\/div>\n<\/div>\n\n\n\n![\"ESP32](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2024\/03\/ESP32-Wi-fi-provisioning-via-BLE-Serial-Monitor.png?resize=666%2C321&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\nHow to Apply the Wi-Fi Provisioning to Your Wi-Fi Projects<\/h2>\n\n\n\n
Wrapping Up<\/h2>\n\n\n\n
\n
\n