README.md
1| Supported Targets | ESP32 | ESP32-C3 |
2| ----------------- | ----- | -------- |
3
4# ESP-IDF Blufi Example
5
6This demo shows how to use the *Blufi* to configurate the Wi-Fi connection to AP.
7
8The BluFi for ESP32 is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to the ESP32.
9
10## How to Use Example
11
12Before project configuration and build, be sure to set the correct chip target using:
13
14```bash
15idf.py set-target <chip_name>
16```
17
18To test this demo, you need to prepare a mobile phone with blufi application installed. You can download the blufi application from [Android version](https://github.com/EspressifApp/EspBlufi) and [iOS version](https://itunes.apple.com/cn/app/espblufi/id1450614082?mt=8).
19
20Blufi is completely open source, here is the download link:
21
22* [Blufi source code](https://github.com/espressif/esp-idf/tree/master/examples/bluetooth/blufi)
23* [BluFi protocol](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/blufi.html?highlight=blufi#the-frame-formats-defined-in-blufi)
24* [iOS source code](https://github.com/EspressifApp/EspBlufiForiOS)
25* [Android source code](https://github.com/EspressifApp/EspBlufi)
26* [Bluetooth Network User Guide CN](https://www.espressif.com/sites/default/files/documentation/esp32_bluetooth_networking_user_guide_cn.pdf)
27
28### Hardware Required
29
30* A development board with ESP32/ESP32-C3 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)
31* A USB cable for Power supply and programming
32
33See [Development Boards](https://www.espressif.com/en/products/devkits) for more information about it.
34
35### Build and Flash
36
37Run `idf.py -p PORT flash monitor` to build, flash and monitor the project.
38
39(To exit the serial monitor, type ``Ctrl-]``.)
40
41See the [Getting Started Guide](https://idf.espressif.com/) for full steps to configure and use ESP-IDF to build projects.
42
43## Example Output
44
45```
46I (0) cpu_start: Starting scheduler on APP CPU.
47I (708) wifi:wifi driver task: 3ffbb118, prio:23, stack:6656, core=0
48I (708) system_api: Base MAC address is not set
49I (708) system_api: read default base MAC address from EFUSE
50I (718) wifi:wifi firmware version: 44799ff
51I (718) wifi:wifi certification version: v7.0
52I (718) wifi:config NVS flash: enabled
53I (718) wifi:config nano formating: disabled
54I (728) wifi:Init data frame dynamic rx buffer num: 32
55I (728) wifi:Init management frame dynamic rx buffer num: 32
56I (738) wifi:Init management short buffer num: 32
57I (738) wifi:Init dynamic tx buffer num: 32
58I (748) wifi:Init static rx buffer size: 1600
59I (748) wifi:Init static rx buffer num: 10
60I (748) wifi:Init dynamic rx buffer num: 32
61I (758) wifi_init: rx ba win: 6
62I (758) wifi_init: tcpip mbox: 32
63I (768) wifi_init: udp mbox: 6
64I (768) wifi_init: tcp mbox: 6
65I (768) wifi_init: tcp tx win: 5744
66I (778) wifi_init: tcp rx win: 5744
67I (778) wifi_init: tcp mss: 1440
68I (788) wifi_init: WiFi IRAM OP enabled
69I (788) wifi_init: WiFi RX IRAM OP enabled
70I (798) phy_init: phy_version 4670,719f9f6,Feb 18 2021,17:07:07
71I (908) wifi:mode : sta (fc:f5:c4:3c:62:90)
72I (908) wifi:enable tsf
73I (908) BTDM_INIT: BT controller compile version [1342a48]
74I (1198) BLUFI_EXAMPLE: BD ADDR: fc:f5:c4:3c:62:92
75
76I (1198) BLUFI_EXAMPLE: BLUFI VERSION 0102
77
78I (1198) BLUFI_EXAMPLE: BLUFI init finish
79
80```
81
82## Troubleshooting
83
84<<<<<<< HEAD:examples/bluetooth/blufi/README.md
85* [Bluetooth Network User Guide CN](https://www.espressif.com/sites/default/files/documentation/esp32_bluetooth_networking_user_guide_cn.pdf)
86=======
87For any technical queries, please open an [issue](https://github.com/espressif/esp-idf/issues) on GitHub. We will get back to you soon.
88>>>>>>> c552024ca7 (Changes on README files on ANCS, Eddystone, HID and NimBLE):examples/bluetooth/bluedroid/ble/blufi/README.md
89
