1| Supported Targets | ESP32 | 2| ----------------- | ----- | 3 4## ESP-IDF BT-SPP-ACCEPTOR Example 5 6This example is to show how to use the APIs of **Serial Port Protocol** (**SPP**) to create an SPP acceptor which performs as a server. We aggregate **Secure Simple Pair** (**SSP**) into this example to show how to use SPP when creating your own APPs. We also provide the example `bt_spp_initiator` or the example `bt_spp_vfs_initiator` to create an SPP initiator which performs as a client. In fact, you can create SPP acceptors and SPP initiators on a single device at the same time. 7 8## How to use example 9 10### Hardware Required 11 12This example is designed to run on commonly available ESP32 development board, e.g. ESP32-DevKitC. To operate the example, it should be connected to an SPP Initiator running on a smartphone, a computer or on another ESP32 development board. 13 14### Configure the project 15 161. Open the project configuration menu: 17 18``` 19idf.py menuconfig 20``` 21 222. Enable the SPP functionality by choosing the path as following: 23 24`Component config --> Bluetooth --> Bluedroid Options --> SPP` 25 263. If you want to limit the number of connected devices, please make sure set the `BT/BLE MAX ACL CONNECTIONS` and `BR/EDR ACL Max Connections` with same value you want. 27 28`Component config --> Bluetooth --> Bluedroid Options --> BT/BLE MAX ACL CONNECTIONS(1~7)` 29and 30`Component config --> Bluetooth --> Bluetooth --> Bluetooth controller --> BR/EDR ACL Max Connections` 31 32 334. SSP is enabled as default in this example. If you prefer the legacy pairing, you can disable it in the following path. 34 35`Component config --> Bluetooth--> Bluedroid Options --> Secure Simple Pair`. 36 37### Build and Flash 38 39Build the project and flash it to the board, then run monitor tool to view serial output: 40 41``` 42idf.py -p PORT flash monitor 43``` 44 45(Replace PORT with the name of the serial port to use.) 46 47(To exit the serial monitor, type ``Ctrl-]``.) 48 49See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects. 50 51## Example Description 52 53After the program starts, the example will start an SPP acceptor. The example will calculate the data rate or just print the received data after the SPP connection is established. You can connect to the server and send data with another ESP32 development board, Andriod phone or computer which performs as the SPP initiator. 54 55## Trouble shooting 56 57- To see the information of data, users shall set `SPP_SHOW_MODE` as `SPP_SHOW_DATA` or `SPP_SHOW_SPEED` in code(should be same with `bt_spp_initiator`, if the peer device runs it). When setting `SPP_SHOW_MODE` as `SPP_SHOW_DATA`, if the data rate is too high or the data length is too long, it is strongly recommended to process them in other lower priority application task rather than in this callback directly. Since the printing takes too much time, and it may stuck the Bluetooth stack. 58 59## FAQ 60Q: How to change the process of SSP? 61A: Users can set the IO Capability and Security Mask for their device (fixed Security Mode, Security Mode 4). In short, the Security Mask sets the security level for authentication stage and the IO Capability determines the way of user interaction during pairing. The default Security Mask of this example is `ESP_SPP_SEC_AUTHENTICATE` which support MITM (Man In The Middle) protection. For more information about Security Simple Pair on ESP32, please refer to [ESP32_SSP](./ESP32_SSP.md). 62 63 64Q: How many SPP servers does ESP32 support? 65A: For now, the maximum number of SPP servers is 6, which is limited by the maximum number of SDP records. When the SPP server is successfully started, the unique SCN (Server Channel Number) will be mapped to the SPP server. 66 67Q: Is SPP absolutely reliable? 68A: For now, most Bluetooth stacks implement the SPP based on the L2CAP Basic Mode, and the reliability only depends on the controller. If errors(e.g. CRC) are missed by controller, the L2CAP packet will not be retransmitted, so it is recommended that you should implement the retransmission at the application layer. For more information about L2CAP operation modes, please refer to Bluetooth Core Specification, Version 4.2 or later, Volume 3, Part A: Logical Link Control and Adaptation Protocol Specification.
